Skip to main content

Get User

GET /clients/{client_id}/users/{user_id}

Returns the full profile for a specific user, fetched directly by ID.

When to use this endpoint

You should always be able to fetch any known resource directly by its ID. The list endpoint is for discovery -- this endpoint is for direct access.

ScenarioWhy this endpoint
User clicks a row in the table, app navigates to their profile pageLoad one user by ID without fetching the full list
Another domain embeds a UserRef with a "View User" linkThe link resolves here
Refresh one user's state after a PATCHRe-fetch only that user, not the whole list
An integration or script needs to look up a specific userDirect ID lookup, no search required

GET /users is the right call when you need a collection. GET /users/{id} is the right call when you already know which user you need.

Path Parameters

ParameterTypeDescription
client_idstring (uuid)Unique identifier for the client organization
user_idstring (uuid)Unique identifier for the user

Response

Returns a single User object.

FieldTypeNullableDescription
idstring (uuid)NoStable unique identifier for the user
usernamestringNoSystem-managed username
user_keystringNoUnique key used to identify the user within the client
last_activityobjectNoGrouped activity timestamps across all channels
last_activity.atstring (ISO 8601)YesMost recent activity across any channel
last_activity.desktop_atstring (ISO 8601)YesMost recent desktop agent activity
last_activity.web_atstring (ISO 8601)YesMost recent web activity
departmentsDepartmentRef[]NoDepartments this user belongs to. Empty array if unassigned.
created_atstring (ISO 8601)NoWhen this user record was first created
updated_atstring (ISO 8601)NoWhen this user record was last modified

Example Request

curl -X GET "https://api.example.com/v2/clients/aa7cf840-9ca9-46a3-9778-9015d6580d50/users/a1d97031-04e2-4907-a249-093f7436207b" \
-H "Authorization: Bearer YOUR_API_TOKEN"

Example Response

{
"id": "a1d97031-04e2-4907-a249-093f7436207b",
"username": "mikechang",
"user_key": "mikechang",
"last_activity": {
"at": "2026-02-24T21:23:53.082Z",
"desktop_at": "2026-02-24T21:22:46.119Z",
"web_at": "2026-02-24T21:23:53.082Z"
},
"departments": [
{
"id": "d1a2b3c4-e5f6-7890-abcd-ef1234567890",
"name": "Engineering",
"description": "Software development and infrastructure teams"
}
],
"created_at": "2026-02-05T21:29:34.214Z",
"updated_at": "2026-02-05T21:29:34.214Z"
}

User with no activity or departments

{
"id": "c3f19253-26g4-6129-c461-215h9658429d",
"username": "newuser",
"user_key": "newuser",
"last_activity": {
"at": null,
"desktop_at": null,
"web_at": null
},
"departments": [],
"created_at": "2026-02-24T10:00:00.000Z",
"updated_at": "2026-02-24T10:00:00.000Z"
}

Error Responses

StatusDescription
401Authentication required
403Insufficient permissions for this client
404User or client not found
500Server error