Skip to main content
Retrieve user details by the optional custom_id set during user creation, instead of the internal UUID.

​
Endpoint

GET /v1/accounts/:accountId/users/custom/:customId

​
Authentication

Bearer token required.

​
Path Parameters

​
customId
string
required
The custom identifier assigned when the user was created.

​
Query Parameters

​
roomId
string
required
The room ID the user belongs to. Required to route the request to the correct Durable Object.

​
Response

Returns the same response format as Get User.
​
user
CollabKitUser
The user object. See CollabKitUser.
​
sessions
CollabKitUserSession[]
The user’s session history. See CollabKitUserSession.

​
Example

curl "https://api.collab-kit.com/v1/accounts/${ACCOUNT_ID}/users/custom/alice-001?roomId=c3003c93-60cf-4184-b85f-20be14d26dac" \
  -H "Authorization: Bearer ${TOKEN}"
Response
{
  "type": "response",
  "success": true,
  "description": "User retrieved",
  "data": {
    "user": {
      "id": "f47ac10b-58cc-4372-...",
      "room_id": "c3003c93-...",
      "name": "Alice",
      "profile_picture": "https://example.com/alice.png",
      "custom_id": "alice-001",
      "status": "online",
      "created_at": "2026-05-29T10:05:00.000Z",
      "joined_at": "2026-05-29T10:06:00.000Z",
      "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
    },
    "sessions": [
      {
        "id": "sess_001",
        "user_id": "f47ac10b-58cc-4372-...",
        "room_id": "c3003c93-...",
        "joined_at": "2026-05-29T10:06:00.000Z",
        "left_at": null
      }
    ]
  },
  "error": null
}
If no user matches the given customId within the specified room, the API returns a 404 NOT_FOUND error.