Skip to content

Integrations API [deprecated] (1.0.0)

Welcome to the Dixa integrations API. Remember to set your credentials using the 'Authorize' button. Note that this API is deprecated and equivalent functionality can be found in Dixa API.

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Mock server
https://docs.dixa.io/_mock/openapi/integrations-api
The Server
https://docs.dixa.io

Users

Operations

Tags

Operations

Queues

Operations

Get a list of queues for your organizationDeprecated

Request

Security
ApiKeyAuth or BearerAuth
curl -i -X GET \
  https://docs.dixa.io/_mock/openapi/integrations-api/v1/queues \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A list of queues for the organization

Bodyapplication/json
dataArray of objects(Queue)required
data[].​idstring(StringId)required
data[].​namestringrequired
data[].​is_defaultbooleanrequired

Whether or not this queue is the default queue for this organization

data[].​priorityinteger

The priority of the queue

pagingobject(Paging)
Response
application/json
{
  "data": [
    { … }
  ],
  "paging": {
    "cursors": { … },
    "next_page": "string",
    "prev_page": "string"
  }
}

Get a queue by idDeprecated

Request

Security
ApiKeyAuth or BearerAuth
Path
idstringrequired
curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/integrations-api/v1/queues/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response with a queue

Bodyapplication/json
dataobject(Queue)required
data.​idstring(StringId)required
data.​namestringrequired
data.​is_defaultbooleanrequired

Whether or not this queue is the default queue for this organization

data.​priorityinteger

The priority of the queue

Response
application/json
{
  "data": {
    "id": "string",
    "name": "string",
    "is_default": true,
    "priority": 0
  }
}

Endpoints

Operations

Conversations

Operations

Message

Operations

Wrapup

Operations

Note

Operations

ActivityLog

Operations

flows

Operations