Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Candidate

candidate.listProjects

Lists the projects a candidate has been added to.

Requires the candidatesRead permission.

post/candidate.listProjects

Request body

candidateIdstring uuid required

The id of the candidate to fetch projects for

cursorstring nullable

Opaque cursor indicating which page of results to fetch

limitnumber nullable

The maximum number of items to return. The maximum and default value is 100.

Example request

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

Response

Responses from the candidate.listProjects endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "bcffca12-5b09-4a76-acf2-00a8e267b222",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "title": "Senior Engineers",
      "isArchived": false,
      "authorId": "7211e226-7802-41fd-8d55-2720fe9d534f",
      "description": "Project for sourcing senior engineers",
      "confidential": false,
      "customFieldEntries": []
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}