List Domains

Query Options

Filtering, searching, sorting, and pagination supported by the list endpoint

  • Use page and per_page to paginate results.
  • Use search to match domain names.
  • Use sorting[] to control sort order. If you do not provide sorting, domains are ordered by newest first.
  • Domain access is scoped to the workspace resolved from the bearer token.
GET
/v1/domains

List sending domains for your workspace

Request body

pagenumber

Query parameter for the page number (default 1)

per_pagenumber

Query parameter for records per page (default 10)

searchstring

Query parameter used to search by domain name

sorting[]array

Query parameter containing JSON-encoded sort descriptors

List Domains
curl "https://api.leadpush.io/v1/domains?page=1&per_page=10" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {token}"
Response Example
{
"data": [
  {
    "uuid": "<domain_uuid>",
    "name": "example.test",
    "domain": "example.test",
    "verified": false,
    "provider": "leadpush",
    "status": "pending",
    "verification": "pending",
    "mail_from_domain": "bounces.example.test",
    "mail_from_verified": false,
    "dns": [
      {
        "type": "CNAME",
        "name": "default._domainkey.example.test",
        "value": "default._domainkey.smtp-domain-1.leadpush.net.",
        "is_valid": true
      },
      {
        "type": "MX",
        "name": "bounces.example.test",
        "value": "10 bounces.leadpush.net",
        "is_valid": false
      }
    ],
    "updated_at": "2021-01-01T00:00:00.000Z",
    "created_at": "2021-01-01T00:00:00.000Z"
  }
],
"meta": {
  "current_page": 1,
  "per_page": 10,
  "total": 1,
  "last_page": 1,
  "has_next": false
}
}