Contact Endpoints

Get contact endpoint

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

SecurityApiKeyAuth
Request
path Parameters
contactEndpointId
required
string
Responses
200

The requested contact endpoint

400

Invalid value extracted from request context, The contactEndpointId is neither a valid email nor a valid E.164 phone number

404

An entity in this request could not be found

get/v1/contact-endpoints/{contactEndpointId}
Request samples
Response samples
application/json
{
  • "data": {
    • "address": "some@email.com",
    • "senderOverride": "otheremail@mail.dk",
    • "name": "Special email flow",
    • "_type": "EmailEndpoint"
    }
}

List contact endpoints

List all available contact endpoints in an organization.

SecurityApiKeyAuth
Request
query Parameters
_type
string

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

Responses
200

The list of available contact endpoints

400

Invalid value extracted from request context, Invalid value for: query parameter _type

500

Internal failure during request processing

get/v1/contact-endpoints
Request samples
Response samples
application/json
{
  • "data": [
    • {
      • "number": "+4531434343",
      • "functionality": [
        • "VoiceInbound",
        • "VoiceOutbound"
        ],
      • "name": "DK Sms",
      • "_type": "TelephonyEndpoint"
      },
    • {
      • "address": "some@email.com",
      • "senderOverride": "otheremail@mail.dk",
      • "name": "Special email flow",
      • "_type": "EmailEndpoint"
      }
    ]
}