Skip to content
Dixa API/
/
Get contact endpoint

Dixa API (beta)

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

Analytics

Operations

Agents

Operations

End Users

Operations

Chatbots

Operations

Anonymization

Operations

Custom Attributes

Operations

Teams

Operations

Conversations

Operations

Messages

Operations

Internal Notes

Operations

Ratings

Operations

Tags

Operations

Queues

Operations

Contact Endpoints

Operations

Get contact endpoint

Request

Get contact endpoint by id (email or phone number).

Security
ApiKeyAuth
Path
contactEndpointIdstringrequired
curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/contact-endpoints/{contactEndpointId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The requested contact endpoint

Bodyapplication/json
dataEmailEndpoint (object) or TelephonyEndpoint (object)(ContactEndpoint)required
One of:
data.​addressstringrequired
data.​senderOverridestring
data.​namestring
Response
application/json
{
  "data": {
    "address": "some@email.com",
    "senderOverride": "otheremail@mail.dk",
    "name": "Special email flow",
    "_type": "EmailEndpoint"
  }
}

List contact endpoints

Request

List all available contact endpoints in an organization.

Security
ApiKeyAuth
Query
_typestring

An optional contact type can be specified to filter the contact endpoints. If not provided, all types are listed. Possible values: [EmailEndpoint, TelephonyEndpoint]

curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/contact-endpoints?_type=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The list of available contact endpoints

Bodyapplication/json
dataArray of EmailEndpoint (object) or TelephonyEndpoint (object)(ContactEndpoint)
Response
application/json
{
  "data": [
    { … },
    { … }
  ]
}

Webhooks

Operations

Templates

Operations

Business Hours

Operations

Knowledge

Operations

Organization

Operations