Skip to main content

List users

List users

Query Parameters
email string
companyId string
externalUid string
per_page number REQUIRED

Possible values: value ≤ 100

offset number REQUIRED
created_before date-time
created_after date-time
updated_before date-time
updated_after date-time
Responses
200

Return a paginated list of users

Schema OPTIONAL
users object[]
id string
clientId string
createdAt date-time
updatedAt date-time
name string
type string

Possible values: [CUSTOMER, COLLABORATOR, COMPANY_DEFAULT]

email string OPTIONAL

can be an empty string

phone string OPTIONAL
companyId string OPTIONAL
importId string OPTIONAL

only defined when the person were created from XLSL import, equal to its defined ID

externalUid string OPTIONAL

only defined when external uid has been setup in Harvestr and when the entity has an external uid in source

segments object[]
id string
clientId string
name string
createdAt date-time
updatedAt date-time
pageInfos object
next_offset number
per_page number
code number
messageStatus string