Skip to main content
GET
cURL

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Headers

If-None-Match
string

A previously returned ETag. If it still matches the current representation the server responds 304 Not Modified with no body; otherwise the full representation is returned with a fresh ETag.

Path Parameters

schema_id
string<uuid>
required

The unique identifier for the schema.

Query Parameters

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
author,
form,
organisation,
x-sources

Response

Get a form schema.

JSON API response object

data
object
required

A form schema

jsonapi
object
required
included
object[]

Related resources that can be included when a form is returned

A form