Job Interview Stages

The JobInterviewStage object is used to represent a particular recruiting stage for an Application. A given Application typically has the JobInterviewStage object represented in the current_stage field.

The JobInterviewStage object

Properties

idString
Required
remote_idString
Optional
The third-party API ID of the matching object.
nameString
Optional
Standard stage names are offered by ATS systems but can be modified by users.
jobString
Optional
This field is populated only if the stage is specific to a particular job. If the stage is generic, this field will not be populated.
remote_dataRemoteData[]
Optional
remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.
field_mappingsObject
Optional
The JobInterviewStage object
JSON
{
  "id": "f9813dd5-e70b-484c-91d8-00acd6065b07",
  "remote_id": "876556788",
  "name": "Phone Screen",
  "job": "ba7d9648-5316-4a80-8d73-4e636cef5a90",
  "remote_data": [
    {
      "path": "/interview-stages",
      "data": [
        "Varies by platform"
      ]
    }
  ],
  "remote_was_deleted": true,
  "field_mappings": {
    "organization_defined_targets": {
      "custom_key": "custom_value"
    },
    "linked_account_defined_targets": {
      "custom_key": "custom_value"
    }
  }
}
GET

/job-interview-stages

Returns a list of JobInterviewStage objects.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters

created_afterString
Optional
If provided, will only return objects created after this datetime.
created_beforeString
Optional
If provided, will only return objects created before this datetime.
cursorString
Optional
The pagination cursor value.
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
job_idString
Optional
If provided, will only return interview stages for this job.
modified_afterString
Optional
If provided, will only return objects modified after this datetime.
modified_beforeString
Optional
If provided, will only return objects modified before this datetime.
page_sizeInteger
Optional
Number of results to return per page.
remote_idString
Optional
The API provider's ID for the given object.
Response
JSON
{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "f9813dd5-e70b-484c-91d8-00acd6065b07",
      "remote_id": "876556788",
      "name": "Phone Screen",
      "job": "ba7d9648-5316-4a80-8d73-4e636cef5a90",
      "remote_data": [
        {
          "path": "/interview-stages",
          "data": [
            "Varies by platform"
          ]
        }
      ],
      "remote_was_deleted": true,
      "field_mappings": {
        "organization_defined_targets": {
          "custom_key": "custom_value"
        },
        "linked_account_defined_targets": {
          "custom_key": "custom_value"
        }
      }
    }
  ]
}
Field support by platform

ApplicantStack

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString
nameString
remote_dataRemoteData[]
pathstring
dataobject

Ashby

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

BambooHR

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

BizMerlinHR

BizMerlinHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

Breezy

Breezy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

CATS

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Comeet

Comeet

Cornerstone TalentLink

Cornerstone TalentLink

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString
nameString

EngageATS

EngageATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Eploy

Eploy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Fountain

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

HR Cloud

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject

iCIMS

iCIMS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

JazzHR

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject

JobAdder

JobAdder

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

JobScore

JobScore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Jobvite

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Lever

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Oracle Taleo

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Recruitee

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Recruiterflow

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

SmartRecruiters

SmartRecruiters

TalentLyft

TalentLyft

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Teamtailor

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Workable

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/job-interview-stages/{id}

Returns a JobInterviewStage object with the given id.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idString
Required
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{
  "id": "f9813dd5-e70b-484c-91d8-00acd6065b07",
  "remote_id": "876556788",
  "name": "Phone Screen",
  "job": "ba7d9648-5316-4a80-8d73-4e636cef5a90",
  "remote_data": [
    {
      "path": "/interview-stages",
      "data": [
        "Varies by platform"
      ]
    }
  ],
  "remote_was_deleted": true,
  "field_mappings": {
    "organization_defined_targets": {
      "custom_key": "custom_value"
    },
    "linked_account_defined_targets": {
      "custom_key": "custom_value"
    }
  }
}
Field support by platform

ApplicantStack

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString
nameString
remote_dataRemoteData[]
pathstring
dataobject

Ashby

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

BambooHR

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

BizMerlinHR

BizMerlinHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

Breezy

Breezy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

CATS

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Comeet

Comeet

Cornerstone TalentLink

Cornerstone TalentLink

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString
nameString

EngageATS

EngageATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Eploy

Eploy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Fountain

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

HR Cloud

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject

iCIMS

iCIMS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

JazzHR

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject

JobAdder

JobAdder

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_idString

JobScore

JobScore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Jobvite

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Lever

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Oracle Taleo

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Recruitee

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Recruiterflow

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

SmartRecruiters

SmartRecruiters

TalentLyft

TalentLyft

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Teamtailor

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString
nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString

Workable

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString
remote_dataRemoteData[]
pathstring
dataobject
remote_idString
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.

Previous

Interviews

Next Up

Jobs