Returns an (optionally) filtered list of all candidates in an account accessible to the authenticated user.
read:candidates
Name | Type | Required | Example | Description |
---|---|---|---|---|
accountId | string | required | 4eb62cb48c9f429c93bc26664c1a5a4d | Unique identifier of an account. |
Name | Type | Required | Example | Description |
---|---|---|---|---|
filter | string | optional | name:Scottie* | Filter results using ElasticSearch Query Syntax. |
sort | array | optional | sort=name:asc&sort=type:desc | To sort the results by either ascending or descending order |
first | integer | optional | 100 | Pagination: Indicates the number of items per page (when After cursor is used) |
after | string | optional | 342dfs09ds329320 | Pagination: Return objects after this cursor |
last | integer | optional | 100 | Pagination: Indicates the number of items per page (when Before cursor is used) |
before | string | optional | 531dfs09ds332932 | Pagination: Return objects before this cursor |