Skip to main content
POST
/
unified
/
ats
/
assessments
/
orders
Order Assessments Request
curl --request POST \
  --url https://api.stackone.com/unified/ats/assessments/orders \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'x-account-id: <x-account-id>' \
  --data @- <<EOF
{
  "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",
      "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",
  "passthrough": {
    "other_known_names": "John Doe"
  }
}
EOF
{
  "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
  "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
  "test_url": "https://exmaple.com/integrations/candidate/test"
}

Documentation Index

Fetch the complete documentation index at: https://docs.stackone.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
Prefer
string

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

Example:

"heartbeat"

Body

application/json
​
id
string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

​
package
object
​
application
object
​
job
object
​
candidate
object
​
requester
object
​
results_update_url
string | null

Results update url

Example:

"https://exmaple.com/integrations/results/update"

​
passthrough
object

Value to pass through to the provider

Example:
{ "other_known_names": "John Doe" }

Response

The order request of the assessment for candidate.

​
id
string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

​
remote_id
string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

​
test_url
string | null

Test url

Example:

"https://exmaple.com/integrations/candidate/test"