List custom domains

GET

/api/v1/domains

const url = 'https://app.shroud.email/api/v1/domains?page=1&page_size=20';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://app.shroud.email/api/v1/domains?page=1&page_size=20' \
  --header 'Authorization: Bearer <token>'

Lists your custom domains with valid DNS records (all verification checks within the last day). OAuth scope: domains:read.

Authorizations

bearerAuth

Parameters

Query Parameters

page

integer

Page number (default 1).

Example

page_size

integer

Entries per page (default 20).

Example

Responses

200

Custom domains

application/json

object

domains

required

Array<object>

object

domain

required

string

page_number

required

integer

page_size

required

integer

total_entries

required

integer

total_pages

required

integer

Example

{
  "domains": [
    {
      "domain": "example.com"
    }
  ],
  "page_number": 1,
  "page_size": 20,
  "total_entries": 1,
  "total_pages": 1
}

401

Invalid token

application/json

Error

object

error

required

string

Example

{
  "error": "Invalid token"
}

403

Insufficient scope or unconfirmed account

application/json

Error

object

error

required

string

Example

{
  "error": "Invalid token"
}