SMAO API Documentation
Public APIForwardings

List forwardings (paginated)

GET
/forwardings

Authorization

bearerAuth
AuthorizationBearer <token>

API key in the Authorization: Bearer <key> header. Keys are created in the SMAO dashboard (Settings → API Keys).

In: header

Query Parameters

cursor?string

Opaque cursor from a prior meta.next_cursor. Base64url-encoded (unpadded) — do not parse or construct it manually.

Match^[A-Za-z0-9_-]+$
limit?integer

Items per page (1–100, default 50).

Range1 <= value <= 100
Default50
group_id?string

Filter by forwardings group.

Match^[a-f0-9]{24}$

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/forwardings"
{  "data": [    {      "id": "string",      "group_id": "string",      "group_name": "string",      "type": "personal",      "gender": "string",      "job_title": "string",      "first_name": "string",      "last_name": "string",      "email": "string",      "competence": "string",      "activation_keywords": [        "string"      ],      "destination_type": "phone",      "phone_number": "string",      "sip_uri": "string",      "sip_username": "string",      "sip_refer_target": "string",      "has_sip_credentials": true,      "identity_source": "employee",      "active": true,      "fallback": false,      "timeout": 30,      "dtmf_sequence": [        {          "action": "pause",          "duration": 0,          "digits": "string"        }      ],      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "has_more": true,    "next_cursor": "string"  }}

Delete a contact DELETE

Delete a contact

Create a forwarding POST

Creates a new forwarding target inside a forwardings-type group. The referenced `group_id` must belong to your organization and have `type: forwardings`. When `destination_type` is `sip`, `sip_uri` is required. When `destination_type` is `sip_refer`, `sip_refer_target` is required. For a usable `phone` destination, provide a non-empty `phone_number`; current request validation also accepts an omitted or empty value, which produces a target that cannot be dialed.