v1

latestOpenAPI 3.0.32026-07-13182371.7 KB
API Token

Get all API tokens in an org

Gets all user API tokens in an organization.

Scopes

Authorization scopes required: read:tokens:admin

get/orgs/{orgId}/api-tokens

Path parameters

orgIdstring required

Your organization is identified by a Unique ID. You get your organization ID and organization API key simultaneously.

Query parameters

qstring

Free text search filter to be applied to API token results. Query will be applied using a fuzzy, case-insensitive search. Will target token label, user.name, and user.email.

status'allowed' | 'blocked'

Filter the API tokens by status to retrieve tokens of a specific type.

createdAtSearchType'range' | 'gt' | 'lt' | 'range_time'

Filter the API tokens by creation date. This parameter is required if searching on creation date. Depending on search type provided, additional parameters shall be supplied.

createdAtUom'day' | 'hour' | 'minute' | 'week'

Filter the API tokens by creation date. Unit of measure represents the scale of time for window search. This parameter is required if searching on creation date using gt or lt search.

createdAtValueinteger

Filter the API tokens by creation date. This represents the value of time scale for window search. This parameter is required if searching on creation date using gt or lt search.

createdAtFromstring ISO 8601

Filter the API tokens by creation date. This represents the starting timestamp for a window search. Either this parameter or createdAtTo is required if searching on creation date using range search.

createdAtTostring ISO 8601

Filter the API tokens by creation date. This represents the ending timestamp for a window search. Either this parameter or createdAtFrom is required if searching on creation date using range search.

createdAtRangeFromstring 1w 2d 3h 4m

Filter the API tokens by creation date range. This represents the starting relative time window for a range time search. Either this parameter is or createdAtRangeTo is required if searching on creation date using range_time search.<br/><br/>Note: Range time windows use the format 1w 2d 3h 4m where w -> weeks, d -> days, h -> hours, m -> minutes. Look-back is possible with the use of -, ex: -3w to indicate "3 weeks ago." Values are optional and must be presented in descending order.

createdAtRangeTostring 1w 2d 3h 4m

Filter the API tokens by creation date range. This represents the ending relative time window for a range time search. Either this parameter is or createdAtRangeFrom is required if searching on creation date using range_time search.<br/><br/>Note: Range time windows use the format 1w 2d 3h 4m where w -> weeks, d -> days, h -> hours, m -> minutes. Look-back is possible with the use of -, ex: -3w to indicate "3 weeks ago." Values are optional and must be presented in descending order.

lastActiveAtSearchType'range' | 'gt' | 'lt' | 'range_time'

Filter the API tokens by last active date. This parameter is required if searching on last active date. Depending on search type provided, additional parameters shall be supplied.

lastActiveAtUom'day' | 'hour' | 'minute' | 'week'

Filter the API tokens by last active date. Unit of measure represents the scale of time for window search. This parameter is required if searching on last active date using gt or lt search.

lastActiveAtValueinteger

Filter the API tokens by last active date. This represents the value of time scale for window search. This parameter is required if searching on last active date using gt or lt search.

lastActiveAtFromstring ISO 8601

Filter the API tokens by last active date. This represents the starting timestamp for a window search. Either this parameter or lastActiveAtTo is required if searching on last active date using range search.

lastActiveAtTostring ISO 8601

Filter the API tokens by last active date. This represents the ending timestamp for a window search. Either this parameter or lastActiveAtFrom is required if searching on last active date using range search.

lastActiveAtRangeFromstring 1w 2d 3h 4m

Filter the API tokens by last active date range. This represents the starting relative time window for a range time search. Either this parameter is or lastActiveAtRangeTo is required if searching on last active date using range_time search.<br/><br/>Note: Range time windows use the format 1w 2d 3h 4m where w -> weeks, d -> days, h -> hours, m -> minutes. Look-back is possible with the use of -, ex: -3w to indicate "3 weeks ago." Values are optional and must be presented in descending order.

lastActiveAtRangeTostring 1w 2d 3h 4m

Filter the API tokens by last active date range. This represents the ending relative time window for a range time search. Either this parameter is or lastActiveAtRangeFrom is required if searching on last active date using range_time search.<br/><br/>Note: Range time windows use the format 1w 2d 3h 4m where w -> weeks, d -> days, h -> hours, m -> minutes. Look-back is possible with the use of -, ex: -3w to indicate "3 weeks ago." Values are optional and must be presented in descending order.

sort'label' | '-label' | 'user.name' | '-user.name' | 'createdAt' | '-createdAt' | 'expiresAt' | '-expiresAt' | 'lastActiveAt' | '-lastActiveAt' [-|+]<field>, ...

Sort the API tokens based on the following criteria: ascending is represented with + as the first character (optional); descending is represented with - as the first character. Multiple values may be supplied as a comma-separated list.

pageSizeinteger

Select the number of records to include in the results.

cursorstring

Navigate to a specific page of paginated results. In a given response, it may include a self, next, and prev cursor to fetch the respective set of paginated results. The cursor only encodes the sort value and record ID — it does not encode filters, sort order, or page size.<br/><br/>Note: You must continue to pass all other parameters (filters, sort, pageSize) on every request alongside the cursor.

Response

Returned if the request is successful.

All 18 operations