Skip to content
Pidgely Docs

API reference · Domains

List domains

GEThttps://api.pidgely.com/domains
View as Markdown

Lists the domains of the account, newest first.

Authorization: Bearer pdg_…. An API key with full_access. A sending_access key gets 401 restricted_api_key.

Query parameters

Name Type Required Description
limit integer No Page size (1-100). Between 1 and 100.
after string No Id of the last item of the previous page (older items). UUID.
before string No Id of the first item of the current page (newer items). UUID.

Request

Node.js
import { Pidgely } from 'pidgely';

const pidgely = new Pidgely(process.env.PIDGELY_API_KEY);

const { data, error } = await pidgely.domains.list();
console.log(data ?? error);
Python
import os
import pidgely

pidgely.api_key = os.environ["PIDGELY_API_KEY"]

result = pidgely.Domains.list()
print(result)
PHP
<?php

require __DIR__ . '/vendor/autoload.php';

$pidgely = Pidgely::client(getenv('PIDGELY_API_KEY'));

$result = $pidgely->domains->list();
var_dump($result);
Go
package main

import (
	"context"
	"fmt"
	"os"

	"github.com/pidgely/pidgely-go"
)

func main() {
	ctx := context.Background()
	client := pidgely.NewClient(os.Getenv("PIDGELY_API_KEY"))

	result, err := client.Domains.List(ctx, nil)
	if err != nil {
		panic(err)
	}
	fmt.Println(result)
}
Ruby
require "pidgely"

Pidgely.api_key = ENV["PIDGELY_API_KEY"]

result = Pidgely::Domains.list()
puts result
cURL
curl -X GET 'https://api.pidgely.com/domains' \
  -H "Authorization: Bearer $PIDGELY_API_KEY"

Response

200 OK

JSON
{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "domain",
      "id": "0199d7f0-1c2b-7e4d-a5f6-0b9c8d7e6f51",
      "name": "acme.com",
      "status": "verified",
      "created_at": "2026-10-12 16:44:41.000000+00",
      "region": "sa-east-1",
      "open_tracking": false,
      "click_tracking": false,
      "tls": "opportunistic",
      "capabilities": {
        "sending": "enabled",
        "receiving": "disabled"
      }
    }
  ]
}

Response fields

Name Type Required Description
object string Yes Object type. One of list.
has_more boolean Yes Whether another page exists.
data object[] Yes Items of this page.
data[].object string No Object type.
data[].id string No Unique id (UUID). UUID.
data[].name string No Display name.
data[].status string No Current status. One of not_started, pending, verified, failed.
data[].created_at string No Timestamp in UTC (2026-10-12 16:44:41.000000+00).
data[].region string No Informative; set by the platform.
data[].open_tracking boolean No —
data[].click_tracking boolean No —
data[].tls string No opportunistic (default): TLS when the receiving server offers it. enforced: deliver only over TLS. One of opportunistic, enforced.
data[].capabilities object No —
data[].capabilities.sending string No —
data[].capabilities.receiving string No —
data[].records object[] No DNS records to publish, with their verification status.
data[].records[].record string No One of DKIM, SPF, DMARC.
data[].records[].name string No Relative to the domain.
data[].records[].type string No One of TXT, MX.
data[].records[].ttl string No —
data[].records[].status string No Current status.
data[].records[].value string No Record value.
data[].records[].priority integer No MX priority.

Errors

Errors have the shape {"statusCode", "name", "message"}. See Errors for the full list.

Status Name When
401 missing_api_key, restricted_api_key No Authorization: Bearer header, or a sending_access key called an endpoint that needs full_access.
403 invalid_api_key, validation_error The API key is invalid or revoked, or the request is not allowed for this account (unverified domain, plan limit, paused account).
404 not_found The resource does not exist in this account (or the id is not a valid UUID).
422 validation_error A field is missing or invalid; message names it.
429 rate_limit_exceeded Too many requests per second. Wait for Retry-After seconds.