Users

List Users

get/api/v1/users

Request

  • Base URL
    https://your-subdomain.pinpointhq.com
  • URL
    https://your-subdomain.pinpointhq.com/api/v1/users
  • Auth
    API key in header X-API-KEY

Query parameters

fields[users]UsersReadableAttribute[]

User readable attributes list

Include only specified fields of User in response

filter[hiring_manager_job_id]integer[]

Hiring manager job id filter

Filter records by Hiring manager job id

filter[recruitment_manager_job_id]integer[]

Recruitment manager job id filter

Filter records by Recruitment manager job id

filter[creator_job_id]integer[]

Creator job id filter

Filter records by Creator job id

filter[interviewing_user_id]integer[]

Interviewing user id filter

Filter records by Interviewing user id

filter[employee]boolean

Employee filter

Filter records based on whether they're marked as employee

filter[email]string[]

Email filter

Filter records by Email

sortstring[]

User sortable attributes

Sort records according to one or more criteria

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

page[number]integer
Example:1

The page number of records to return

page[size]integer

The number of records to return

stats[total]'count'
Example:count

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

Response

OK: Users collection

Changes

No recorded changes to this operation across all 1 revision of this API.