Get preference schema

Header Parameters

X-API-Keystring

Query Parameters

versionstring

Schema version number or 'latest'. Defaults to 'latest' if not provided.

Response

200
Object
Schema retrieved successfully

Response Attributes

tenantIdstring Required

The tenant identifier

schemaVersioninteger Required

The version number of the schema

releasedAtstring Required

When this schema version was released

prefsobject Required

The preference schema sections

isActiveboolean

Whether this schema version is currently active

401
Object
Unauthorized - Invalid API key

Response Attributes

messagestring

Error message

codestring

Error code

detailsobject

Additional error details

500
Object
Server error - schema not found

Response Attributes

errorsstring Required

Error code identifying the type of error

Enum values:
bad_requestunauthorizedforbiddennot_found500incorrect_datanot_memberalready_memberincorrect_stripe_signatureincorrect_stripe_event
... 4 other enums
Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?