External Users

post

Authenticates an external user.

Header parameters

authorizationstringRequired

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

Body

channelIdstring · uuidRequired

A UUID v4 string that identifies an entity.

externalIdstring · nullableRequired

idstring · uuid · nullableRequired

A UUID v4 string that identifies an entity.

identifierstring · nullableRequired

Responses

200

The external user was authenticated and access token generated.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired

blockedbooleanRequired

Whether the external user is blocked.

channelIdstring · uuidRequired

The ID of the channel associated with the external user.

externalIdstring · min: 3 · max: 250 · nullableRequired

External reference in the integrated system.

externalUserGroupIdstring · uuid · nullableRequired

The ID of the external user group associated with the external user.

identifierstring · nullableRequired

A unique identifier of the external user (usernames, emails, phone numbers and etc).

namestring · min: 3 · max: 50 · nullableRequired

The display name of the external user.

superIdentityIdstring · uuidRequired

The ID of the super identity associated with the external user.

tierIdstring · uuid · nullableRequired

The ID of the tier associated with the external user.

workspaceIdstring · uuidRequired

The ID of the workspace associated with the external user.

accessTokenstringRequired

400

Invalid data provided.

application/json

401

Unauthorized.

application/json

404

Channel not found.

application/json

post

/api/v1/external-users/authenticate

POST /api/v1/external-users/authenticate HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "externalId": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "identifier": "text"
}

{
  "createdAt": "2026-06-11T20:43:07.698Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2026-06-11T20:43:07.698Z",
  "blocked": true,
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "externalId": "text",
  "externalUserGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "identifier": "text",
  "name": "text",
  "superIdentityId": "123e4567-e89b-12d3-a456-426614174000",
  "tierId": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "accessToken": "text"
}

get

Retrieves multiple external users.

Query parameters

channelIdsany ofOptionalDefault: []

string · uuid[]Optional

A UUID v4 string that identifies an entity.

string · uuidOptional

A UUID v4 string that identifies an entity.

externalUserGroupIdsany ofOptionalDefault: []

string · uuid[]Optional

A UUID v4 string that identifies an entity.

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

searchstringOptional

superIdentityIdsany ofOptionalDefault: []

string · uuid[]Optional

A UUID v4 string that identifies an entity.

string · uuidOptional

A UUID v4 string that identifies an entity.

tierIdsany ofOptionalDefault: []

string · uuid[]Optional

A UUID v4 string that identifies an entity.

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 users for the workspace.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired

blockedbooleanRequired

Whether the external user is blocked.

channelIdstring · uuidRequired

The ID of the channel associated with the external user.

externalIdstring · min: 3 · max: 250 · nullableRequired

External reference in the integrated system.

externalUserGroupIdstring · uuid · nullableRequired

The ID of the external user group associated with the external user.

identifierstring · nullableRequired

A unique identifier of the external user (usernames, emails, phone numbers and etc).

namestring · min: 3 · max: 50 · nullableRequired

The display name of the external user.

superIdentityIdstring · uuidRequired

The ID of the super identity associated with the external user.

tierIdstring · uuid · nullableRequired

The ID of the tier associated with the external user.

workspaceIdstring · uuidRequired

The ID of the workspace associated with the external user.

400

Bad Request.

application/json

401

Unauthorized.

application/json

get

/api/v1/external-users

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

[
  {
    "createdAt": "2026-06-11T20:43:07.698Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "updatedAt": "2026-06-11T20:43:07.698Z",
    "blocked": true,
    "channelId": "123e4567-e89b-12d3-a456-426614174000",
    "externalId": "text",
    "externalUserGroupId": "123e4567-e89b-12d3-a456-426614174000",
    "identifier": "text",
    "name": "text",
    "superIdentityId": "123e4567-e89b-12d3-a456-426614174000",
    "tierId": "123e4567-e89b-12d3-a456-426614174000",
    "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
  }
]

post

Creates a new external user.

Header parameters

authorizationstringRequired

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

Body

channelIdstring · uuidRequired

The ID of the channel associated with the external user.

externalIdstring · min: 3 · max: 250 · nullableRequired

External reference in the integrated system.

externalUserGroupIdstring · uuid · nullableRequired

The ID of the external user group associated with the external user.

identifierstring · nullableRequired

A unique identifier of the external user (usernames, emails, phone numbers and etc).

namestring · min: 3 · max: 50 · nullableRequired

The display name of the external user.

tierIdstring · uuid · nullableRequired

The ID of the tier associated with the external user.

Responses

200

The external user was created and access token generated.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired

blockedbooleanRequired

Whether the external user is blocked.

channelIdstring · uuidRequired

The ID of the channel associated with the external user.

externalIdstring · min: 3 · max: 250 · nullableRequired

External reference in the integrated system.

externalUserGroupIdstring · uuid · nullableRequired

The ID of the external user group associated with the external user.

identifierstring · nullableRequired

A unique identifier of the external user (usernames, emails, phone numbers and etc).

namestring · min: 3 · max: 50 · nullableRequired

The display name of the external user.

superIdentityIdstring · uuidRequired

The ID of the super identity associated with the external user.

tierIdstring · uuid · nullableRequired

The ID of the tier associated with the external user.

workspaceIdstring · uuidRequired

The ID of the workspace associated with the external user.

400

Invalid data provided.

application/json

401

Unauthorized.

application/json

404

Channel not found.

application/json

post

/api/v1/external-users

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

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

{
  "createdAt": "2026-06-11T20:43:07.698Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2026-06-11T20:43:07.698Z",
  "blocked": true,
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "externalId": "text",
  "externalUserGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "identifier": "text",
  "name": "text",
  "superIdentityId": "123e4567-e89b-12d3-a456-426614174000",
  "tierId": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
}

get

Retrieves an external user.

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.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired

blockedbooleanRequired

Whether the external user is blocked.

channelIdstring · uuidRequired

The ID of the channel associated with the external user.

externalIdstring · min: 3 · max: 250 · nullableRequired

External reference in the integrated system.

externalUserGroupIdstring · uuid · nullableRequired

The ID of the external user group associated with the external user.

identifierstring · nullableRequired

A unique identifier of the external user (usernames, emails, phone numbers and etc).

namestring · min: 3 · max: 50 · nullableRequired

The display name of the external user.

superIdentityIdstring · uuidRequired

The ID of the super identity associated with the external user.

tierIdstring · uuid · nullableRequired

The ID of the tier associated with the external user.

workspaceIdstring · uuidRequired

The ID of the workspace associated with the external user.

401

Unauthorized.

application/json

404

External user not found.

application/json

get

/api/v1/external-users/{id}

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

{
  "createdAt": "2026-06-11T20:43:07.698Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2026-06-11T20:43:07.698Z",
  "blocked": true,
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "externalId": "text",
  "externalUserGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "identifier": "text",
  "name": "text",
  "superIdentityId": "123e4567-e89b-12d3-a456-426614174000",
  "tierId": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
}

patch

Updates an external user.

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

blockedbooleanOptional

Whether the external user is blocked.

externalIdstring · min: 3 · max: 250 · nullableOptional

External reference in the integrated system.

externalUserGroupIdstring · uuid · nullableOptional

The ID of the external user group associated with the external user.

identifierstring · nullableOptional

A unique identifier of the external user (usernames, emails, phone numbers and etc).

namestring · min: 3 · max: 50 · nullableOptional

The display name of the external user.

tierIdstring · uuid · nullableOptional

The ID of the tier associated with the external user.

Responses

200

The external user was updated.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired

blockedbooleanRequired

Whether the external user is blocked.

channelIdstring · uuidRequired

The ID of the channel associated with the external user.

externalIdstring · min: 3 · max: 250 · nullableRequired

External reference in the integrated system.

externalUserGroupIdstring · uuid · nullableRequired

The ID of the external user group associated with the external user.

identifierstring · nullableRequired

A unique identifier of the external user (usernames, emails, phone numbers and etc).

namestring · min: 3 · max: 50 · nullableRequired

The display name of the external user.

superIdentityIdstring · uuidRequired

The ID of the super identity associated with the external user.

tierIdstring · uuid · nullableRequired

The ID of the tier associated with the external user.

workspaceIdstring · uuidRequired

The ID of the workspace associated with the external user.

400

Invalid data provided.

application/json

401

Unauthorized.

application/json

404

External user not found.

application/json

patch

/api/v1/external-users/{id}

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

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

{
  "createdAt": "2026-06-11T20:43:07.698Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2026-06-11T20:43:07.698Z",
  "blocked": true,
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "externalId": "text",
  "externalUserGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "identifier": "text",
  "name": "text",
  "superIdentityId": "123e4567-e89b-12d3-a456-426614174000",
  "tierId": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
}

PreviousExternal User Groups NextLLM Providers

Last updated 1 hour ago