Skip to main content
Retrieve a list of candidate projects. Required Scope: 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

ParameterDescription
Candidate IDThe ID of the candidate to retrieve projects for.
CursorThe cursor used to paginate through the results. Use the value returned in nextCursor from a prior response to retrieve the next page.
LimitThe maximum number of candidate projects to return. Valid range is 1-100.
Return All PagesAutomatically fetch all resources, page by page.
Sync TokenA token representing the last time the data was successfully synced.

​
Example Output

{
	"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
				}
			]
		}
	]
}

​
Workflow Library Example

List Candidate Projects with Ashby and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop