API Reference

List Users

get
https://{subdomain}.pinpointhq.com/api/v1/users
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
fields[users]
array of objects

Include only specified fields of User in response

filter[hiring_manager_job_id]
array of integers

Filter records by Hiring manager job id

filter[hiring_manager_job_id]
filter[recruitment_manager_job_id]
array of integers

Filter records by Recruitment manager job id

filter[recruitment_manager_job_id]
filter[creator_job_id]
array of integers

Filter records by Creator job id

filter[creator_job_id]
filter[interviewing_user_id]
array of integers

Filter records by Interviewing user id

filter[interviewing_user_id]
boolean

Filter records based on whether they're marked as employee

filter[email]
array of strings

Filter records by Email

filter[email]
sort
array of strings

Sort records according to one or more criteria

You should not include both ascending id and descending -id fields the same time

integer
Defaults to 1

The page number of records to return

integer
0 to 1000
Defaults to 100

The number of records to return

string
enum

Include the total number of matched records within the meta key of the response object.

Allowed:
Responses

Updated 22 days ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.api+json

Updated 22 days ago