GET
/
v1
/
users
/
:id
curl https://api.zquenceeee.com/v1/users/6a25cdac36bc6230704b5b59 \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"
{
  "id": "6a25cdac36bc6230704b5b59",
  "name": "James Carter",
  "email": "james.carter@example.com",
  "phone": "+447911123456",
  "tenantId": "bc41c6ab-7206-4033-b632-4d1cfa86d840",
  "environmentId": "69f9b5fa0600ccbf9c677005",
  "role": "user",
  "status": "active",
  "memberships": [
    {
      "environmentId": "69f9b5fa0600ccbf9c677005",
      "environmentName": "Staging Sandbox"
    }
  ],
  "createdAt": "2026-05-20T10:30:00.000Z",
  "updatedAt": "2026-06-07T20:00:12.414Z"
}
Returns the user record scoped to the authenticated tenant. Returns 404 if the user does not exist or belongs to a different tenant.
Users are referred to as customers in the product UI. In the API they are /users resources.

Path parameters

id
string
required
The user’s MongoDB ObjectId, as returned by List customers or the Add customer endpoint.

Returns

A full user object with environment memberships.
id
string
User ID (MongoDB ObjectId).
name
string
Full display name.
email
string
Email address.
phone
string
Phone number in E.164 format.
tenantId
string
Owning tenant identifier.
environmentId
string | null
Primary environment this user belongs to.
role
string
User role — "user", "admin", "compliance", "support", "viewer".
status
string
Account status — "invited", "active", "disabled".
memberships
array
List of environment memberships. Each entry contains environmentId and environmentName.
createdAt
string
ISO 8601 UTC creation timestamp.
updatedAt
string
ISO 8601 UTC last-updated timestamp.

Error codes

StatusCodeMeaning
401UNAUTHORIZEDMissing or invalid authentication.
403FORBIDDENCaller does not have user.view.one permission.
404NOT_FOUNDNo user with this ID exists under the authenticated tenant.
curl https://api.zquenceeee.com/v1/users/6a25cdac36bc6230704b5b59 \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"
{
  "id": "6a25cdac36bc6230704b5b59",
  "name": "James Carter",
  "email": "james.carter@example.com",
  "phone": "+447911123456",
  "tenantId": "bc41c6ab-7206-4033-b632-4d1cfa86d840",
  "environmentId": "69f9b5fa0600ccbf9c677005",
  "role": "user",
  "status": "active",
  "memberships": [
    {
      "environmentId": "69f9b5fa0600ccbf9c677005",
      "environmentName": "Staging Sandbox"
    }
  ],
  "createdAt": "2026-05-20T10:30:00.000Z",
  "updatedAt": "2026-06-07T20:00:12.414Z"
}