Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Candidate

candidate.listNotes

Lists the notes that have been added to a candidate.

Requires the candidatesRead permission.

post/candidate.listNotes

Request body

candidateIdstring uuid required

The id of the candidate to fetch notes for

cursorstring nullable

Opaque cursor indicating which page of results to fetch

syncTokenstring nullable

An opaque token representing the last time the data was successfully synced from the API. A new, updated one is returned after successfully fetching the last page of data.

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",
  "syncToken": "jYnEBmjzR",
  "limit": 25
}

Response

Responses from the candidate.listNotes endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "5fa61e0b-3c4d-4e5f-9a0b-1c2d3e4f5a6b",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "isPrivate": false,
      "content": "Strong candidate, very interested in the company",
      "author": {
        "id": "84bfbed7-ed0a-496d-bb18-11b73369f666",
        "firstName": "George",
        "lastName": "Bluth",
        "email": "george@bluth.example"
      }
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}