Skip to main content
You must specify which version of the API you want to use at an endpoint level, helping to avoid breaking changes.

​
Specifying the API Version

To specify the API version, include the X-BuildPass-Api-Version header in your requests. Currently, the only available version is v1. If the X-BuildPass-Api-Version header is not included in your request, the API will return a bad request error.
OAuth endpoints (/oauth/authorize, /oauth/token, /oauth/revoke) default to v1 when the version header is omitted. This enables browser redirects for authorization flows where custom headers cannot be set.

​
Example request

When making a request, include the X-BuildPass-Api-Version header set to v1. 
GET /builders HTTP/1.1
Authorization: Bearer YOUR_ACCESS_TOKEN
X-BuildPass-Api-Version: v1

​
Checking available versions

To find out the available API versions and their respective features, refer to the API reference or contact BuildPass support for the latest information.