v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB

Application

Get Applications

Returns a list of Application objects.

get/api/ats/v1/applications

Query parameters

idsstring nullable

The ID of the applications to fetch

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a

The ID of the applications to fetch

remote_idstring

The third-party API ID of the matching object.

Example:3235005483341316245

The third-party API ID of the matching object.

current_stagestring nullable

The current stage ids of the application

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a

The current stage ids of the application

credited_tostring nullable

The user ids which has the credit for the applications to fetch

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a

The user ids which has the credit for the applications to fetch

sourcestring

The source of the application

Example:Linkedin

The source of the application

jobstring nullable

The job ids for the applications to fetch

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a

The job ids for the applications to fetch

candidatestring nullable

The candidate ids for the applications to fetch

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a

The candidate ids for the applications to fetch

reject_reasonstring nullable

The reject reason ids for the applications to fetch

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a

The reject reason ids for the applications to fetch

include_raw_databoolean

Include raw data in the response

include_custom_fieldsboolean

Whether to include custom fields in the response.

page_sizeinteger

Number of results to return per page. Maximum size is 200.

cursorstring

The pagination cursor value.

expandstring

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Example:manager[first_name,last_name]

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

modified_afterstring

If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601)

Example:2024-02-21T21:22:12.993Z

If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601)

Headers

x-connector-tokenstring required

Response

Successful Response

cursorstring nullable required

Cursor value to fetch next set of items

page_sizeinteger required

Indicates the count of items in the response

Example response

{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 50,
  "items": [
    {
      "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
      "remote_id": "123321",
      "modified_at": "2021-10-16T00:00:00Z",
      "raw_data": {
        "key_1": "Platform dependent data 1",
        "key_2": "Platform dependent data 2"
      },
      "custom_fields": {
        "category_group": "REG",
        "disability_type": "ASBERG",
        "hire_date": "1991-03-16T00:00:00",
        "hire_source": "REFER",
        "nationality": "USA",
        "original_hire_date": "1991-03-16T00:00:00"
      },
      "candidate": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
      "job": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
      "applied_at": "2021-01-01T00:00:00Z",
      "rejected_at": "2021-01-01T00:00:00Z",
      "source": "LinkedIn",
      "credited_to": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
      "current_stage": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
      "reject_reason": "018b4bfb-5ece-70b1-ad5e-862a9433aa65"
    }
  ]
}