Clerk API (unofficial showcase)
GET/organizations/{organization_id}/domains

List domains for an organization

Lists domains associated with an organization. Filter the results by verification status or enrollment mode, and use limit and offset to control the result window. The response includes the matching domains and their total count.

5 parameters
organization_idstringrequired
The unique identifier of the organization whose domains to list.
verifiedstringoptional
Filter domains by verification status using `true` or `false`.
enrollment_modestringoptional
Filter by `automatic_invitation`, `automatic_suggestion`, `manual_invitation`, or `enterprise_sso`; prefix a value with `-` to exclude it. Include and exclude filters can be combined and are applied together.
limitintegeroptional
Maximum number of domains to return. Must be between 1 and 500. Defaults to 10 when omitted.
Default:10
offsetintegeroptional
Number of results to skip; must be an integer greater than or equal to zero. Defaults to 0 when omitted.
Default:0

3 status codes
200Returns an object containing the matching organization domains in `data` and the total number of domains in `total_count`.
dataarray<object>required
total_countintegerrequired
Total number of organization domains
401Returned when authentication is invalid.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
422Returned when a request parameter is invalid.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 401 is returned when authentication is invalid. A 422 is returned when a request parameter is invalid; verified accepts true or false, and enrollment_mode accepts automatic_invitation, automatic_suggestion, manual_invitation, or enterprise_sso (prefix a value with - to exclude it). The organization_id path parameter must identify the organization, limit must be from 1 to 500, and offset must be zero or greater.