get
https://gw.commpeak.com/textpeak/domains
Description
Summary: Retrieves a paginated list of all domains associated with your account. Details: This endpoint returns a collection of domain resources. Results are paginated and can be filtered by various criteria including domain ID, name, status, and creation date. Use the query parameters to control pagination and narrow down results.
Authentication & Scopes
Authentication is handled via an API key provided in the Authorization header. No OAuth scopes are defined; access is granted or denied based on the validity of the key.
| Method | Details |
|---|---|
| API Key | Pass your API key directly in the Authorization header value (not as a Bearer token). |
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | The API key that verifies your access to the API. |
accept | No | Expected response format. Default: application/json. |
Parameters
| Parameter | Type | Location | Required | Description |
|---|---|---|---|---|
page | integer | Query | No | The page number to retrieve. Default: 1. |
itemsPerPage | integer | Query | No | The number of items to return per page. Default: 30. |
id | string | Query | No | Filter by a single domain ID. |
id[] | string | Query | No | Filter by multiple domain IDs (pass multiple values). |
name | string | Query | No | Filter domains by name. |
status | string | Query | No | Filter by a single domain status. |
status[] | string | Query | No | Filter by multiple domain statuses (pass multiple values). |
createdAt[before] | string | Query | No | Filter domains created before this date/time. |
createdAt[after] | string | Query | No | Filter domains created after this date/time. |
Request Body
This endpoint does not use a request body.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…