Skip to main content
This resource represents a client user in your workspace.

​
Properties

id string The unique identifier for this item. createdAt string The date this item was created in RFC3339 format. updatedAt string The date this item was updated in RFC3339 format. object string The object type of this resource. givenName string The client’s given name (first name). familyName string The client’s family name (last name). email string The client’s email. companyIds array of string The IDs of the companies that this client is assigned to. Only applies for workspaces with companies enabled. Note that all clients have must be part of at least one companyId. If a client is not associated with a “named” company, the single item in the list will represent a “placeholder” company. If the placeholder companyId is used to call Retrieve a Company, the company object will be returned with isPlaceholder = true. companyId (Deprecated) string As part of the transition to allow a client to be part of multiple companies, companyId is being deprecated. Please use companyIds instead. status string The status of the client, one of notInvited, invited or active. inviteUrl string A link you can send to the client to invite them to your portal. avatarImageUrl string A link to the client’s avatar image. If no image is set, this value will be null . firstLoginDate string When the client first logged in to the portal. If client has never logged in, this value will be null. lastLoginDate string When the client last logged in to the portal. If client has never logged in, this value will be null. Note that this value refers to when a client explicitly went through the login flow and does not refer to the most recent session. fallbackColor string A hex value indicating a fallback color for a user with no avatar. creationMethod string The client user’s creation method, one of internalUser, client, & directSignUp. customFields map The client’s custom field values. The key is the key of the custom field property, and the value is the client’s custom field value. Learn more about creating custom fields here. Note: this will be null if the client has no custom fields set.
Example Client Object