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

Endpoints

Operations

Get a list of endpoints.Deprecated

Request

Security
ApiKeyAuth or BearerAuth
Query
typestring(EndpointType)
Enum"email_address""phone_number"
curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/integrations-api/v1/endpoints?type=email_address' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Array of endpoints.

Bodyapplication/json
dataArray of EmailAddress (object) or PhoneNumber (object)(Endpoint)required
One of:
data[].​email_addressobjectrequired
data[].​email_address.​idstring(StringId)required
data[].​email_address.​internal_email_addressstringrequired

The internal email address. Ends in @email.dixa.io

Example: "support-dixa@email.dixa.io"
data[].​email_address.​spf_emailstring

The spf email address associated with the email.

Example: "support@dixa.com"
pagingobject(Paging)
Response
application/json
{
  "data": [
    { … }
  ],
  "paging": {
    "cursors": { … },
    "next_page": "string",
    "prev_page": "string"
  }
}

Get an endpoint by idDeprecated

Request

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

Responses

A found endpoint

Bodyapplication/json
dataEmailAddress (object) or PhoneNumber (object)(Endpoint)required
One of:
data.​email_addressobjectrequired
data.​email_address.​idstring(StringId)required
data.​email_address.​internal_email_addressstringrequired

The internal email address. Ends in @email.dixa.io

Example: "support-dixa@email.dixa.io"
data.​email_address.​spf_emailstring

The spf email address associated with the email.

Example: "support@dixa.com"
Response
application/json
{
  "data": {
    "email_address": { … }
  }
}

Conversations

Operations

Message

Operations

Wrapup

Operations

Note

Operations

ActivityLog

Operations

flows

Operations