GET
/
unified
/
ats
/
background_checks
/
orders
curl --request GET \
  --url https://api.stackone.com/unified/ats/background_checks/orders \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'
{
  "next_page": "<string>",
  "next": "<string>",
  "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

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"

​
filter
object | null

Filter parameters that allow greater customisation of the list response

​
page
string | null
deprecated

The page number of the results to fetch

​
page_size
string | null
default:25

The number of results per page

​
next
string | null

The unified cursor

​
updated_after
string | null
deprecated

Use a string with a date to only select results updated after that given date

Example:

"2020-01-01T00:00:00.000Z"

Response

200
application/json
The list of background check requests was retrieved.
​
data
object[]
required
​
next_page
string | null
deprecated
​
next
string | null
​
raw
object[] | null

Was this page helpful?

Suggest edits
Get Background Check RequestOrder Background Check Request