Endpoint: Dynamically Fetching a User

Endpoint: Dynamically Fetching a User
January, 2025
POST /api/integration/rest/v1/users/:id/expand

This endpoint lets fetch a user by its id. More information about the user can be obtained.

Request body

A list of keywords can be provided with the expand property in the request body. For each keyword provided, extra information about the user will be returned in the response.

{
  expand: ("activeAfter" | "activeAfter")[];
}

Response

By default, a "detailed" user object will be returned. Additional properties can will be added on top of the detailed object.

Detailed & {
  activeAfter?: number | null; // seconds
  activeBefore?: number | null; // seconds
}
  • activeAfter: The date after which the user is able to log into their account under the main organization.
    • activeBefore: The date until which the user is able to log into their account under the main organization.
      Go Back
      Talk to a representative
      Figure out if TestInvite is a good match for your organization
      Book a demo