List sending domains

GET

/v1/email/domains

for await (const domain of bird.domains.list()) {
  console.log(domain.id, domain.status);
}

for domain in client.domains.list():
    print(domain.id, domain.status)

for domain, err := range client.Domains.List(context.Background(), bird.DomainListParams{Limit: 50}) {
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(domain.Id, *domain.Status)
}

foreach ($bird->domains->list() as $domain) {
    echo $domain->getId(), ' ', $domain->getStatus(), "\n";
}

bird email domains list

curl -X GET "https://us1.platform.bird.com/v1/email/domains" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "sort=created_at" \
  --url-query "order=desc" \
  --url-query "limit=25" \
  --url-query "include_total=false"

Antwort200

{
  "data": [
    {
      "id": "dom_01krdgeqcxet5s7t44vh8rt9mg",
      "workspace_id": "ws_01krdgeqcxet5s7t44vh8rt9mg",
      "domain": "mail.acme.com",
      "vendor": "other",
      "status": "pending",
      "next": [
        {
          "kind": "operation"
        }
      ],
      "dkim": {
        "mode": "txt",
        "selector": "bird1",
        "key_size": 2048
      },
      "capabilities": {
        "sending": {
          "status": "verified",
          "pending": {
            "domain": "rp.mail.acme.com",
            "status": "pending"
          }
        },
        "return_path": {
          "status": "verified",
          "pending": {
            "domain": "rp.mail.acme.com",
            "status": "pending"
          }
        },
        "dmarc": {
          "status": "verified",
          "pending": {
            "domain": "rp.mail.acme.com",
            "status": "pending"
          }
        },
        "tracking": {
          "status": "verified",
          "pending": {
            "domain": "rp.mail.acme.com",
            "status": "pending"
          }
        },
        "inbound": {
          "status": "verified",
          "pending": {
            "domain": "rp.mail.acme.com",
            "status": "pending"
          }
        }
      },
      "receiving": {
        "state": "enabled"
      },
      "dns_records": [
        {
          "type": "TXT",
          "purpose": "dkim",
          "state": "active",
          "status": "pending"
        }
      ]
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Returns all sending domains for the current workspace, newest first by default. Each item is the full domain object, including capability statuses and dns_records, so no per-domain follow-up read is needed. Filter with name to find a specific domain.

Abfrageparameter

namestring

Substring match against the domain name (case-insensitive).

sortstring

Field to sort by. Defaults to created_at.

Possible values: created_at, name

orderstring

Sort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field.

Possible values: asc, desc

limitinteger

Maximum number of items to return per page.

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.

include_totalboolean

When true, the response includes a total field with the total number of items matching the request's filters across all pages.

Antwort-Payload

data

array of object

erforderlich

Page of sending domains, newest first by default.

Untergeordnete Attribute anzeigen

next_cursor

nullable string

erforderlich

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursor

nullable string

erforderlich

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursor

nullable string

erforderlich

Refresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.

total

nullable integer

Total number of items matching the request's filters across all pages. Present only when include_total=true was passed; otherwise null.

Weiter mit der Dokumentation, Anleitungen und Beispielen zu diesem Thema.

Implementierungs-Briefing erhalten

for await (const domain of bird.domains.list()) {
  console.log(domain.id, domain.status);
}

for domain in client.domains.list():
    print(domain.id, domain.status)

for domain, err := range client.Domains.List(context.Background(), bird.DomainListParams{Limit: 50}) {
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(domain.Id, *domain.Status)
}

foreach ($bird->domains->list() as $domain) {
    echo $domain->getId(), ' ', $domain->getStatus(), "\n";
}

bird email domains list

curl -X GET "https://us1.platform.bird.com/v1/email/domains" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "sort=created_at" \
  --url-query "order=desc" \
  --url-query "limit=25" \
  --url-query "include_total=false"

Antwort200

{
  "data": [
    {
      "id": "dom_01krdgeqcxet5s7t44vh8rt9mg",
      "workspace_id": "ws_01krdgeqcxet5s7t44vh8rt9mg",
      "domain": "mail.acme.com",
      "vendor": "other",
      "status": "pending",
      "next": [
        {
          "kind": "operation"
        }
      ],
      "dkim": {
        "mode": "txt",
        "selector": "bird1",
        "key_size": 2048
      },
      "capabilities": {
        "sending": {
          "status": "verified",
          "pending": {
            "domain": "rp.mail.acme.com",
            "status": "pending"
          }
        },
        "return_path": {
          "status": "verified",
          "pending": {
            "domain": "rp.mail.acme.com",
            "status": "pending"
          }
        },
        "dmarc": {
          "status": "verified",
          "pending": {
            "domain": "rp.mail.acme.com",
            "status": "pending"
          }
        },
        "tracking": {
          "status": "verified",
          "pending": {
            "domain": "rp.mail.acme.com",
            "status": "pending"
          }
        },
        "inbound": {
          "status": "verified",
          "pending": {
            "domain": "rp.mail.acme.com",
            "status": "pending"
          }
        }
      },
      "receiving": {
        "state": "enabled"
      },
      "dns_records": [
        {
          "type": "TXT",
          "purpose": "dkim",
          "state": "active",
          "status": "pending"
        }
      ]
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

List sending domains

Abfrageparameter

Antwort-Payload

Verwandte Ressourcen