GET
/
v1.0
/
{company_id}
/
candidates
curl --request GET \
  --url https://api.hirehive.com/v1.0/{company_id}/candidates \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "page_size": 123,
    "page": 123,
    "total_items": 123,
    "total_pages": 123,
    "has_next_page": true,
    "has_previous_page": true
  },
  "links": {
    "first": "<string>",
    "last": "<string>",
    "next": "<string>",
    "previous": "<string>"
  },
  "items": [
    {
      "id": "<string>",
      "full_name": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "phone_number": "<string>",
      "title": "<string>",
      "company": "<string>",
      "location": {
        "address": "<string>",
        "country": {
          "name": "<string>",
          "code": "<string>"
        }
      },
      "image_url": "<string>",
      "tags": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "rating": 123,
      "application_ids": [
        "<string>"
      ],
      "social_profiles": [
        {
          "type": "linked_in",
          "uri": "<string>"
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

company_id
string
required

Query Parameters

sort
string

Sortable fields: first_name, last_name.

email
string

Filter candidates by email address

first_name
string

Filter candidates by first name

last_name
string

Filter candidates by last name

rating
integer | null

Filter candidates by star rating

tags
string

A list of tags to filter by: eg tag_kiZyCd

page
integer

Defaults to 1

page_size
integer

Defaults to 30. Min = 1. Max = 100

Required range: 1 <= x <= 100

Response

200
application/json
meta
object
items
object[]