Users
Get users
Getting Started
Endpoints
- Applications
- Candidates
- Jobs
- Feedback
- Interviews
- Users
- Files
- Settings
- Webhooks
Webhooks
Users
Get users
Get a paginated list of users.
GET
/
v1.0
/
{company_id}
/
users
curl --request GET \
--url https://api.hirehive.com/v1.0/{company_id}/users \
--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>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"assigned_job_ids": [
"<string>"
],
"type": "primary_admin",
"category": {
"id": "<string>",
"name": "<string>"
},
"permissions": [
"<string>"
],
"reviewer_statuses": [
{
"parent_stage": "rejected",
"custom_stage": {
"id": "<string>",
"name": "<string>"
}
}
],
"linked_user_candidates": [
{
"user_id": "<string>",
"candidate_id": "<string>",
"full_name": "<string>",
"email": "<string>"
}
]
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Query Parameters
Defaults to 1
Defaults to 30. Min = 1. Max = 100
Required range:
1 <= x <= 100
Response
200 - application/json
Available options:
primary_admin
, admin
, user
, recruiter
, reviewer
Available options: MANAGE_TEAM
, SETTINGS_BILLING
, SETTINGS_JOBBOARD
, RESTRICTED_ACCESS
, EXPORT_REPORTS
, MANAGE_JOBS
, JOB_PUBLISH
, MESSAGE_CANDIDATE
The parent stage of the application. eg Screening
, Interviewing
Available options:
rejected
, new
, screening
, interviewing
, offered
, hired
Was this page helpful?
curl --request GET \
--url https://api.hirehive.com/v1.0/{company_id}/users \
--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>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"assigned_job_ids": [
"<string>"
],
"type": "primary_admin",
"category": {
"id": "<string>",
"name": "<string>"
},
"permissions": [
"<string>"
],
"reviewer_statuses": [
{
"parent_stage": "rejected",
"custom_stage": {
"id": "<string>",
"name": "<string>"
}
}
],
"linked_user_candidates": [
{
"user_id": "<string>",
"candidate_id": "<string>",
"full_name": "<string>",
"email": "<string>"
}
]
}
]
}