Endpoint: Fetching a User

Endpoint: Fetching a User
January, 2025
GET /api/integration/rest/v1/users/:id

This endpoint lets you fetch one user under your organization using its ID. 

Query ParametersExpected ValueDefault
mode"basic" | "detailed""basic"

With the "mode" parameter, you can choose to receive a smaller or a bigger object for each user, depending on your needs.

If the value of mode is "basic", the user object in the response will be in this type:

// "basic" user object:
{
  userId: string;
  createdAt: number; // seconds
  username: string;
  fullname?: string; // might not exist in user
  email?: string; // might not exist in user
}

If the value of mode is "detailed", you will receive all of the properties from "basic" and also these properties:

// "detailed" user object:
Basic & {
  organizationId: string;
  folder: string;
  tags: Record
  labels: string[];
  group: string;
  favorite: boolean;
  active: boolean;
  roles: "MANAGER" | "EDITOR" | "OPERATOR" | "USER" | "JOKER" | "QUESTIONBANKSUPERVISOR" | "QUESTIONBANKSUBMITTER"[];
}
Go Back
Talk to a representative
Figure out if TestInvite is a good match for your organization
Book a demo