Pular para o conteúdo
ZaiaZaiaZaia

/api/v1/external-user-groups (GET)

GET
/api/v1/external-user-groups
curl --request GET \
  --url 'https://api.endless.zaia.app/api/v1/external-user-groups?pageNumber=1&pageSize=10'

Retrieves multiple external user groups.

Parameters

Seção intitulada “Parameters”

Query Parameters

Seção intitulada “Query Parameters”
externalId
string
ids
Any of:
Array<string>
pageNumber

The page number.

number
default: 1 >= 1

The page number.

pageSize

The page size.

number
default: 10 >= 1 <= 100

The page size.

search

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

string
>= 1 characters

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

tierIds
Any of:
Array<string>

Responses

Seção intitulada “Responses”

200

Seção intitulada “200”

Retrieves all external user groups for the workspace.

Media typeapplication/json
Array<object>
object
createdAt
required
string format: date-time
id
required

A UUID v4 string that identifies an entity.

string format: uuid
updatedAt
required
string format: date-time
externalId
required

External reference in the integrated system.

string
nullable >= 3 characters <= 250 characters
name
required

The display name of the external user group.

string
nullable >= 3 characters <= 50 characters
tierId
required

The tier associated with the external user group.

string format: uuid
nullable
workspaceId
required

The workspace that owns the external user group.

string format: uuid
Examplegenerated
[
  {
    "createdAt": "2026-04-15T12:00:00Z",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "updatedAt": "2026-04-15T12:00:00Z",
    "externalId": "example",
    "name": "example",
    "tierId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "workspaceId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  }
]

401

Seção intitulada “401”

Unauthorized.

Media typeapplication/json

The description of a known exception.

object
code

The error code.

string
cta

The error call-to-action.

object
type
required
string
Allowed values: support-contact
url
required
string format: uri
feedback
required

The error feedback.

object
enUs
string
esEs
string
ptBr
string
message
required

The error message.

string
name
required

The error name.

string
Example
{
  "cta": {
    "type": "support-contact"
  }
}