Appearance

List Users ​

Endpoint ​

http
GET /unified/usage-metering/users
Integrations supported
  • Claude
  • OpenAI Codex
  • Cursor

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
  • debug
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
date
string · date

Date for which to retrieve records, in YYYY-MM-DD format. If omitted, the date from 3 days ago is used by default.

Supported in
  • Claude
email
string · email

Filter users by email address (exact match).

Supported in
  • Claude

Response Body ​

result
object[]

List of Users

id
string
REQUIRED · 

Unique identifier for the user inside the source application.

Supported in
  • Claude
  • OpenAI Codex
  • Cursor
first_name
string

The first name of the user

last_name
string

The last name of the user

name
string
REQUIRED · 

Display name of the user.

Supported in
  • Claude
  • OpenAI Codex
  • Cursor
emails
object[]

Email addresses of the user.

Supported in
  • Claude
  • OpenAI Codex
  • Cursor
email
string

Email address.

is_primary
boolean

Whether this is the primary email.

roles
object[]

The roles the user has.

Supported in
  • OpenAI Codex
  • Cursor
id
string

The role's unique identifier.

name
string

The role's name.

status
string

The status of the user. If no clear mapping is available, then the raw value is returned.

All possible enum values:
  • active
  • inactive
  • deleted
  • invited
Supported in
  • Claude
  • OpenAI Codex
  • Cursor
organization
object

The organization / team / workspace the user belongs to.

id
string
name
string
spend_limit
object

Per-user spending limit configured in the source application.

amount
number

Spending limit amount (smallest currency unit).

currency
string

ISO 4217 currency code.

last_active_at
string · date-time
created_at
string · date-time
Supported in
  • OpenAI Codex
updated_at
string · date-time
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.

debug
object

Present only when truto_response_format=debug. Contains raw fetch details: requestUrl, requestOptions, data, responseHeaders, nextCursor, isLooping, isEmptyResult, resultCount. null for static responses or when truto_skip_api_call=true.

requestUrl
string
requestOptions
object
data
responseHeaders
object
nextCursor
string
isLooping
boolean
isEmptyResult
boolean
resultCount
number