GET
/
unified
/
ats
/
background_checks
/
orders
/
{id}
curl --request GET \
  --url https://api.stackone.com/unified/ats/background_checks/orders/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'
{
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "application": {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "application_status": {
        "value": "hired",
        "source_value": "Hired"
      },
      "passthrough": {
        "other_known_names": "John Doe"
      }
    },
    "job": {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "title": "Software Engineer",
      "hiring_team": [
        {
          "user_id": "123456",
          "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
          "first_name": "John",
          "last_name": "Doe",
          "email": "john.doe@gmail.com",
          "role": "Software Engineer"
        }
      ],
      "passthrough": {
        "other_known_names": "John Doe"
      }
    },
    "candidate": {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "first_name": "Romain",
      "last_name": "Sestier",
      "emails": [
        {
          "type": "personal",
          "value": "sestier.romain123@gmail.com"
        }
      ],
      "passthrough": {
        "other_known_names": "John Doe"
      },
      "profile_url": "https://exmaple.com/candidate?id=xyz"
    },
    "requester": {
      "user_id": "123456",
      "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
      "first_name": "John",
      "last_name": "Doe",
      "email": "john.doe@gmail.com",
      "role": "Software Engineer"
    },
    "results_update_url": "https://exmaple.com/integrations/results/update",
    "package": {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "name": "Test 1",
      "description": "Skills test to gauge a candidate's proficiency in job-specific skills",
      "tests": [
        {
          "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "name": "Test 1",
          "description": "Skills test to gauge a candidate's proficiency in job-specific skills"
        }
      ]
    }
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": "<string>",
      "response": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

​
x-account-id
string
required

The account identifier

Path Parameters

​
id
string
required

Query Parameters

​
raw
boolean | null
default:false

Indicates that the raw request result is returned

​
proxy
object | null

Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

​
fields
string | null

The comma separated list of fields that will be returned in the response (if empty, all fields are returned)

Example:

"id,remote_id,package,application,job,candidate,requester,results_update_url"

Response

200
application/json
The background check order with the given identifier was retrieved.
​
data
object
required
​
raw
object[] | null

Was this page helpful?

Suggest edits
Update Background Check PackageList Background Check Request