This resource represents a client user in your portal.


This resource uses all common resource properties.

givenName string
The client's given name (first name).

familyName string
The client's family name (last name).

email string
The client's email.

companyId string
The ID of the company that this client is assigned to. Only appears in portals with companies enabled.

All clients have a companyId. If a client is not associated with a "named" company, the companyId returned will represent a "placeholder" company, with isPlaceholder = true.

status string
The status of the client, one of notInvited, invited or active. When a client is created but not invited their status will show as notInvited. When a client has been invited but not yet signed in their status is invited. When a client has signed in their status is active.

inviteUrl string
A link you can send to the client to invite them to your portal.

lastLoginDate string
When the client last logged in to the portal. If client has never logged in, this value will be null.

Note: lastLoginDate refers to when a client specifically went through the login flow and is distinct from lastActiveDate; a client will typically have a more recent lastActiveDate compared to their lastLoginDate.

lastActiveDate string
When the client was last active in the portal. If client has never logged into the portal, this value will be null.

customFields map
The client's custom field values.

The key is the id of the custom field property and the value is the client's custom field value.
Learn more about custom fields.

    "id": "a8c2c520-8045-4068-1772-a7c8ca09ee1a",
    "object": "client",
    "createdAt": "2022-02-25T02:19:35Z",
    "givenName": "James",
    "familyName": "Doe",
    "email": "[email protected]",
    "companyId": "29a8vja-8d1c-4cde-9a54-92190asd",
    "status": "invited",
    "inviteUrl": "",
    "lastLoginDate": "2023-06-22T19:45:42.750545197Z",
    "lastActiveDate": "2023-06-24T19:45:42.750545197Z",
    "customFields": {
        "phoneNumber": "+14151234567",
        "status": [
        "services": [