<aside> 💡

In the context of this page user-id is the id associated with the API user.

We refer to the [customer-id] for a specific api user

</aside>

Creating an User

• Request Domain: https://api.cheqroom.com
• Request URL: /api/latest/[user-id]/null/jwt/customers/create
• Method: POST
• Headers:

{
    "Content-Type": "application/json",
    "Authorization": "Bearer [token]"
}

• Body:

{
    "name": "FirstName LastName",
    "email": "[email protected]",
    "kind": "contact",
    "fields__Custom Field": "Custom Value"
}

<aside> 💡

You must provide all required field. Standard requires fields: Name, Email

</aside>

Sample Response

{
    "_id": "This is the customer-id",
    "name": "FirstName LastName",
    "kind": "contact",
    "status": "active",
    "email": "[email protected]",
    "category": "cheqroom.types.customer",
    "created": "2025-08-18T17:25:39.707553+00:00",
    "modified": "2025-08-18T17:25:39.707553+00:00",
    "fields": {
        ...
    },
    "user": null,
    "contactGroups": [],
    "role": null,
    "workspaceAccess": false,
    "lastLogin": null,
    ...
}

Read an User

• Request Domain: https://api.cheqroom.com
• Request URL: /api/latest/[user-id]/null/jwt/customers/[customer-id]?_fields=*,fields.*
• Method: GET
• Headers:

{
    "Content-Type": "application/json",
    "Authorization": "Bearer [token]"
}

Sample Response