Skip to main content
GET
List form field maps

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • eq(id,xxx): Filter form field maps by ID.
  • eq(organisation,xxx): Filter form field maps by organisation ID.
  • eq(form,xxx): Filter form field maps by form ID.

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

Response

Get a list of form field maps.

JSON API response object

data
A list of form field maps · object[]
required
meta
object
required
jsonapi
object
required