Sign in
Manage Domains

List domains

<div id="admonition-warning">⚠️ <b>Before you can use the Manage Domains endpoints, you need a <a href="/docs/v3/auth/nylas-service-account/">Nylas Service Account</a></b>.</div>

Returns a list of all domains registered to your organization.

get/v3/admin/domains

Query parameters

limitinteger

The maximum number of objects to return. See Pagination for more information.

page_tokenstring

A token to fetch the next page of results. Use the next_cursor value from the previous response.

Response

OK

request_idstring

ID of the request.

next_cursorstring

A token to use for paginating through results. If present, pass this value as page_token in the next request.

Example response

{
  "request_id": "5fa64c92-e840-4357-86b9-2aa364d35b88",
  "data": [
    {
      "id": "abc-123-domain-id",
      "name": "My transactional domain",
      "domain_address": "mail.example.com",
      "organization_id": "org-123",
      "region": "us",
      "verified_ownership": true,
      "created_at": 1742932766,
      "updated_at": 1742932766
    }
  ],
  "next_cursor": "eyJhbGciOiJIUzI1NiJ9"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.