How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Clerk Domains API

Domains represent each instance's URLs and DNS setup.

Clerk Domains API is one of 104 APIs that Clerk publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Domains. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 20 operations across 14 paths, and defines 66 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.clerk.com/v1, https://{domain}.clerk.accounts.dev.

20 operations 14 paths 66 schemas 3 DELETE8 GET2 PATCH7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.clerk.com/v1
Authentication
HTTP Bearer, API Key, API Key, HTTP Bearer, API Key, HTTP Basic, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 7

Clerk Domains API declares 7 security schemes for authenticating requests. It accepts HTTP bearer tokens (sk__) (bearerAuth). An API key is passed in the cookie as __client (ProductionBrowser). An API key is passed in the query as __dev_session (DevBrowser). It accepts HTTP bearer tokens (ProductionNativeApp). An API key is passed in the query as _is_native (ProductionNativeFlag). It accepts HTTP basic authentication (ClientCredentials). It accepts HTTP bearer tokens (platform_api_access_token).

  • bearerAuth — Secret key, obtained under "API Keys" in the Clerk Dashboard.
  • ProductionBrowser — The Client API token sent in the form of a browser cookie. Used to authenticate production browser applications.
  • DevBrowser — A Dev Browser API token sent as a query parameter. Used to authenticate only dev instances. To generate a dev instance API token you must first make a request…
  • ProductionNativeApp — The Client API token sent in the Authorization header. Used to authenticate native applications.
  • ProductionNativeFlag — If sent and the value is true, it instructs the server to parse the API token from the Authorization header. It should always be set to true when using the Aut…
  • ClientCredentials — HTTP Basic Authentication using Client ID as username and Client Secret as password.
  • platform_api_access_token — Platform API access token.

Paths & Operations 20

Across 14 paths, the API surfaces 20 operations — 3 DELETE, 8 GET, 2 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Domains 20

Domains represent each instance's URLs and DNS setup.

GET
/domains
List All Instance Domains
ListDomains → 200
POST
/domains
Add a Domain
AddDomain body → 200400402422
DELETE
/domains/{domain_id}
Delete a Satellite Domain
DeleteDomain 1 param → 200403404
PATCH
/domains/{domain_id}
Update a Domain
UpdateDomain 1 param body → 200400404422
POST
/v1/organizations/{organization_id}/domains
Create Organization Domain
CreateOrganizationDomain 1 param body → 200401403404422
GET
/v1/organizations/{organization_id}/domains
Get All Organization Domains
ListOrganizationDomains 5 params → 200401403422
GET
/v1/organizations/{organization_id}/domains/{domain_id}
Get Organization Domain
GetOrganizationDomain 2 params → 200401403404422
DELETE
/v1/organizations/{organization_id}/domains/{domain_id}
Delete Organization Domain
deleteOrganizationDomain 2 params → 200401403404422
POST
/v1/organizations/{organization_id}/domains/{domain_id}/update_enrollment_mode
Update Organization Enrollment Mode
UpdateOrganizationDomainEnrollmentMode 2 params body → 200401403404422
POST
/v1/organizations/{organization_id}/domains/{domain_id}/prepare_affiliation_verification
Prepare Organization Domain Affiliation Verification
prepareOrganizationDomainVerification 2 params body → 200401403404422
POST
/v1/organizations/{organization_id}/domains/{domain_id}/attempt_affiliation_verification
Attempt Organization Domain Affiliation Verification
attemptOrganizationDomainVerification 2 params body → 200400401403404422
PATCH
/platform/applications/{applicationID}/domain
Update Application Domain
PlatformUpdateApplicationDomain 1 param body → 200400401403404422
GET
/platform/applications/{applicationID}/domains
List Application Domains
PlatformListApplicationDomains 1 param → 200401403404
POST
/platform/applications/{applicationID}/domains
Create Application Domain
PlatformCreateApplicationDomain 1 param body → 201400401403404409422
GET
/platform/applications/{applicationID}/domains/{domainIDOrName}
Get Application Domain
PlatformGetApplicationDomain 2 params → 200400401403404
DELETE
/platform/applications/{applicationID}/domains/{domainIDOrName}
Delete Application Domain
PlatformDeleteApplicationDomain 2 params → 200400401403404422
GET
/platform/applications/{applicationID}/domains/{domainIDOrName}/status
Get Application Domain Status
PlatformGetApplicationDomainStatus 2 params → 200400401403404
POST
/platform/applications/{applicationID}/domains/{domainIDOrName}/dns_check
Trigger DNS Check
PlatformTriggerDNSCheck 2 params → 200400401403404409
GET
/platform/domains
List Domains
PlatformListDomains 5 params → 200401403422
GET
/platform/domains/{domainIDOrName}
Get Domain
PlatformGetDomain 1 param → 200401403404

Schemas 66

The contract defines 66 schemas that model the data the API accepts and returns. The most detailed are Client.User (42 properties), Client.SignUp (23 properties), ExternalAccountWithVerification (19 properties), PlatformDomainResponse (14 properties). Each schema is shown below with its type and property counts.

DeletedObject
object
5 properties 2 required
CNameTarget
object
3 properties 3 required
ClerkError
object
4 properties 3 required
ClerkErrors
object
3 properties 1 required
Domains
object
2 properties 2 required
Domain
object
9 properties 6 required
Stubs.Verification.SAML
object
7 properties 2 required
Stubs.Verification.Link
object
6 properties 3 required
Client.Passkey
object
7 properties 4 required
Stubs.SignInFactor
object
11 properties 1 required
Stubs.Verification.BackupCode
object
5 properties 2 required
Stubs.Verification.FromOauth
object
5 properties 2 required
Client.ClientWrappedOrganizationDomain
object
2 properties 2 required
Client.OrganizationDomainVerification
object
4 properties 4 required
Token
object
2 properties 2 required
Stubs.Verification.Admin
object
5 properties 2 required
Client.EmailAddress
object
9 properties 8 required
ExternalAccountWithVerification
object
19 properties 13 required
Client.OrganizationMembership
object
10 properties 9 required
Client.PublicUserData
object
9 properties 4 required
verification_oauth
object
8 properties 4 required
Stubs.Verification.Ticket
object
5 properties 2 required
schemas-Client.Session
Stubs.Verification.Passkey
object
6 properties 3 required
Stubs.Verification.Web3Signature
object
7 properties 2 required
Client.SessionTask
object
1 property 1 required
Client.PublicOrganizationData
object
5 properties 4 required
schemas-Client.Client
objectnull
11 properties 11 required
Client.User
object
42 properties 35 required
Stubs.Verification.Oauth
object
7 properties 3 required
Client.ClientWrappedDeletedObject
object
2 properties 2 required
Client.Organization
object
14 properties 10 required
Stubs.SAMLConnection.SAMLAccount
object
13 properties 7 required
Client.SignUp
object
23 properties 21 required
Client.Web3Wallet
object
6 properties 6 required
schemas-Client.SignIn
object
13 properties 12 required
schemas-Client.SessionBase
object
9 properties 6 required
Client.PhoneNumber
object
11 properties 8 required
Client.SignUp.Verifications
object
4 properties 4 required
Client.DeletedObject
object
4 properties 2 required
Stubs.Verification.Invitation
object
5 properties 2 required
Stubs.Identification.Link
object
2 properties 2 required
verification_google_one_tap
object
7 properties 4 required
Stubs.Verification.TOTP
object
5 properties 2 required
Stubs.Verification.OTP
object
5 properties 3 required
Client.ClientWrappedOrganizationDomains
object
2 properties 2 required
Stubs.Verification.GoogleOneTap
object
5 properties 2 required
Stubs.SignUpVerification.AdditionalFields
object
2 properties 2 required
Client.OrganizationDomain
object
12 properties 11 required
Stubs.Verification.Password
object
5 properties 2 required
Client.SAMLAccount
object
13 properties 11 required
PlatformListDomainsResponse
object
A paginated list of domains across the workspace.
2 properties 2 required
PlatformDNSCheckResponse
Response from triggering a DNS check. Includes the current domain status along with metadata about the check.
CNAMEStatus
object
7 properties 6 required
PlatformUpdateApplicationDomainRequest
object
2 properties 1 required
PlatformDomainApplicationSummary
object
4 properties 4 required
DNSStatus
object
2 properties 2 required
PlatformWorkspaceDomainResponse
PlatformCreateApplicationDomainRequest
object
2 properties 1 required
PlatformDomainResponse
object
14 properties 7 required
SSLStatus
object
3 properties 3 required
FailureHint
object
2 properties 2 required
PlatformDomainInstanceSummary
object
5 properties 5 required
PlatformDeletedObjectResponse
object
3 properties 3 required
PlatformListApplicationDomainsResponse
object
A paginated list of application domains.
2 properties 2 required
PlatformDomainStatusResponse
object
6 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

clerk-com-domains-api-openapi.yml Raw ↑

Other APIs Clerk publishes across the network.

Clerk Account Portal API
Clerk Active Sessions API
Clerk Actor Tokens API
Clerk Agent Tasks API
Clerk Allow-list / Block-list API
Clerk API Keys API
Clerk Application Transfers API
Clerk Applications API
Clerk Backup Codes API
Clerk Beta Features API
Clerk Billing API
Clerk Checkouts API
Where this information came from

This is an independent, third-party profile of Clerk Domains API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.