Skip to main content
GET
/
v1
/
domains
List domains
curl --request GET \
  --url https://api.shingleai.com/v1/domains \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "domain": "<string>",
      "source": "<string>",
      "status": "<string>",
      "zoneId": "<string>",
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "data": {},
      "verificationAttempts": 123,
      "verificationStatus": "<string>",
      "verifiedAt": "2023-11-07T05:31:56Z",
      "verificationToken": "<string>",
      "verificationExpiresAt": "2023-11-07T05:31:56Z",
      "resendApiKey": "<string>",
      "resendEmailEnabled": true,
      "resendFromEmail": "<string>",
      "resendDomainId": "<string>",
      "resendDomainRecords": [
        "<unknown>"
      ]
    }
  ],
  "meta": {
    "pagination": {
      "limit": 123,
      "offset": 123,
      "hasMore": true,
      "total": 123
    }
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication via Bearer token

Query Parameters

​
limit
number
default:10

Maximum number of items to return (1-100)

Required range: 1 <= x <= 100
Example:

10

​
offset
number | null
default:0

Number of items to skip

Required range: x >= 0
Example:

0

​
sortOrder
enum<string>
default:desc

Sort order by creation date

Available options:
asc,
desc
Example:

"desc"

Response

List of domains with pagination metadata

​
data
object[]
required
​
meta
object