Sign in
latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-14249167721.0 KB

75df3a43fcb2

Instance Settings

Fetch the current instance

Fetches the current instance

get/instance

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
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.

Example response

{
  "environment_type": "development",
  "allowed_origins": [
    "http://localhost:3000",
    "https://some-domain"
  ],
  "workspace_id": "org_2abc123def456"
}