Skip to main content
GET
/
v1
/
onboarding
/
partner
/
applications
/
{applicationId}
/
schema
Get the JSON Schema (draft 2020-12) for an application's template
curl --request GET \
  --url https://api.circle.com/v1/onboarding/partner/applications/{applicationId}/schema \
  --header 'Authorization: Bearer <token>'
{}

Authorizations

​
Authorization
string
header
required

Bearer token obtained via Circle key exchange

Path Parameters

​
applicationId
string<uuid>
required

Application UUID

Query Parameters

​
resolved
boolean
default:false

When true, prune sections and conditional fields that definitively do not apply to the application's saved data and add a top-level "x-resolved": true marker. Indeterminate branches (parent field not yet saved) are kept. Defaults to false (the full canonical schema).

Response

JSON Schema (draft 2020-12) describing the required fields for this application's template

A JSON Schema document whose structure varies by application template.