Skip to main content

List domains

GET 
/api/v1/domains

Returns only the domains the caller is allowed to access.

Access rules:

  • If the user has the domain_all permission, all domains are returned.
  • If the user has any assigned domain groups or individual domains, only those domains are returned (even if the user's own domain is not included).
  • If nothing is assigned, only the user's own domain is returned.

Pagination (cursor-based):

  • Both limit and starting_after are optional.
  • If limit is not provided, it defaults to 25.
  • If starting_after is not provided, results start from the beginning.
  • If has_more is true, request the next page by passing starting_after equal to the last item's domain_uuid from the previous response.

Examples:

  • First page: GET /api/v1/domains
  • Next page: GET /api/v1/domains?starting_after={last_domain_uuid}
  • Custom size: GET /api/v1/domains?limit=50

Request​

Responses​

Success