---
id: scope-domain-list
title: List custom domains
description: List custom domains assigned to a scope.
sidebar_label: List custom domains
hide_title: true
hide_table_of_contents: true
api: >-
  eJztWW1v2zgS/isDfmmLkx3HSbc5AfkQNO2tD92kSJzr4oIgpqWxxY1EqiSVxGf4vx+GlGzJVhznsj30gAMKpJbImWde+MxQM2cxmkiL3AolWci+CGMhKoxVGcQq40Ia4MaIqcQYrAIOJlI5dlnAVI6a07ZBzELmHt/6LWEqjGUBs3xqWHjNPtblsZuAGYwKLeyMhddzNkauUZ8UNmHh9c3iJmA51zxDi9q4BYKAfS9Qz1jAJM+QhUzpKZfiX07/rYhZwEyUYMZZOGd2ltMSY7WQU7YImMbvhdAYs9DqAoM1k4cJwuAU1ARsglAXTFbiI8/ylOTts0XQDsbb/hyKbVqXTq2p6x8cPq3RcluYLfoChrLIyPk8suIeWcBylDG9umnF4iVWeHyouk/qd39eaC3t2VW+Udq+RP6l0hYmAtMYuIwhFhojehWAQcomizGMZ8AhUqmSXTjFCS9SayilR5FGWnDLbUhSR804EKKQm+hJrGoyMdiKVkiLU9QsYJmQIqN49J5yvrZCTiFXQlqYKA05nwrps7CBtgdiAlJZyLW6FzHGDbS9p0CmIhNbMbbiyvgjwQZZZGPUFDyNpkKi0RZaQo4OLDZhHvQauA56dK41mlxJg4b093s9+rOpdMkr8MANmCKK0JhJkZLASEmL0tJGnuepiNzCvT8M7Z5vWqfGf2BEdq8o4Jo5107dQ2cMMVKuSa0VHlu5Ipw39i0DXTnTKsvTzd3+cVsabBrr1rb4N+M2Sigj6LS4WDb82V8EFZzt6fajs630xW7GbprpcwjjnbNosViFbaWUa80p2YXFzDwXfsfTJYG5dRsBFHEboW7aU0vBzoOIEQopvheO18mpFLpGKW0SC3444r24v985iA6POh8O+/udo/0o7vR7BxM8Ohwf4eEHOpb+BO+Cp86wWxTzXHQjPcut6ggZdSOVkRovfhc1tGKdyOvyXTFzyLXcTeLZxVmjEm5aAML1ISoSjssfhE26cKbsKoOEBGo7YEkyTVD1un68H/IoUoW0x/2QnGZyHuHxQVgL6PFh6KAcl3WYGUwxskq3pVfLGStXP50IzZRb72d2O1D1XTA4bVi8/+MD8Cc7uOqidrN9rXl6OWLS6/ikbKZ2clR7m7St22qcPP92EbBVz7Gb3sHleefol94+XA0/ghUZGsuznHA8JChbjKfaWSohfBOlM9LFYm6xQwIawev3+u87vf1Orz/s9UL3758Es8jjHw8z5cZCqWlnrP01rMRgwq7459TJvyjJgC2eWED3nfqiRcAOf/+9vTGhIoJ0PVJFGss3FsZIdZHaE4y78FlpKFEGwGF5iaE8FPKepyIOnAc0GlXoiNIHDcnBR2FsAErDTBUQK3qW8HukqpgJY1xZJgRjFc9cWpPecYoZxGi5SA14KoK3F58/wl8P3394t6VbKvf+5fmuqemDU/drjAYeEm7hAaWFB63kNICJSlP1UPUrFYgNlD6y3bWC7LRW0Vkex822aqcCdQJXFwOwBFDEKK2YCDQO1Z2QMWViCaoLA/vGAJerdTpwvQ6HVMi7wN0kBK1xJEO1Fe9Rz1xeg02EWdqnoqjQawWn0DKURZrmKbdkd4haKx1qVVg0nQTTHHVY5kXHJYthqxx93kyTKG0DSIqMy45GHvNximCKLON6VhFUZWsD2TBBjcA1Vmm5ylUDSpY56nKdtdHjNlb+dTj8WpFkpOJln1BV5QaSwx51kLRsJ4MtWRhAxqkzxpXNzrFOWxeuDIKw1DsmXMbkkBwjMRGRX0UnkQ6ZBmeEv2esBe7i/Gr46fL2109fvn666A7O/nHyZXB6+/Xk4uS3S39NomRuQ0zhJkTt3xl+U87j/gxQweZjVdj1s0QAXW6VEQg8c/J7LpzsBlZSuAiYN62lH24COJcIKK2euW67ir2/Nbs7QJkEXTiX6QxyjYZgKQlupQftdXW3NdvNY+vkv7x/3QJvrZldEhv1DovAXX+f0/bNHQHS4+W7myZKG8KIOHYUwMhdukaOlUf+eI7gbc5tUjst75pY/J2bIBhT7JDT3xJO9OLjTv3JClFAF98EuIFRRZUjB6X0y9pHivIp6b7nqde96V/3ynNjZXCZXhpTvOfSrn36ULbDO/7WRqIzNIZPdzqsa7SEj3nK/QVzGWDyUbesuVsl5xoj6g3aj9UlJY23jLzl+HMUwB3m/mo75tHdA9cxRCrLuRVjkQo780xRrnaOJf4YgZDGIo9fRZhW8wgHO+T8Sb32lDeFLScfBjJKi9gRnHtF3QLVeB5ZqJcaMEWeK229d8m/79t6mkuVoXUfGWr0o2RD1BsDRhCx/r/9+N9qP1xxCccpl3f/pbbiXOWm26X3Gh2/kG3SopY89WXjx3YT73+abuKnbBJ+bordLXl+OmZ1frWJognY1H0bpg6BhWyvPg8jVkF9X82zCp2ykCXW5ibc26OvcXUV/ntcbUh2SfzoOag+Klu6gARVX/bpt1/EgvI/n6vb9N+/Dd01mbKLthMe7639bq/bY6v78Vnd4pOvA3J9rozNuCPscqTQMipcj8N8VQNeMlksDbP4aPfylBxInyJ06j/NuzlhY95IZJ0oY+n5fD7mBq90uljQY9+SkddjYSjWMQsnPDXrOV5H+vairA7vYPtssBXnHc5a55NlX8bcHGl3ME/MCbeork0jX6HzqQ9d2xRXQ8lXqG0bEm5VWn7I/w9V/ulzw23u8TPN18XkVYObbflazbZeAe+108It8KqJ2wrdDf3QwlfSa5ppJ8hj1O6s+00nUYR5fdfGyJCkLPn7b5+GLGC8Sa5rZOqkV5dsOavJns/9iqG6Q7lYsAq5pd9scbNYLP4NkkGMtA==
sidebar_class_name: get api-method
info_path: docs/api/nullplatform-api
custom_edit_url: null
canonical: 'https://docs.nullplatform.com/docs/api/scope-domain-list'
---
<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"List custom domains"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/scope_domain"}
  context={"endpoint"}
>

</MethodEndpoint>

List custom domains assigned to a scope.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"in":"query","name":"organization_id","schema":{"type":"string"},"required":true,"description":"The ID of the organization.","example":"1"},{"in":"query","name":"scope_id","schema":{"type":"string"},"description":"The ID of the scope.","example":"1234"},{"in":"query","name":"status","schema":{"type":"string","enum":["active","pending"]},"description":"The status of the domain."},{"in":"query","name":"name","schema":{"type":"string"},"description":"The name of the domain."},{"in":"query","name":"sort","schema":{"type":"string"},"description":"Sort field and direction, separated by a colon. Defaults to `created_at:desc`.","example":"name:asc"},{"in":"query","name":"offset","schema":{"type":"integer","minimum":0},"description":"The starting point for pagination. Defaults to 0 if not provided.","example":0},{"in":"query","name":"limit","schema":{"type":"integer"},"description":"The maximum number of results to return per page. Defaults to 30.","example":30}]}
>

</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>

</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The operation was successful.","content":{"application/json":{"schema":{"type":"object","required":["paging","results"],"properties":{"paging":{"required":["offset","limit","total"],"properties":{"total":{"type":"integer","description":"The total number of results matching the query.","example":2},"offset":{"type":"integer","minimum":0,"description":"The starting point for pagination. Defaults to 0 if not provided.","example":0},"limit":{"type":"integer","description":"The number of results returned per page. Defaults to 30.","example":30}}},"results":{"type":"array","items":{"type":"object","required":["id","name","type"],"properties":{"id":{"type":"string","description":"The application-wide unique ID for the custom domain.","example":"e78a0d21-3c48-7421-81cd-203fe84b8e47"},"name":{"type":"string","description":"The name of the custom domain.","example":"api.crypto-inc.com"},"type":{"type":"string","description":"The type of the domain.","example":"scope"},"nrn":{"type":"string","description":"The NRN of the scope the custom domain is associated with. Not returned in list responses.","example":"organization=1:account=2:namespace=3:application=4:scope=1234"},"selector":{"type":"object","description":"The selector for the custom domain.","properties":{"organization_id":{"type":"integer","description":"The organization ID.","example":1},"nrn":{"type":"string","description":"The NRN of the scope the custom domain is associated with.","example":"organization=1:account=2:namespace=3:application=4:scope=1234"},"scope_id":{"type":"integer","description":"The ID of the scope the custom domain is associated with.","example":1234}}},"status":{"type":"string","description":"The status of the domain.","enum":["active","pending"],"example":"active"},"created_at":{"type":"string","description":"The ISO-8601 UTC timestamp of when the custom domain was created.","format":"date-time","example":"2025-01-02T00:00:00Z"},"updated_at":{"type":"string","description":"The ISO-8601 UTC timestamp of when the custom domain was last updated.","format":"date-time","example":"2025-02-02T00:00:00Z"}},"title":"scopeDomainResponse"}}},"title":"scopeDomainListResponse"}}}},"4XX":{"description":"The request couldn't be processed. For example, a parameter is invalid, the resource doesn't exist, or you don't have permission. The body is a problem details object (RFC 9457).","content":{"application/problem+json":{"schema":{"type":"object","description":"Describes what went wrong, following the RFC 9457 problem details format.","required":["type","title","status"],"properties":{"type":{"type":"string","description":"A URI that identifies the kind of problem. It's an identifier, not a link, and it's the same every time this problem occurs.","example":"urn:nullplatform:error:routes-helper:invalid-params"},"title":{"type":"string","description":"A short, human-readable summary of the problem.","example":"There are invalid parameters on the request"},"status":{"type":"integer","description":"The HTTP status code of the response.","example":400},"code":{"type":"string","description":"A stable, machine-readable error code. Use it to handle specific errors in your integrations.","example":"ROUTES_HELPER.INVALID_PARAMS"},"detail":{"type":"string","nullable":true,"description":"More information about what went wrong in this request, when available.","example":null},"errors":{"type":"array","description":"One entry per invalid field or parameter. Only present on validation errors.","items":{"type":"object","properties":{"field":{"type":"string","description":"The name of the invalid field or parameter.","example":"application_id"},"in":{"type":"string","description":"Where the field was sent: `body`, `query`, or `params` (path parameters).","example":"query"},"issue":{"type":"string","description":"What's wrong with the field, such as `required` or `invalid`.","example":"invalid"},"value":{"description":"The value that was sent, when relevant.","example":"not-a-number"},"message":{"type":"string","description":"A human-readable explanation of the issue."}}}},"message":{"type":"string","deprecated":true,"description":"Same value as `title`, kept for backward compatibility. Use `title` or `code` instead.","example":"There are invalid parameters on the request"},"traceId":{"type":"string","description":"An identifier for this request, when available. Include it when you contact nullplatform support."}}}}}},"5XX":{"description":"Something went wrong on nullplatform's side. The body is a problem details object (RFC 9457).","content":{"application/problem+json":{"schema":{"type":"object","description":"Describes what went wrong, following the RFC 9457 problem details format.","required":["type","title","status"],"properties":{"type":{"type":"string","description":"A URI that identifies the kind of problem. It's an identifier, not a link, and it's the same every time this problem occurs.","example":"about:blank"},"title":{"type":"string","description":"A short, human-readable summary of the problem.","example":"Oops.. there was an internal error"},"status":{"type":"integer","description":"The HTTP status code of the response.","example":500},"code":{"type":"string","description":"A stable, machine-readable error code. Use it to handle specific errors in your integrations."},"detail":{"type":"string","nullable":true,"description":"More information about what went wrong in this request, when available.","example":null},"message":{"type":"string","deprecated":true,"description":"Same value as `title`, kept for backward compatibility. Use `title` or `code` instead.","example":"Oops.. there was an internal error"},"traceId":{"type":"string","description":"An identifier for this request, when available. Include it when you contact nullplatform support."}}}}}}}}
>

</StatusCodes>

