Skip to main content

Retrieve a user

Retrieve a user

Responses
200

Retrieve a single user by id

Schema OPTIONAL
user object

The user data

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