Skip to main content
GET
/
v1
/
candidates
List candidates
curl --request GET \
  --url https://api.georgekats.com/v1/candidates \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "candidate_alias": "<string>",
      "customer_uuid": "<string>",
      "contract": {
        "price": 123,
        "activity_window": 123,
        "review_window": 123,
        "fulfillment_condition": {
          "event": "<string>",
          "match": {},
          "field": "<string>",
          "gt": 123,
          "gte": 123,
          "lt": 123,
          "lte": 123,
          "eq": 123
        },
        "timeout_outcome": "confirm"
      },
      "status": "OPEN",
      "status_since": "2023-11-07T05:31:56Z",
      "scheduled_outcome": "CONFIRMED"
    }
  ],
  "next_cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

API token. Create one from the dashboard.

Query Parameters

​
status
enum<string>

Filter by candidate status.

Available options:
OPEN,
PENDING,
CONFIRMED,
FAILED
​
after
string

Return candidates after this cursor (exclusive). Use the next_cursor from the previous response.

Required string length: 8 - 255
​
limit
integer
default:50

Maximum number of candidates to return.

Required range: 1 <= x <= 100
​
customer_uuid
string

Filter by customer external_id.

Response

List of candidates

​
data
object[]
required
​
next_cursor
string<uuid> | null
required

Pass as after to fetch the next page. null when no more results.