> ## Documentation Index > Fetch the complete documentation index at: https://speakeasy-20cf8bdf.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve a list of domains > Retrieve a list of domains associated with the authenticated workspace. ## OpenAPI ````yaml get /domains openapi: 3.0.3 info: title: Dub API description: >- Dub is the modern link attribution platform for short links, conversion tracking, and affiliate programs. version: 0.0.1 contact: name: Dub Support email: support@dub.co url: https://dub.co/api license: name: AGPL-3.0 license url: https://github.com/dubinc/dub/blob/main/LICENSE.md servers: - url: https://api.dub.co description: Production API security: [] paths: /domains: get: tags: - Domains summary: Retrieve a list of domains description: Retrieve a list of domains associated with the authenticated workspace. operationId: listDomains parameters: - in: query name: archived description: >- Whether to include archived domains in the response. Defaults to `false` if not provided. schema: type: boolean default: 'false' description: >- Whether to include archived domains in the response. Defaults to `false` if not provided. - in: query name: search description: The search term to filter the domains by. schema: type: string description: The search term to filter the domains by. - in: query name: page description: The page number for pagination. schema: type: number minimum: 0 exclusiveMinimum: true default: 1 description: The page number for pagination. example: 1 - in: query name: pageSize description: The number of items per page. schema: type: number minimum: 0 exclusiveMinimum: true maximum: 50 default: 50 description: The number of items per page. example: 50 responses: '200': description: The domains were retrieved. content: application/json: schema: type: array items: $ref: '#/components/schemas/DomainSchema' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '410': $ref: '#/components/responses/410' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' security: - token: [] x-codeSamples: - lang: python label: listDomains source: |- 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() - lang: php label: listDomains source: |- declare(strict_types=1); require 'vendor/autoload.php'; use Dub; $sdk = Dub\Dub::builder() ->setSecurity( 'DUB_API_KEY' ) ->build(); $responses = $sdk->domains->list( archived: true, page: 1, pageSize: 50 ); foreach ($responses as $response) { if ($response->statusCode === 200) { // handle response } } - lang: go label: listDomains source: "package main\n\nimport(\n\t\"context\"\n\tdubgo \"github.com/dubinc/dub-go\"\n\t\"github.com/dubinc/dub-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := dubgo.New(\n dubgo.WithSecurity(\"DUB_API_KEY\"),\n )\n\n res, err := s.Domains.List(ctx, operations.ListDomainsRequest{\n Archived: dubgo.Pointer(true),\n })\n if err != nil {\n log.Fatal(err)\n }\n if res != nil {\n for {\n // handle items\n\n res, err = res.Next()\n\n if err != nil {\n // handle error\n }\n\n if res == nil {\n break\n }\n }\n }\n}" - lang: ruby label: listDomains source: |- require 'dub' Models = ::OpenApiSDK::Models s = ::OpenApiSDK::Dub.new( security: Models::Shared::Security.new( token: 'DUB_API_KEY', ), ) req = Models::Operations::ListDomainsRequest.new( archived: true, ) res = s.domains.list(request: req) unless res.nil? # handle response end - lang: typescript label: listDomains source: |- import { Dub } from "dub"; const dub = new Dub({ token: "DUB_API_KEY", }); async function run() { const result = await dub.domains.list(); for await (const page of result) { console.log(page); } } run(); components: schemas: DomainSchema: type: object properties: id: type: string description: The unique identifier of the domain. slug: type: string description: The domain name. example: acme.com verified: type: boolean default: false description: Whether the domain is verified. primary: type: boolean default: false description: Whether the domain is the primary domain for the workspace. archived: type: boolean description: Whether the domain is archived. default: false placeholder: type: string nullable: true description: >- 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: type: string nullable: true description: The URL to redirect to when a link under this domain has expired. example: https://acme.com/expired notFoundUrl: type: string nullable: true description: The URL to redirect to when a link under this domain doesn't exist. example: https://acme.com/not-found logo: type: string nullable: true description: The logo of the domain. assetLinks: type: string nullable: true default: null description: >- assetLinks.json configuration file (for deep link support on Android). appleAppSiteAssociation: type: string nullable: true default: null description: >- apple-app-site-association configuration file (for deep link support on iOS). createdAt: type: string description: The date the domain was created. updatedAt: type: string description: The date the domain was last updated. registeredDomain: type: object nullable: true properties: id: type: string description: The ID of the registered domain record. autoRenewalDisabledAt: type: string nullable: true description: The date the domain auto-renew is disabled. createdAt: type: string description: The date the domain was created. expiresAt: type: string description: The date the domain expires. renewalFee: type: number description: The fee to renew the domain. required: - id - autoRenewalDisabledAt - createdAt - expiresAt - renewalFee description: The registered domain record. required: - id - slug - verified - primary - archived - placeholder - expiredUrl - notFoundUrl - logo - assetLinks - appleAppSiteAssociation - createdAt - updatedAt - registeredDomain responses: '400': description: >- The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). content: application/json: schema: x-speakeasy-name-override: BadRequest type: object properties: error: type: object properties: code: type: string enum: - bad_request description: A short code indicating the error code returned. example: bad_request message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: https://dub.co/docs/api-reference/errors#bad-request required: - code - message required: - error '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. content: application/json: schema: x-speakeasy-name-override: Unauthorized type: object properties: error: type: object properties: code: type: string enum: - unauthorized description: A short code indicating the error code returned. example: unauthorized message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: https://dub.co/docs/api-reference/errors#unauthorized required: - code - message required: - error '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server. content: application/json: schema: x-speakeasy-name-override: Forbidden type: object properties: error: type: object properties: code: type: string enum: - forbidden description: A short code indicating the error code returned. example: forbidden message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: https://dub.co/docs/api-reference/errors#forbidden required: - code - message required: - error '404': description: The server cannot find the requested resource. content: application/json: schema: x-speakeasy-name-override: NotFound type: object properties: error: type: object properties: code: type: string enum: - not_found description: A short code indicating the error code returned. example: not_found message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: https://dub.co/docs/api-reference/errors#not-found required: - code - message required: - error '409': description: >- This response is sent when a request conflicts with the current state of the server. content: application/json: schema: x-speakeasy-name-override: Conflict type: object properties: error: type: object properties: code: type: string enum: - conflict description: A short code indicating the error code returned. example: conflict message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: https://dub.co/docs/api-reference/errors#conflict required: - code - message required: - error '410': description: >- This response is sent when the requested content has been permanently deleted from server, with no forwarding address. content: application/json: schema: x-speakeasy-name-override: InviteExpired type: object properties: error: type: object properties: code: type: string enum: - invite_expired description: A short code indicating the error code returned. example: invite_expired message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: https://dub.co/docs/api-reference/errors#invite-expired required: - code - message required: - error '422': description: >- The request was well-formed but was unable to be followed due to semantic errors. content: application/json: schema: x-speakeasy-name-override: UnprocessableEntity type: object properties: error: type: object properties: code: type: string enum: - unprocessable_entity description: A short code indicating the error code returned. example: unprocessable_entity message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: >- https://dub.co/docs/api-reference/errors#unprocessable-entity required: - code - message required: - error '429': description: >- The user has sent too many requests in a given amount of time ("rate limiting") content: application/json: schema: x-speakeasy-name-override: RateLimitExceeded type: object properties: error: type: object properties: code: type: string enum: - rate_limit_exceeded description: A short code indicating the error code returned. example: rate_limit_exceeded message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: >- https://dub.co/docs/api-reference/errors#rate-limit_exceeded required: - code - message required: - error '500': description: The server has encountered a situation it does not know how to handle. content: application/json: schema: x-speakeasy-name-override: InternalServerError type: object properties: error: type: object properties: code: type: string enum: - internal_server_error description: A short code indicating the error code returned. example: internal_server_error message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: >- https://dub.co/docs/api-reference/errors#internal-server_error required: - code - message required: - error securitySchemes: token: type: http description: Default authentication mechanism scheme: bearer x-speakeasy-example: DUB_API_KEY ````