Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Project

project.list

Lists projects.

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

Requires the candidatesRead permission.

post/project.list

Request body

createdAfterinteger nullable

The API will return data after this date, which is the time since the unix epoch in milliseconds

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

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

Response

Responses from the project.list endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "title": "My Project",
      "isArchived": false,
      "authorId": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d",
      "description": "A project for sourcing candidates",
      "confidential": false,
      "customFieldEntries": []
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}