Sign in

v1

latestOpenAPI 3.1.02026-07-1276185442.2 KB
Assessments
Orders

Order Assessments Request

post/unified/ats/assessments/orders

Headers

x-account-idstring required

The account identifier

Preferstring
Example:heartbeat

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Request body

idstring nullable

Unique identifier

results_update_urlstring nullable

Results update url

passthroughobject nullable

Value to pass through to the provider

Example request

{
  "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
  "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"
  },
  "application": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "application_status": {
      "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",
  "passthrough": {
    "other_known_names": "John Doe"
  }
}

Response

The order request of the assessment for candidate.

idstring nullable

Unique identifier

remote_idstring nullable

Provider's unique identifier

test_urlstring nullable

Test url

Example response

{
  "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
  "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
  "test_url": "https://exmaple.com/integrations/candidate/test"
}