Ticketing Teams

get

Retrieves multiple ticketing teams.

Query parameters

joinsany ofOptionalDefault: []

or

string · enumOptionalPossible values:

pageNumbernumber · min: 1Optional

The page number.

Default: 1

pageSizenumber · min: 1 · max: 100Optional

The page size.

Default: 10

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

application/json

or

401

Unauthorized.

application/json

get/api/v1/ticketing-teams

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

[
  {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isRemoved": true,
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "description": "text",
    "name": "text",
    "picture": "text",
    "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
    "tools": [
      {
        "createdAt": "2026-01-01T00:00:00.000Z",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "isRemoved": true,
        "referenceId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2026-01-01T00:00:00.000Z",
        "versionId": "123e4567-e89b-12d3-a456-426614174000",
        "description": "text",
        "detail": {
          "allowedDomains": [
            "text"
          ],
          "effort": "low",
          "execution": "eligible",
          "llmProviderId": "123e4567-e89b-12d3-a456-426614174000",
          "prompt": "text",
          "type": "agentic-web-search"
        },
        "lastExecutedAt": "2026-01-01T00:00:00.000Z",
        "name": "text",
        "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
        "agentTools": [
          {
            "createdAt": "2026-01-01T00:00:00.000Z",
            "updatedAt": "2026-01-01T00:00:00.000Z",
            "agentId": "123e4567-e89b-12d3-a456-426614174000",
            "toolId": "123e4567-e89b-12d3-a456-426614174000",
            "agent": {
              "createdAt": "2026-01-01T00:00:00.000Z",
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "isRemoved": true,
              "referenceId": "123e4567-e89b-12d3-a456-426614174000",
              "updatedAt": "2026-01-01T00:00:00.000Z",
              "versionId": "123e4567-e89b-12d3-a456-426614174000",
              "codeRuntime": true,
              "internalName": "text",
              "iterations": 1,
              "lastExecutedAt": "2026-01-01T00:00:00.000Z",
              "llm": "claude-haiku-4-5",
              "llmProviderId": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "picture": "text",
              "planning": true,
              "prompt": "text",
              "reasoningMode": "low",
              "role": "text",
              "superIdentityId": "123e4567-e89b-12d3-a456-426614174000",
              "temperature": 1,
              "timezone": "Africa/Cairo",
              "toolCount": 1,
              "voiceId": "123e4567-e89b-12d3-a456-426614174000",
              "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
            }
          }
        ]
      }
    ]
  }
]

post

Creates a new ticketing team.

Header parameters

authorizationstringRequired

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

Body

descriptionstring · min: 3 · max: 250 · nullableRequired

The internal description of the ticketing team.

namestring · min: 3 · max: 50Required

The display name of the ticketing team.

picturestring · nullableRequired

The picture associated with the ticketing team.

Responses

200

The ticketing team was created.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired

updatedAtstring · date-timeRequired

descriptionstring · min: 3 · max: 250 · nullableRequired

The internal description of the ticketing team.

namestring · min: 3 · max: 50Required

The display name of the ticketing team.

picturestring · nullableRequired

The picture associated with the ticketing team.

workspaceIdstring · uuidRequired

The workspace ID that owns the ticketing team.

401

Unauthorized.

application/json

post/api/v1/ticketing-teams

POST /api/v1/ticketing-teams HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "description": "text",
  "name": "text",
  "picture": "text"
}

{
  "createdAt": "2026-01-01T00:00:00.000Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isRemoved": true,
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "description": "text",
  "name": "text",
  "picture": "text",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
}

get

Retrieves multiple users in a ticketing team.

Path parameters

ticketingTeamIdstring · uuidRequired

A UUID v4 string that identifies an entity.

Query parameters

joinsany ofOptionalDefault: []

or

string · enumOptionalPossible values:

pageNumbernumber · min: 1Optional

The page number.

Default: 1

pageSizenumber · min: 1 · max: 100Optional

The page size.

Default: 10

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 ticketing team users.

application/json

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

activeTicketsintegerRequired

roundRobinDistributioninteger · max: 100Required

statusstring · enumRequiredPossible values:

ticketingTeamIdstring · uuidRequired

A UUID v4 string that identifies an entity.

userIdstring · uuidRequired

A UUID v4 string that identifies an entity.

401

Unauthorized.

application/json

404

Ticketing team not found.

application/json

get/api/v1/ticketing-teams/{ticketingTeamId}/users

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

[
  {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "activeTickets": 1,
    "roundRobinDistribution": 1,
    "status": "active",
    "ticketingTeamId": "123e4567-e89b-12d3-a456-426614174000",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "user": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "authVersion": 1,
      "brandId": "123e4567-e89b-12d3-a456-426614174000",
      "canonicalUserId": "123e4567-e89b-12d3-a456-426614174000",
      "clientReferenceId": "text",
      "email": "[e-mail]",
      "emailNormalized": "text",
      "emailStatus": "pending",
      "firstAccessAt": "2026-01-01T00:00:00.000Z",
      "gtm": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "language": "enUs",
      "lastAuthenticationAt": "2026-01-01T00:00:00.000Z",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "name": "text",
      "partnerId": "123e4567-e89b-12d3-a456-426614174000",
      "phoneNumber": "text",
      "picture": "text",
      "superIdentityId": "123e4567-e89b-12d3-a456-426614174000",
      "whiteLabelId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "workspaceUser": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "inviteStatus": "pending",
      "isRemoved": true,
      "role": "member",
      "ticketingAvailability": "available",
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
    }
  }
]

post

Creates new users or attaches existing ones to a ticketing team.

Path parameters

ticketingTeamIdstring · 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

userIdstring · uuidRequired

A UUID v4 string that identifies an entity.

Responses

200

The ticketing team user was created.

application/json

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

activeTicketsintegerRequired

roundRobinDistributioninteger · max: 100Required

statusstring · enumRequiredPossible values:

ticketingTeamIdstring · uuidRequired

A UUID v4 string that identifies an entity.

userIdstring · uuidRequired

A UUID v4 string that identifies an entity.

400

Round robin distribution does not total exactly 100%.

application/json

401

Unauthorized.

application/json

404

Ticketing team or user not found.

application/json

412

User is already a member of this ticketing team.

application/json

post/api/v1/ticketing-teams/{ticketingTeamId}/users

POST /api/v1/ticketing-teams/{ticketingTeamId}/users HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "userId": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "activeTickets": 1,
  "roundRobinDistribution": 1,
  "status": "active",
  "ticketingTeamId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000"
}

patch

Updates multiple users in a ticketing team.

Path parameters

ticketingTeamIdstring · 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

Responses

200

The ticketing team users were updated.

application/json

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

activeTicketsintegerRequired

roundRobinDistributioninteger · max: 100Required

statusstring · enumRequiredPossible values:

ticketingTeamIdstring · uuidRequired

A UUID v4 string that identifies an entity.

userIdstring · uuidRequired

A UUID v4 string that identifies an entity.

400

Round robin distribution does not total exactly 100%.

application/json

401

Unauthorized.

application/json

404

Ticketing team or user not found.

application/json

patch/api/v1/ticketing-teams/{ticketingTeamId}/users

PATCH /api/v1/ticketing-teams/{ticketingTeamId}/users HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "users": [
    {
      "roundRobinDistribution": 1,
      "status": "active",
      "userId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

[
  {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "activeTickets": 1,
    "roundRobinDistribution": 1,
    "status": "active",
    "ticketingTeamId": "123e4567-e89b-12d3-a456-426614174000",
    "userId": "123e4567-e89b-12d3-a456-426614174000"
  }
]

get

Retrieves a ticketing team.

Path parameters

idstring · uuidRequired

A UUID v4 string that identifies an entity.

Query parameters

joinsany ofOptionalDefault: []

or

string · enumOptionalPossible values:

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 a ticketing team.

application/json

or

401

Unauthorized.

application/json

404

Ticketing team not found.

application/json

get/api/v1/ticketing-teams/{id}

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

{
  "createdAt": "2026-01-01T00:00:00.000Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isRemoved": true,
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "description": "text",
  "name": "text",
  "picture": "text",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "tools": [
    {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isRemoved": true,
      "referenceId": "123e4567-e89b-12d3-a456-426614174000",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "versionId": "123e4567-e89b-12d3-a456-426614174000",
      "description": "text",
      "detail": {
        "allowedDomains": [
          "text"
        ],
        "effort": "low",
        "execution": "eligible",
        "llmProviderId": "123e4567-e89b-12d3-a456-426614174000",
        "prompt": "text",
        "type": "agentic-web-search"
      },
      "lastExecutedAt": "2026-01-01T00:00:00.000Z",
      "name": "text",
      "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
      "agentTools": [
        {
          "createdAt": "2026-01-01T00:00:00.000Z",
          "updatedAt": "2026-01-01T00:00:00.000Z",
          "agentId": "123e4567-e89b-12d3-a456-426614174000",
          "toolId": "123e4567-e89b-12d3-a456-426614174000",
          "agent": {
            "createdAt": "2026-01-01T00:00:00.000Z",
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "isRemoved": true,
            "referenceId": "123e4567-e89b-12d3-a456-426614174000",
            "updatedAt": "2026-01-01T00:00:00.000Z",
            "versionId": "123e4567-e89b-12d3-a456-426614174000",
            "codeRuntime": true,
            "internalName": "text",
            "iterations": 1,
            "lastExecutedAt": "2026-01-01T00:00:00.000Z",
            "llm": "claude-haiku-4-5",
            "llmProviderId": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "picture": "text",
            "planning": true,
            "prompt": "text",
            "reasoningMode": "low",
            "role": "text",
            "superIdentityId": "123e4567-e89b-12d3-a456-426614174000",
            "temperature": 1,
            "timezone": "Africa/Cairo",
            "toolCount": 1,
            "voiceId": "123e4567-e89b-12d3-a456-426614174000",
            "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
          }
        }
      ]
    }
  ]
}

delete

Removes a ticketing team.

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 ticketing team was removed.

application/json

messagestringRequired

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

401

Unauthorized.

application/json

404

Ticketing team not found.

application/json

delete/api/v1/ticketing-teams/{id}

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

{
  "message": "text"
}

patch

Updates a ticketing team.

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

descriptionstring · min: 3 · max: 250 · nullableOptional

The internal description of the ticketing team.

namestring · min: 3 · max: 50Optional

The display name of the ticketing team.

picturestring · nullableOptional

The picture associated with the ticketing team.

Responses

200

The ticketing team was updated.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired

updatedAtstring · date-timeRequired

descriptionstring · min: 3 · max: 250 · nullableRequired

The internal description of the ticketing team.

namestring · min: 3 · max: 50Required

The display name of the ticketing team.

picturestring · nullableRequired

The picture associated with the ticketing team.

workspaceIdstring · uuidRequired

The workspace ID that owns the ticketing team.

401

Unauthorized.

application/json

404

Ticketing team not found.

application/json

patch/api/v1/ticketing-teams/{id}

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

{
  "description": "text",
  "name": "text",
  "picture": "text"
}

{
  "createdAt": "2026-01-01T00:00:00.000Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isRemoved": true,
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "description": "text",
  "name": "text",
  "picture": "text",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
}

delete

Detaches a user from a ticketing team.

Path parameters

ticketingTeamIdstring · uuidRequired

A UUID v4 string that identifies an entity.

userIdstring · 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 ticketing team user was removed.

application/json

messagestringRequired

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

401

Unauthorized.

application/json

404

Ticketing team user relationship not found.

application/json

delete/api/v1/ticketing-teams/{ticketingTeamId}/users/{userId}

DELETE /api/v1/ticketing-teams/{ticketingTeamId}/users/{userId} HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*

{
  "message": "text"
}