List users

List users

Query Parameters
per_page number Possible values: value ≤ 100 Number of items to return per page (max 100)
offset number Number of items to skip (for pagination)
created_before date-time Filter items created before this date (ISO 8601 format)
created_after date-time Filter items created after this date (ISO 8601 format)
updated_before date-time Filter items updated before this date (ISO 8601 format)
updated_after date-time Filter items updated after this date (ISO 8601 format)
email string Filter users by email address
companyId string Filter users by company ID
externalUid string Filter users by external unique identifier

Responses

200 Return a paginated list of users Schema — OPTIONAL users object[] Array of users id string Unique identifier of the user clientId string Client identifier createdAt date-time Creation date of the user updatedAt date-time Last update date of the user name string Name of the user type string Possible values: [CUSTOMER, COLLABORATOR, COMPANY_DEFAULT] Type of the user email string — OPTIONAL Email address of the user (can be empty) phone string — OPTIONAL Phone number of the user companyId string — OPTIONAL Identifier of the company the user belongs to importId string — OPTIONAL Only defined when the user was created from XLSX 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[] Segments associated with this user id string Unique identifier of the segment clientId string Client identifier name string Name of the segment createdAt date-time Creation date of the segment updatedAt date-time Last update date of the segment