Quickstart

Authentication

To authenticate using the BrightMove API include the API keys in the header of the request or prior to the request in plain-text. All requests will require authentication and will return 401 Unauthorized otherwise.

Header authentication

curl --request GET \
  --url https://app.brightmove.com/ATS/app/req/{guid} \
  --header 'X-Brightmove-Company-ApiKey: ABC12A12-AB12-1ABC-A123-12AB1234567' \
  --header 'X-Brightmove-User-ApiKey: ABC12A12-AB12-1ABC-A123-12AB1234567'

By passing your company’s API key and your user’s API key in the headers, authentication is done as the request is made and the requisite session is created at the time of the API call.

Parameters

Many API methods take optional parameters. For GET requests, all parameters should be specified as a segment of the endpoint URL:

curl --request GET \
  --url https://app.brightmove.com/ATS/app/req/{guid}

In this case, the guid for the Requirement to be retrieved is passed as a segment of the URL.

For POST and DELETE requests, parameters not included in the URL should be encoded as JSON with an Accept and Content-Type of ‘application/json’:

curl --request POST \
  --url https://app.brightmove.com/ATS/app/req/find \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{"queryString":"is_submittable: true"}'

Pagination

An API method that performs query operations will typically be paginated to 50 items by default. You can specify further pages with the pageNumber parameter and adjust the page size with the pageSize parameter. These should be specified in the JSON encoded parameter:

curl --request POST \
  --url https://app.brightmove.com/ATS/app/req/find \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{"queryString":"is_submittable: true", "pageNumber":1, "pageSize":"PAGE_SIZE_100"}'

General Considerations

  • All API access is over HTTPS, and accessed from https://app.brightmove.com.
  • All data is sent and received as JSON (unless otherwise noted).
  • All timestamps return in Unix time format with millisecond precision: 1597953763000