Instance Settings

Fetch the current instance

Changed on

Fetches the current instance

get/instance

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/instance
  • Auth: HTTP bearer

Response

Success

object'instance' required

String representing the object's type. Objects of the same type share the same value.

idstring required
environment_typestring required
allowed_originsstring[] nullable required
allowed_subdomainsstring[] required

Subdomains of the instance's own domains that may originate requests, when the subdomain allowlist is enabled. Production instances only; always empty on a development instance.

subdomain_allowlist_enabledboolean required

Whether requests from subdomains of the instance's own domains are restricted to allowed_subdomains. When false, every subdomain of the instance's domain is accepted. Production instances only; always false on a development instance.

workspace_idstring nullable required

The ID of the Clerk workspace that owns the instance's application. It is null when the application has no owner.

max_allowed_usersinteger nullable required

The maximum number of users the instance can hold. Creating a user fails with a user_quota_exceeded error once the instance's total user count, as returned by GET /v1/users/count without filters, reaches this value. It is null when the instance has no user limit.

Example response

{
  "environment_type": "development",
  "allowed_origins": [
    "http://localhost:3000",
    "https://some-domain"
  ],
  "allowed_subdomains": [
    "app.example.com",
    "*.preview.example.com"
  ],
  "workspace_id": "org_2abc123def456",
  "max_allowed_users": 100
}

Changes

  • 2025-11-10a490313abffaRevision changes
    • info

      added the required property to the response with the status

  • 2025-11-10b5f30169c3f3Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status