List domain time frame names

GET

/domains/{domain}/timeframes/list

Last modified:2026-10-09 00:47:04

OperationId:ListDomainTimeframes

Returns the name and state of each shared time frame of the domain: whether an answer rule uses it (selected) and whether every range in it is in the past (expired). Requires the list privilege on time frames, which Basic User, Site Manager, and Office Manager hold in their domain, and Reseller and Super User more widely. The owner must be one you can reach, or the call returns 403.

/list is a suffix on the collection path. It returns names and state only, and it is authorised by the list privilege, the one /count uses. On a keyed path, /timeframes/{id}/list, it returns only that time frame, by ID or by name. Changed in v46: rows used to be name strings with the state appended; they are now objects with selected and expired fields.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Responses

🟢200Success

application/json

One row per time frame, sorted by name. None returns [].

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//timeframes/list' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Names

Two shared time frames, one in use.

[
    {
        "timeframe": "Business Hours",
        "domain": "example.com",
        "user": "*",
        "selected": "yes",
        "expired": "no"
    },
    {
        "timeframe": "Office Closures",
        "domain": "example.com",
        "user": "*",
        "selected": "no",
        "expired": "yes"
    }
]

Modified at 2026-10-09 00:47:04

Read domain time frame

Add entries to user time frame