Skip to main content
GET
/
candidates
Get candidates
curl --request GET \
  --url https://api.example.com/candidates
{
  "id": 123,
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "statusId": 123,
  "dateAdded": 123,
  "phone": "<string>",
  "address": {
    "address1": "<string>",
    "address2": "<string>",
    "city": "<string>",
    "countryCode": "<string>",
    "state": "<string>",
    "timezone": "<string>",
    "zip": "<string>"
  },
  "notes": "<string>",
  "profession": "<string>",
  "specialty": "<string>",
  "status": {
    "id": 123,
    "name": "<string>",
    "type": "CANDIDATE",
    "description": "<string>",
    "isDefault": true,
    "isActive": true
  }
}

Query Parameters

id
string

Filter by id

Response

Successfully retrieved candidate

id
integer
required
firstName
string
required
lastName
string
required
email
string
required
statusId
integer
required

ID of the candidate's status

dateAdded
integer<int64>
required

Unix timestamp when the candidate was added

phone
string
address
object
notes
string
profession
string
specialty
string
status
object

Full status object