Connections

get

Retrieves multiple connections.

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

searchstring · min: 1Optional

Search term to filter connections by name or description.

typeany ofOptional

The type of the detail of the connection.

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

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

application/json

or

401

Unauthorized.

application/json

get

/api/v1/connections

HTTPcURLJavaScriptPython

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

[
  {
    "createdAt": "2026-06-11T20:43:38.017Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isRemoved": true,
    "updatedAt": "2026-06-11T20:43:38.017Z",
    "description": "text",
    "detail": {
      "id": "text",
      "status": "pending",
      "type": "composio-airtable"
    },
    "name": "text",
    "referenceId": "123e4567-e89b-12d3-a456-426614174000",
    "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
    "channel": {
      "createdAt": "2026-06-11T20:43:38.017Z",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isRemoved": true,
      "updatedAt": "2026-06-11T20:43:38.017Z",
      "delay": 1,
      "description": "text",
      "detail": {
        "initialMessage": "text",
        "responseWebhookUrl": "https://example.com",
        "type": "api"
      },
      "maxAssistantMessagesPerChatOwner": 1,
      "name": "text",
      "prompt": "text",
      "responderId": "123e4567-e89b-12d3-a456-426614174000",
      "showSenderName": true,
      "status": "active",
      "useVoice": "on-audio/without-transcription",
      "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
    }
  }
]

post

Sends a message through a connection.

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

contentany ofRequired

or

or

externalIdstring · nullableRequired

identifierstring · nullableRequired

Responses

200

Message sent successfully.

application/json

messagestringRequired

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

404

Connection not found.

application/json

500

Failed to send message.

application/json

post

/api/v1/connections/{id}/send-message

HTTPcURLJavaScriptPython

POST /api/v1/connections/{id}/send-message HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "content": {
    "text": "text"
  },
  "externalId": "text",
  "identifier": "text"
}

{
  "message": "text"
}