Authentication

The Gophr V2 Commercial API uses API Key based authentication. In order to use the API, all requests must be authenticated.

To obtain an API key, fill out this form and one of our team will be in contact.

Once you have your API key, authenticated requests can be made by adding the API-KEY header to your request.

As an example, to make an authenticated request to the GET https://api-sandbox.gophr.com/v2-commercial-api/jobs/20220607-082838-8c020adae3835f84 endpoint with an api key equal to sand-2a7df6bd-8ed3-48ad-b801-05093a866e66 you could do the following:

curl --request GET \
  --url https://api-sandbox.gophr.com/v2-commercial-api/jobs/20220607-082838-8c020adae3835f84 \
  --header 'API-KEY: sand-2a7df6bd-8ed3-48ad-b801-05093a866e66' \
  --header 'Content-Type: application/json'