Retrieve a user

​

Returns the user with this user_id, or 404 NOT_FOUND when your organization has no user with this id; another organization's id and a deleted user return 404 too. An id that is not a UUID returns 400 VALIDATION_ERROR.

GET /v2/users/{user_id} can take a few seconds to reflect a create, change or delete; until then you can get 404 or the previous version. A create or update response is the current record, so use it instead of fetching the user again.

Path Parameters

  • user_id
    Type: stringFormat: uuid
    required

    The id of the user.

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/v2/users/{user_id}
import BrelliumClient from '@brellium/api-client';

const client = new BrelliumClient({
  oAuth2: process.env['BRELLIUM_ACCESS_TOKEN'], // defaults to the BRELLIUM_ACCESS_TOKEN env var
});

const user = await client.users.retrieve('7c6d5e4f-3a2b-4c1d-9e8f-7a6b5c4d3e2f');

console.log(user);

{
  "user_id": "7c6d5e4f-3a2b-4c1d-9e8f-7a6b5c4d3e2f",
  "object": "user",
  "name": "Jordan Rivera",
  "email": "jordan.rivera@clinic.example",
  "attributes": {
    "title": "BCBA"
  },
  "person_id": "2a1b0c9d-8e7f-4a6b-9c5d-4e3f2a1b0c9d",
  "created_at": "2026-09-01T12:00:00.000Z",
  "updated_at": "2026-09-01T12:00:00.000Z"
}

The user.

Previous
Update many users
Next
Update a user