List Interviews

GET

unified

ats

interviews

curl --request GET \
  --url https://api.stackone.com/unified/ats/interviews \
  --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",
      "unified_custom_fields": {
        "my_project_custom_field_1": "REF-1236",
        "my_project_custom_field_2": "some other value"
      },
      "application_id": "<string>",
      "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
      "interview_stage_id": "<string>",
      "remote_interview_stage_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
      "interview_stage": {
        "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "unified_custom_fields": {
          "my_project_custom_field_1": "REF-1236",
          "my_project_custom_field_2": "some other value"
        },
        "name": "<string>",
        "order": 123,
        "created_at": "2021-01-01T01:01:01.000Z",
        "updated_at": "2021-01-01T01:01:01.000Z"
      },
      "interview_status": {
        "value": "unscheduled",
        "source_value": "Unscheduled"
      },
      "interviewer_ids": [
        "<string>"
      ],
      "remote_interviewer_ids": [
        "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
        "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
      ],
      "interview_parts": [
        {
          "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "type": {
            "value": "on_site",
            "source_value": "Onsite Interview"
          },
          "title": "Interview (Informal Interview) - Elon and StackOne",
          "interviewer_ids": [
            "cx28iQahdfDHa",
            "cx28iQokkD78das"
          ],
          "remote_interviewer_ids": [
            "cx28iQahdfDHa",
            "cx28iQokkD78das"
          ],
          "meeting_url": "zoomus://zoom.us/join?confno=123456789",
          "meeting_provider": "zoom",
          "start_at": "2021-01-01T17:00:00.000Z",
          "end_at": "2021-01-01T18:00:00.000Z",
          "created_at": "2021-01-01T01:01:01.000Z",
          "updated_at": "2021-01-01T01:01:01.000Z"
        }
      ],
      "interviewers": [
        {
          "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "first_name": "<string>",
          "last_name": "<string>",
          "name": "<string>",
          "email": "<string>"
        }
      ],
      "start_at": "2021-01-01T01:01:01.000Z",
      "end_at": "2021-01-01T01:01:01.000Z",
      "meeting_url": "<string>",
      "created_at": "2021-01-01T01:01:01.000Z",
      "updated_at": "2021-01-01T01:01:01.000Z"
    }
  ],
  "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,application_id,remote_application_id,interview_stage_id,remote_interview_stage_id,interview_stage,status,interview_status,interviewer_ids,remote_interviewer_ids,interview_parts,interviewers,start_at,end_at,meeting_url,created_at,updated_at"

filter

object | null

ATS Interviews Filter

page

string | null

deprecated

The page number of the results to fetch

page_size

string | null

default:25

The number of results per page

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"

sync_token

string | null

deprecated

The sync token to select the only updated results

Response

200

application/json

The list of interviews was retrieved.

data

object[]

required

data.id

string | null

Unique identifier

Example:

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

data.remote_id

string | null

Provider's unique identifier

Example:

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

data.unified_custom_fields

object | null

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.application_id

string | null

data.remote_application_id

string | null

Provider's unique identifier of the application

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.interview_stage_id

string | null

data.remote_interview_stage_id

string | null

Provider's unique identifier of the interview stage

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.interview_stage

object

data.interview_stage.id

string | null

Unique identifier

Example:

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

data.interview_stage.remote_id

string | null

Provider's unique identifier

Example:

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

data.interview_stage.unified_custom_fields

object | null

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.interview_stage.name

string | null

data.interview_stage.order

number | null

data.interview_stage.created_at

string | null

Interview Stage created date

Example:

"2021-01-01T01:01:01.000Z"

data.interview_stage.updated_at

string | null

Interview Stage updated date

Example:

"2021-01-01T01:01:01.000Z"

data.interview_status

object

data.interviewer_ids

string[] | null

data.remote_interviewer_ids

string[] | null

Provider's unique identifiers of the interviewers

Example:

[
  "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
  "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
]

data.interview_parts

object[] | null

data.interview_parts.id

string | null

Unique identifier

Example:

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

data.interview_parts.remote_id

string | null

Provider's unique identifier

Example:

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

data.interview_parts.type

object

data.interview_parts.title

string | null

The title of interview, usually corresponding to the title of an associated calendar event

Example:

"Interview (Informal Interview) - Elon and StackOne"

data.interview_parts.interviewer_ids

string[] | null

The user (interviewer) IDs taking part in this specific interview.

Example:

["cx28iQahdfDHa", "cx28iQokkD78das"]

data.interview_parts.remote_interviewer_ids

string[] | null

Provider's user (interviewer) IDs taking part in this specific interview.

Example:

["cx28iQahdfDHa", "cx28iQokkD78das"]

data.interview_parts.meeting_url

string | null

The meeting URL for the interview - this may be populated using the underlying location if the location string extracted is a valid url.

Example:

"zoomus://zoom.us/join?confno=123456789"

data.interview_parts.meeting_provider

string | null

The video meeting provider used for the interview.

Example:

"zoom"

data.interview_parts.start_at

string | null

The specific interview part's start date

Example:

"2021-01-01T17:00:00.000Z"

data.interview_parts.end_at

string | null

The specific interview part's end date

Example:

"2021-01-01T18:00:00.000Z"

data.interview_parts.created_at

string | null

Interview part created date

Example:

"2021-01-01T01:01:01.000Z"

data.interview_parts.updated_at

string | null

Interview part updated date

Example:

"2021-01-01T01:01:01.000Z"

data.interviewers

object[] | null

data.start_at

string | null

Interview start date

Example:

"2021-01-01T01:01:01.000Z"

data.end_at

string | null

Interview end date

Example:

"2021-01-01T01:01:01.000Z"

data.meeting_url

string | null

data.created_at

string | null

Interview created date

Example:

"2021-01-01T01:01:01.000Z"

data.updated_at

string | null

Interview updated date

Example:

"2021-01-01T01:01:01.000Z"

next_page

string | null

deprecated

string | null

raw

object[] | null

Was this page helpful?

Suggest edits

Get Interview Get Job

curl --request GET \
  --url https://api.stackone.com/unified/ats/interviews \
  --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",
      "unified_custom_fields": {
        "my_project_custom_field_1": "REF-1236",
        "my_project_custom_field_2": "some other value"
      },
      "application_id": "<string>",
      "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
      "interview_stage_id": "<string>",
      "remote_interview_stage_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
      "interview_stage": {
        "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "unified_custom_fields": {
          "my_project_custom_field_1": "REF-1236",
          "my_project_custom_field_2": "some other value"
        },
        "name": "<string>",
        "order": 123,
        "created_at": "2021-01-01T01:01:01.000Z",
        "updated_at": "2021-01-01T01:01:01.000Z"
      },
      "interview_status": {
        "value": "unscheduled",
        "source_value": "Unscheduled"
      },
      "interviewer_ids": [
        "<string>"
      ],
      "remote_interviewer_ids": [
        "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
        "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
      ],
      "interview_parts": [
        {
          "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "type": {
            "value": "on_site",
            "source_value": "Onsite Interview"
          },
          "title": "Interview (Informal Interview) - Elon and StackOne",
          "interviewer_ids": [
            "cx28iQahdfDHa",
            "cx28iQokkD78das"
          ],
          "remote_interviewer_ids": [
            "cx28iQahdfDHa",
            "cx28iQokkD78das"
          ],
          "meeting_url": "zoomus://zoom.us/join?confno=123456789",
          "meeting_provider": "zoom",
          "start_at": "2021-01-01T17:00:00.000Z",
          "end_at": "2021-01-01T18:00:00.000Z",
          "created_at": "2021-01-01T01:01:01.000Z",
          "updated_at": "2021-01-01T01:01:01.000Z"
        }
      ],
      "interviewers": [
        {
          "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "first_name": "<string>",
          "last_name": "<string>",
          "name": "<string>",
          "email": "<string>"
        }
      ],
      "start_at": "2021-01-01T01:01:01.000Z",
      "end_at": "2021-01-01T01:01:01.000Z",
      "meeting_url": "<string>",
      "created_at": "2021-01-01T01:01:01.000Z",
      "updated_at": "2021-01-01T01:01:01.000Z"
    }
  ],
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": "<string>",
      "response": {}
    }
  ]
}

HRIS

Common Guides

API Reference

Authorizations

Headers

Query Parameters

Response