Skip to main content
Resend Docs

Search documentation

Type to search this documentation.

Retrieve a list of domains

GET/domainsRetrieve a list of domains

Parameters

limitintegerquery

Number of items to return.

maximum 100 · minimum 1

afterstringquery

Return items after this cursor.

beforestringquery

Return items before this cursor.

Responses

200OKapplication/json
objectListDomainsResponse
dataarray of object
Show child attributes
Show array items
capabilitiesobject

Configure the domain capabilities for sending and receiving emails. At least one capability must be enabled.

Show child attributes
receivingstring

Enable or disable receiving emails to this domain.

one of "enabled", "disabled"

sendingstring

Enable or disable sending emails from this domain.

one of "enabled", "disabled"

created_atstring · date-time

The date and time the domain was created.

idstring

The ID of the domain.

namestring

The name of the domain.

regionstring

The region where the domain is hosted.

statusstring

The status of the domain.

has_moreboolean

Indicates if there are more results available.

objectstring

Type of the response object.

Example response
{
  "data": [
    {
      "capabilities": {
        "receiving": "disabled",
        "sending": "disabled"
      },
      "created_at": "2023-04-26T20:21:26.347412+00:00",
      "id": "d91cd9bd-1176-453e-8fc1-35364d380206",
      "name": "example.com",
      "region": "us-east-1",
      "status": "not_started"
    }
  ],
  "has_more": false,
  "object": "list"
}
Documentation menu