External User Groups

get

Retrieves multiple external user groups.

Query parameters

externalIdstringOptional

idsany ofOptionalDefault: []

string · uuid[]Optional

A UUID v4 string that identifies an entity.

or

string · uuidOptional

A UUID v4 string that identifies an entity.

pageNumbernumber · min: 1Optional

The page number.

Default: 1

pageSizenumber · min: 1 · max: 100Optional

The page size.

Default: 10

searchstring · min: 1Optional

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

tierIdsany ofOptionalDefault: []

string · uuid[]Optional

A UUID v4 string that identifies an entity.

or

string · uuidOptional

A UUID v4 string that identifies an entity.

Header parameters

authorizationstringRequired

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

Responses

200

Retrieves all external user groups for the workspace.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired

externalIdstring · min: 3 · max: 250 · nullableRequired

External reference in the integrated system.

namestring · min: 3 · max: 50 · nullableRequired

The display name of the external user group.

tierIdstring · uuid · nullableRequired

The tier associated with the external user group.

workspaceIdstring · uuidRequired

The workspace that owns the external user group.

401

Unauthorized.

application/json

get

/api/v1/external-user-groups

HTTPcURLJavaScriptPython

GET /api/v1/external-user-groups HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*

[
  {
    "createdAt": "2026-06-11T20:42:17.074Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "updatedAt": "2026-06-11T20:42:17.074Z",
    "externalId": "text",
    "name": "text",
    "tierId": "123e4567-e89b-12d3-a456-426614174000",
    "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
  }
]

post

Creates a new external user group.

Header parameters

authorizationstringRequired

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

Body

application/json

externalIdstring · min: 3 · max: 250 · nullableRequired

External reference in the integrated system.

namestring · min: 3 · max: 50 · nullableRequired

The display name of the external user group.

tierIdstring · uuid · nullableRequired

The tier associated with the external user group.

Responses

200

The external user group was created.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired

externalIdstring · min: 3 · max: 250 · nullableRequired

External reference in the integrated system.

namestring · min: 3 · max: 50 · nullableRequired

The display name of the external user group.

tierIdstring · uuid · nullableRequired

The tier associated with the external user group.

workspaceIdstring · uuidRequired

The workspace that owns the external user group.

401

Unauthorized.

application/json

404

Tier not found.

application/json

409

External user group external id already exists in this workspace.

application/json

post

/api/v1/external-user-groups

HTTPcURLJavaScriptPython

POST /api/v1/external-user-groups HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "externalId": "text",
  "name": "text",
  "tierId": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "createdAt": "2026-06-11T20:42:17.074Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2026-06-11T20:42:17.074Z",
  "externalId": "text",
  "name": "text",
  "tierId": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
}

get

Retrieves an external user group.

Path parameters

idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters

authorizationstringRequired

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

Responses

200

Retrieves an external user group.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired

externalIdstring · min: 3 · max: 250 · nullableRequired

External reference in the integrated system.

namestring · min: 3 · max: 50 · nullableRequired

The display name of the external user group.

tierIdstring · uuid · nullableRequired

The tier associated with the external user group.

workspaceIdstring · uuidRequired

The workspace that owns the external user group.

401

Unauthorized.

application/json

404

External user group not found.

application/json

get

/api/v1/external-user-groups/{id}

HTTPcURLJavaScriptPython

GET /api/v1/external-user-groups/{id} HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*

{
  "createdAt": "2026-06-11T20:42:17.074Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2026-06-11T20:42:17.074Z",
  "externalId": "text",
  "name": "text",
  "tierId": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
}

delete

Removes an external user group.

Path parameters

idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters

authorizationstringRequired

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

Responses

200

The external user group was removed.

application/json

messagestringRequired

An informative message for a call that has no effective result to be returned.

401

Unauthorized.

application/json

404

External user group not found.

application/json

delete

/api/v1/external-user-groups/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/external-user-groups/{id} HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*

{
  "message": "text"
}

patch

Updates an external user group.

Path parameters

idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters

authorizationstringRequired

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

Body

application/json

externalIdstring · min: 3 · max: 250 · nullableOptional

External reference in the integrated system.

namestring · min: 3 · max: 50 · nullableOptional

The display name of the external user group.

tierIdstring · uuid · nullableOptional

The tier associated with the external user group.

Responses

200

The external user group was updated.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired

externalIdstring · min: 3 · max: 250 · nullableRequired

External reference in the integrated system.

namestring · min: 3 · max: 50 · nullableRequired

The display name of the external user group.

tierIdstring · uuid · nullableRequired

The tier associated with the external user group.

workspaceIdstring · uuidRequired

The workspace that owns the external user group.

401

Unauthorized.

application/json

404

External user group or tier not found.

application/json

409

External user group external id already exists in this workspace.

application/json

patch

/api/v1/external-user-groups/{id}

HTTPcURLJavaScriptPython

PATCH /api/v1/external-user-groups/{id} HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "externalId": "text",
  "name": "text",
  "tierId": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "createdAt": "2026-06-11T20:42:17.074Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2026-06-11T20:42:17.074Z",
  "externalId": "text",
  "name": "text",
  "tierId": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
}