ts.usr.get

Retrieve a user by ID.

Retrieve a user by ID.

Requires authentication

Description

Retrieves detailed information about a specific user.

Requires authentication. Users can always retrieve their own information. Admins can retrieve any user’s information.

Parameters

NameTypeRequiredDefaultDescription
idstringYesUser ID to retrieve

Response

Returns the user object if found.

{
  "created_at": "2026-02-04T15:30:00Z",
  "email": "smith@example.com",
  "id": "usr_01H8X9ABCDEF",
  "metadata": {
    "department": "engineering"
  },
  "name": "Agent Smith",
  "status": "active",
  "updated_at": "2026-02-04T15:30:00Z"
}

Errors

CodeDescription
not_authenticatedNo active login for this session
not_foundUser with this ID does not exist
unauthorizedNot allowed to view this user

Examples

Get user by ID

Request:

{
  "id": "usr_01H8X9ABCDEF"
}

Response:

{
  "created_at": "2026-02-04T15:30:00Z",
  "email": "smith@example.com",
  "id": "usr_01H8X9ABCDEF",
  "name": "Agent Smith",
  "status": "active",
  "updated_at": "2026-02-04T15:30:00Z"
}