Clerk API (unofficial showcase)
GET/organization_domains

List all organization domains

Retrieves a list of all organization domains within the current instance. This endpoint can be used to list all domains across all organizations or filter domains by organization, verification status, enrollment mode, or search query.

The response includes pagination information and details about each domain including its verification status, enrollment mode, and associated counts.

8 parameters
organization_idstringoptional
The ID of the organization to filter domains by
verifiedstringoptional
Filter by verification status
Allowed:truefalse
enrollment_modearray<string>optional
Filter by enrollment mode. Prefix a value with `-` to exclude it instead (e.g. `-enterprise_sso`). Include and exclude filters can be combined and compose as AND.
querystringoptional
Search domains by name or organization ID. If the query starts with "org_", it will search by exact organization ID match. Otherwise, it performs a case-insensitive partial match on the domain name. Note: An empty string or whitespace-only value is not allowed and will result in a validation error.
domainsarray<string>optional
Filter by exact domain names. Accepts multiple values (e.g. domains=example.com&domains=test.org).
order_bystringoptional
Allows to return organization domains in a particular order. At the moment, you can order the returned domains by their `name` or `created_at`. In order to specify the direction, you can use the `+/-` symbols prepended to the property to order by. For example, if you want domains to be returned in descending order according to their `created_at` property, you can use `-created_at`. If you don't use `+` or `-`, then `+` is implied. Defaults to `-created_at`.
Default:-created_at
offsetintegeroptional
Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.
Default:0
limitintegeroptional
Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
Default:10

4 status codes
200A list of organization domains
dataarray<object>required
total_countintegerrequired
Total number of organization domains
401Authentication invalid
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
403Authorization invalid
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
422Invalid request parameters
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 401 is returned: Authentication invalid. A 403 is returned: Authorization invalid. A 422 is returned: Invalid request parameters.