Domains

Get All Domains

Changed on Nov 3, 2026

List all domains in your account.

Pagination. page (1-based, default 1) and itemsPerPage (default 30, at most 1000). The response is a plain JSON array.

Authentication: TextPeak API key in the Authorization header (see Authentication in the API Overview).

get/domains

Request

Base URL
https://api.commpeak.com/textpeak
URL
https://api.commpeak.com/textpeak/domains
Auth
API key in header Authorization

Query parameters

pageinteger nullable

Page number (1-based).

itemsPerPageinteger nullable

Items per page, at most 1000.

order[id]'asc' | 'desc'

Sort by ID.

idinteger nullable

Exact domain ID.

namestring nullable

Domain name contains this text.

Domain status (case-insensitive).

status[]string[] nullable

Any of these statuses.

createdAt[before]string nullable

Created on or before this time (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS).

createdAt[after]string nullable

Created on or after this time (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS).

Response

Successful Response

idinteger required

Unique domain identifier.

namestring required

The domain name.

ipstring required

IP address the domain must point to (an A record). Set by TextPeak; read-only.

Example response

[
  {
    "id": 12,
    "ip": "192.0.2.10",
    "name": "demo.example.com",
    "status": "NOT_CONFIGURED"
  }
]

Changes

Nov 3, 20265012671cf95d Revision changes
- breaking
  for the query request parameter itemsPerPage, default value 30 was added
- warning
  deleted the query request parameter _page
- info
  api operation id getAllDomains removed and replaced with list_domains
- info
  the endpoint scheme security APIKeyHeader was added to the API
- info
  added the new optional query request parameter createdAt[after]
- info
  added the new optional query request parameter createdAt[before]
- info
  added the new optional query request parameter id
- info
  added the new optional query request parameter name
- info
  added the new optional query request parameter order[id]
- info
  added the new optional query request parameter page
- info
  added the new optional query request parameter status
- info
  added the new optional query request parameter status[]
- info
  query request parameter itemsPerPage list-of-types was widened by adding types null
- info
  for the query request parameter itemsPerPage, the type was generalized from integer to no type
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status

Operation history