GET
/
domains
Python
from dub import Dub


with Dub(
    token="DUB_API_KEY",
) as d_client:

    res = d_client.domains.list(request={
        "archived": True,
    })

    while res is not None:
        # Handle items

        res = res.next()
[
  {
    "id": "<string>",
    "slug": "acme.com",
    "verified": false,
    "primary": false,
    "archived": false,
    "placeholder": "https://dub.co/help/article/what-is-dub",
    "expiredUrl": "https://acme.com/expired",
    "notFoundUrl": "https://acme.com/not-found",
    "logo": "<string>",
    "assetLinks": null,
    "appleAppSiteAssociation": null,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "registeredDomain": {
      "id": "<string>",
      "autoRenewalDisabledAt": "<string>",
      "createdAt": "<string>",
      "expiresAt": "<string>",
      "renewalFee": 123
    }
  }
]

Authorizations

Authorization
string
header
required

Default authentication mechanism

Query Parameters

archived
boolean
default:false

Whether to include archived domains in the response. Defaults to false if not provided.

The search term to filter the domains by.

page
number
default:1

The page number for pagination.

Required range: x > 0
Example:

1

pageSize
number
default:50

The number of items per page.

Required range: 0 < x <= 50
Example:

50

Response

The domains were retrieved.

id
string
required

The unique identifier of the domain.

slug
string
required

The domain name.

Example:

"acme.com"

verified
boolean
default:false
required

Whether the domain is verified.

primary
boolean
default:false
required

Whether the domain is the primary domain for the workspace.

archived
boolean
default:false
required

Whether the domain is archived.

placeholder
string | null
required

Provide context to your teammates in the link creation modal by showing them an example of a link to be shortened.

Example:

"https://dub.co/help/article/what-is-dub"

expiredUrl
string | null
required

The URL to redirect to when a link under this domain has expired.

Example:

"https://acme.com/expired"

notFoundUrl
string | null
required

The URL to redirect to when a link under this domain doesn't exist.

Example:

"https://acme.com/not-found"

The logo of the domain.

assetLinks.json configuration file (for deep link support on Android).

appleAppSiteAssociation
string | null
required

apple-app-site-association configuration file (for deep link support on iOS).

createdAt
string
required

The date the domain was created.

updatedAt
string
required

The date the domain was last updated.

registeredDomain
object | null
required

The registered domain record.