candidatesRead
Note: Private candidate field data is unavailable by default. For more information please refer to Ashby documentation.
External DocumentationTo learn more, visit the Ashby documentation.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
candidatesRead
Note: Private candidate field data is unavailable by default. For more information please refer to Ashby documentation.
| Parameter | Description |
|---|---|
| Candidate ID | The ID of the candidate to retrieve projects for. |
| Cursor | The cursor used to paginate through the results. Use the value returned in nextCursor from a prior response to retrieve the next page. |
| Limit | The maximum number of candidate projects to return. Valid range is 1-100. |
| Return All Pages | Automatically fetch all resources, page by page. |
| Sync Token | A token representing the last time the data was successfully synced. |
{
"success": true,
"moreDataAvailable": true,
"nextCursor": "G8",
"results": [
{
"id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
"title": "Office Event",
"description": "Folks invited to office for an event",
"isArchived": false,
"confidential": false,
"authorId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
"createdAt": "2022-08-12T20:29:56.964Z",
"customFieldEntries": [
{
"id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
"isPrivate": false,
"title": "string",
"valueLabel": "string",
"value": true
}
]
}
]
}
Was this page helpful?