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.
Parameters
| Parameter | Description |
|---|---|
| Created After | Filter candidates that were created after the specified timestamp. |
| 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 candidates 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. |
Example Output
{
"success": true,
"moreDataAvailable": true,
"nextCursor": "G8",
"syncToken": "jYnEBmjzR",
"results": [
{
"id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
"createdAt": "2022-08-12T20:29:56.964Z",
"updatedAt": "2022-08-12T20:29:56.964Z",
"name": "Adam Hart",
"primaryEmailAddress": {
"value": "test@ashbyhq.com",
"type": "Work",
"isPrimary": true
},
"emailAddresses": [
{
"value": "test@ashbyhq.com",
"type": "Work",
"isPrimary": true
}
],
"primaryPhoneNumber": {
"value": "test@ashbyhq.com",
"type": "Work",
"isPrimary": true
},
"phoneNumbers": [
{
"value": "test@ashbyhq.com",
"type": "Work",
"isPrimary": true
}
],
"socialLinks": [
{
"url": "https://linkedin.com/in/user",
"type": "LinkedIn"
}
],
"tags": [
{
"id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
"title": "Senior Candidate",
"isArchived": false
}
],
"position": "Software Engineer",
"company": "Auction.com",
"school": "Princeton University",
"applicationIds": [
"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
],
"resumeFileHandle": {
"id": "15d2624d-0a81-4f94-a2ed-94980f430b3f",
"name": "resume.pdf",
"handle": "eyJoYW5kbGUiOnsidHlwZSI6IkNhbmRpZGF0ZUZpbGUiLCJm"
},
"fileHandles": [
{
"id": "15d2624d-0a81-4f94-a2ed-94980f430b3f",
"name": "resume.pdf",
"handle": "eyJoYW5kbGUiOnsidHlwZSI6IkNhbmRpZGF0ZUZpbGUiLCJm"
}
],
"customFields": [
{
"id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
"isPrivate": false,
"title": "string",
"valueLabel": "string",
"value": true
}
],
"profileUrl": "string",
"source": {
"id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
"title": "Applied",
"isArchived": false,
"sourceType": {
"id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
"title": "Inbound",
"isArchived": false
}
},
"creditedToUser": {
"id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
"firstName": "Test",
"lastName": "User",
"email": "test@ashbyhq.com",
"globalRole": "Organization Admin",
"isEnabled": true,
"updatedAt": "2022-08-12T20:29:56.964Z",
"managerId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
},
"timezone": "string",
"location": {
"id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
"locationSummary": "United States, California, San Francisco",
"locationComponents": [
{
"type": "Country",
"name": "United States"
},
{
"type": "Region",
"name": "California"
},
{
"type": "City",
"name": "San Francisco"
}
]
}
}
]
}
Workflow Library Example
List Candidates with Ashby and Send Results Via Email