Sign in

v1

latestOpenAPI 3.1.02026-07-23310383.1 KB
External User Groups

Retrieves multiple external user groups.

get/api/v1/external-user-groups

Query parameters

externalIdstring
string[]
OR
string uuid

A UUID v4 string that identifies an entity.

pageNumbernumber

The page number.

The page number.

pageSizenumber

The page size.

The page size.

searchstring

Search term to filter external user groups by name or external ids.

Search term to filter external user groups by name or external ids.

string[]
OR
string uuid

A UUID v4 string that identifies an entity.

Headers

authorizationstring required

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Response

Retrieves all external user groups for the workspace.

createdAtstring date-time required
idstring uuid required

A UUID v4 string that identifies an entity.

updatedAtstring date-time required
externalIdstring nullable required

External reference in the integrated system.

namestring nullable required

The display name of the external user group.

tierIdstring uuid nullable required

The tier associated with the external user group.

workspaceIdstring uuid required

The workspace that owns the external user group.