List auto attendants in domain

GET

/domains/{domain}/autoattendants

Last modified:2026-10-09 00:29:22

OperationId:ReadAutoAttendantsInDomain

Lists a domain's auto attendants: each one's name, user, starting tier, time frames, and the path that reads it in full.

Requires Office Manager, Site Manager, Reseller, or Super User scope. A Site Manager sees only attendants of users in their site, whatever site it sends.

An attendant answering several time frames is one row, with each time frame in timeframes. Returns 100 rows unless you send limit. The response is an array, empty when there are none. To see an attendant's menu, use its read-path with Read auto attendant. List auto attendants with list access returns the same rows to Basic User scope and higher, and Count auto attendants in domain counts them.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Query Params

Responses

🟢200OK

application/json

The domain's auto attendants. An empty array when there are none.

Bodyapplication/json

🟠401Authentication Required

🟠403Forbidden

🟠404Record not found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//autoattendants?site=Main%20Office&filter_users=8001&limit=undefined&start=undefined' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Auto attendants

[
    {
        "attendant-name": "Main Menu",
        "user": "8000",
        "starting-prompt": "Prompt_100",
        "read-path": "/ns-api/v2/domains/example.com/users/8000/autoattendants/Prompt_100",
        "timeframes": [
            "Default",
            "Holiday"
        ]
    },
    {
        "attendant-name": "After Hours",
        "user": "8001",
        "starting-prompt": "Prompt_100",
        "read-path": "/ns-api/v2/domains/example.com/users/8001/autoattendants/Prompt_100",
        "timeframes": [
            "After Hours"
        ]
    }
]

Modified at 2026-10-09 00:29:22

Create auto attendant

Read auto attendant