Clerk Environment API
Used to get and update the current Environment
Clerk Environment API is one of 104 APIs that Clerk publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Environment. 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 2 operations across 1 path, and defines 35 schemas. It is described by OpenAPI 3.2.0, at version v1.
Requests are made against a single base URL, https://{domain}.clerk.accounts.dev.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 5
Clerk Environment API declares
5 security schemes
for authenticating requests.
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).
By default, every request must be authenticated, though some operations may also be called without credentials.
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.
Paths & Operations 2
Across 1 path, the API surfaces 2 operations — 1 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.
Used to get and update the current Environment
Schemas 35
The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are Client.DisplayConfig (43 properties), UserSettings.Socials (31 properties), Client.AuthConfig (20 properties), Client.UserSettings (12 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Clerk 12
Other APIs Clerk publishes across the network.
This is an independent, third-party profile of Clerk Environment 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.