Skip to main content
GET
cURL

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
author,
form,
organisation,
x-sources
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • in(id,[xxx]): Filter by form schema ID(s)
  • in(organisation,[xxx]): Filter by organisation ID(s)
  • in(form,[xxx]): Filter by form ID(s)

For more information on using named filters, see the docs

limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0
page
object

JSON:API pagination, as page[limit] and page[offset]. The same as the top-level limit and offset parameters; when both forms are sent, page[...] wins.

Response

Get a list of form schemas.

JSON API response object

data
A list of form schemas · object[]
required
meta
object
required
jsonapi
object
required
included
object[]

Related resources that can be included when a form is returned

A form