List Candidates

get/public/v1/candidates

get/public/v1/candidates

curl --request GET \
  --url 'https://api.app.astalty.com.au/public/v1/candidates' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Response

{
  "data": [
    {
      "id": "f6a7b8c9-d0e1-42f3-8a4b-5c6d7e8f9a0b",
      "first_name": "Ava",
      "middle_name": "Mai",
      "last_name": "Nguyen",
      "preferred_name": "Avie",
      "email": "ava.nguyen@example.com",
      "mobile": "0412 345 678",
      "phone": "02 9876 5432",
      "created_at": "2026-03-01T10:30:00+11:00",
      "updated_at": "2026-03-02T09:00:00+11:00"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 0,
    "total": 0,
    "allowed_sorts": [
      "string"
    ]
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Query parameters

filter[email]string
One or more email addresses, comma separated. Exact match, ignoring case.
Example:ava.nguyen@example.com
page[size]integer
Number of results per page. Minimum 1, maximum 100.
Default:25
page[number]integer
The page number to retrieve. Use the last_page value from the meta response to determine the total number of pages available.
Default:1

Response

200application/json

Paginated set of CandidateResource

dataobject[]required
▶Show 10 child attributesHide child attributes
- idstringrequired
  Example:f6a7b8c9-d0e1-42f3-8a4b-5c6d7e8f9a0b
- first_namestringrequired
  Example:Ava
- middle_namestring | nullrequired
  Example:Mai
- last_namestringrequired
  Example:Nguyen
- preferred_namestring | nullrequired
  Example:Avie
- emailstringrequired
  Example:ava.nguyen@example.com
- mobilestring | nullrequired
  Example:0412 345 678
- phonestring | nullrequired
  Example:02 9876 5432
- created_atstringrequired
  Example:2026-03-01T10:30:00+11:00
- updated_atstringrequired
  Example:2026-03-02T09:00:00+11:00
metaobjectrequired
▶Show 5 child attributesHide child attributes
- current_pageintegerrequired≥ 1
- last_pageintegerrequired≥ 1
- per_pageintegerrequired≥ 0
  Number of items shown per page.
- totalintegerrequired≥ 0
  Total number of items being paginated.
- allowed_sortsstring[]required
  The list of allowed sorts for this endpoint.

Errors

401Unauthenticated
403Authorization error

Command Palette

Authorization

Query parameters

Response

Errors