GET
/
v1.0
/
{company_id}
/
interviews
curl --request GET \
  --url https://api.hirehive.com/v1.0/{company_id}/interviews \
  --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>",
      "candidate_id": "<string>",
      "application_id": "<string>",
      "job_id": "<string>",
      "event": {
        "title": "<string>",
        "location": "<string>",
        "type": "phone",
        "status": "active",
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z",
        "time_zone": "<string>",
        "organizer_id": "<string>",
        "attendees": [
          {
            "id": "<string>",
            "application_id": "<string>",
            "user_id": "<string>",
            "type": "user",
            "status": "accepted",
            "display_name": "<string>",
            "email": "<string>"
          }
        ]
      },
      "meta": {
        "note_for_candidate": "<string>",
        "note_for_attendees": "<string>",
        "attach_resume_to_invite": true,
        "online_meeting_type": "hangouts_meet",
        "meeting_url": "<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

​
candidate_id
string | null

Filter interviews for a specific candidate

​
job_id
string | null

Filter interviews for a specific job

​
starts_before
string | null

Return interviews starting before the specified date

​
starts_after
string | null

Return interviews starting after the specified date

​
ends_before
string | null

Return interviews ending before the specified date

​
ends_after
string | null

Return interviews ending after the specified date

​
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
​
links
object
​
items
object[]

Was this page helpful?

Suggest editsRaise issue