Job Interview Stages

The JobInterviewStage object is used to represent the stage that a job application is in.

The JobInterviewStage object

Properties

idString

Required

remote_idString

Optional

The third-party API ID of the matching object.

nameString

Optional

The stage's name.

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.

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
}

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 support by platform

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString

nameString

remote_dataRemoteData[]

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

BizMerlinHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

Breezy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString

nameString

remote_dataRemoteData[]

remote_idString

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Comeet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

Cornerstone TalentLink

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString

nameString

EngageATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Eploy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString

nameString

remote_dataRemoteData[]

remote_idString

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString

nameString

remote_dataRemoteData[]

remote_idString

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

JobScore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString

nameString

remote_dataRemoteData[]

remote_idString

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString

nameString

remote_dataRemoteData[]

remote_idString

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString

nameString

remote_dataRemoteData[]

remote_idString

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString

nameString

remote_dataRemoteData[]

remote_idString

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

TalentLyft

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString

nameString

remote_dataRemoteData[]

remote_idString

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString

nameString

remote_dataRemoteData[]

remote_idString

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

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 support by platform

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString

nameString

remote_dataRemoteData[]

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

BizMerlinHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

Breezy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString

nameString

remote_dataRemoteData[]

remote_idString

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Comeet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

Cornerstone TalentLink

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString

nameString

EngageATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Eploy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString

nameString

remote_dataRemoteData[]

remote_idString

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString

nameString

remote_dataRemoteData[]

remote_idString

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

JobScore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString

nameString

remote_dataRemoteData[]

remote_idString

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString

nameString

remote_dataRemoteData[]

remote_idString

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString

nameString

remote_dataRemoteData[]

remote_idString

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString

nameString

remote_dataRemoteData[]

remote_idString

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

remote_idString

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

TalentLyft

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString

nameString

remote_dataRemoteData[]

remote_idString

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

jobString

nameString

remote_dataRemoteData[]

remote_idString

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataRemoteData[]

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.

Interviews

Next Up

Jobs

Job Interview Stages

The JobInterviewStage object

Properties

/job-interview-stages

Header Parameters

Query & Path Parameters

ApplicantStack

Ashby

BambooHR

BizMerlinHR

Breezy

CATS

Comeet

Cornerstone TalentLink

EngageATS

Eploy

Fountain

Greenhouse

HR Cloud

JazzHR

JobScore

Jobvite

Lever

Oracle Taleo

Recruitee

Recruiterflow

Sage HR

SAP SuccessFactors

SmartRecruiters

TalentLyft

Teamtailor

Workable

Workday

/job-interview-stages/{id}

Header Parameters

Query & Path Parameters

ApplicantStack

Ashby

BambooHR

BizMerlinHR

Breezy

CATS

Comeet

Cornerstone TalentLink

EngageATS

Eploy

Fountain

Greenhouse

HR Cloud

JazzHR

JobScore

Jobvite

Lever

Oracle Taleo

Recruitee

Recruiterflow

Sage HR

SAP SuccessFactors

SmartRecruiters

TalentLyft

Teamtailor

Workable

Workday

Previous

Next Up

Get Started

API Reference