Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Application

application.list

Gets all applications in the organization.

See the Pagination and Incremental Synchronization guide for detailed usage examples.

Requires the candidatesRead permission.

post/application.list

Request body

syncTokenstring nullable

A sync token to retrieve only applications updated since the last sync. Obtained from a previous list response.

cursorstring nullable

The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.

limitnumber nullable

The maximum number of applications to return per page.

createdAfternumber nullable

Unix timestamp (milliseconds). When provided, only applications created at or after this time are returned. Must not be later than createdBefore or in the future.

createdBeforenumber nullable

Unix timestamp (milliseconds). When provided, only applications created at or before this time are returned. Must not be in the future.

statusstring nullable

Filter applications by status. Comparison is case-insensitive against Hired, Archived, Active, Lead.

jobIdstring uuid nullable

Only return applications for the job with the supplied id.

expandstring[] nullable

Choose to expand the result and include additional data for related objects.

Example request

{
  "syncToken": "jYnEBmjzR",
  "cursor": "G8",
  "limit": 25,
  "jobId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
}

Response

Responses from the application.list endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-16T10:30:00.000Z",
      "status": "Active",
      "customFields": [],
      "candidate": {
        "id": "84bfbed7-ed0a-496d-bb18-11b73369f666",
        "name": "Michael Bluth",
        "primaryEmailAddress": {
          "value": "michael@bluth.example",
          "type": "Personal",
          "isPrimary": true
        },
        "primaryPhoneNumber": null
      },
      "currentInterviewStage": {
        "id": "c153b3e9-8b97-4fc0-bad1-6c654122c1f8",
        "title": "Application Review",
        "type": "PreInterviewScreen",
        "orderInInterviewPlan": 1,
        "interviewStageGroupId": null,
        "interviewPlanId": "d3f4762e-1234-4abc-9876-aabbccddeeff"
      },
      "source": null,
      "archiveReason": null,
      "archivedAt": null,
      "job": {
        "id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd",
        "title": "First Designer",
        "locationId": null,
        "departmentId": null
      },
      "creditedToUser": null,
      "hiringTeam": [],
      "appliedViaJobPostingId": null,
      "submitterClientIp": null,
      "submitterUserAgent": null
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}