Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Candidate

candidate.list

Lists all candidates in the organization with pagination and incremental sync support.

Use the syncToken parameter to retrieve only candidates updated since your last sync. Use createdAfter to filter candidates by creation date.

Requires the candidatesRead permission.

post/candidate.list

Request body

cursorstring nullable

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

limitinteger nullable

The maximum number of candidates to return per page. Maximum is 100.

syncTokenstring nullable

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

createdAfternumber nullable

Unix timestamp (milliseconds). When provided, only candidates 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 candidates created at or before this time are returned. Must not be in the future.

Example request

{
  "cursor": "G8",
  "limit": 25,
  "syncToken": "jYnEBmjzR"
}

Response

Responses from the candidate.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",
      "name": "Adam Hart",
      "primaryEmailAddress": {
        "value": "adam.hart@example.com",
        "type": "Personal",
        "isPrimary": true
      },
      "emailAddresses": [
        {
          "value": "adam.hart@example.com",
          "type": "Personal",
          "isPrimary": true
        }
      ],
      "primaryPhoneNumber": null,
      "phoneNumbers": [],
      "socialLinks": [],
      "tags": [],
      "applicationIds": [
        "f9e52a51-a075-4116-a7b8-484deba69004"
      ],
      "resumeFileHandle": null,
      "fileHandles": [],
      "profileUrl": "https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "source": null,
      "creditedToUser": null,
      "timezone": null,
      "fraudStatus": null
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}