Formfield

All the endpoints that can be called on the Formfield controller.

Each endpoint requires the FORM_CUD permission, except for GET index, which requires the FORM_READ permission.

index

get

Returns all form fields with optional filters such as search queries, views and result limits.

Authorizations

apiKey

apiKeystringRequired

Query parameters

querystring · min: 1OptionalDefault: ""Pattern: ^[0-9a-zA-Z ]+$

itemStartnumberOptionalDefault: 0

itemLimitnumber · max: 9999OptionalDefault: 15

Responses

200Success

get

/api/v2/formfield

HTTPcURLJavaScriptPython

GET /api/v2/formfield HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*

200Success

No content

index

post

Creates a new form field.

If you want to add multiple required statuses, simply send an array of the statuses needed.

Authorizations

apiKey

apiKeystringRequired

Body

multipart/form-data

form_idnumberRequired

titlestring · min: 1Required

input_typestring · enumRequiredPossible values:

field_ordernumberOptional

Responses

200Success

post

/api/v2/formfield

HTTPcURLJavaScriptPython

POST /api/v2/formfield HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 93

{
  "form_id": 1,
  "title": "text",
  "input_type": "text",
  "field_order": 1,
  "required_statuses": [
    "open"
  ]
}

200Success

No content

item

get

Returns this specific form field by ID.

Authorizations

apiKey

apiKeystringRequired

Path parameters

idnumberRequired

Responses

200Success

get

/api/v2/formfield/{id}

HTTPcURLJavaScriptPython

GET /api/v2/formfield/{id} HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*

200Success

No content

item

put

Updates this form field.

Identical to POST index, except this one also has an external code parameter.

If you want to add multiple required statuses, simply send an array of the statuses needed.

Authorizations

apiKey

apiKeystringRequired

Path parameters

idnumberRequired

Body

application/x-www-form-urlencoded

form_idnumberRequired

titlestring · min: 1Required

input_typestring · enumRequiredPossible values:

field_ordernumberOptional

external_codestring · min: 1Optional

Responses

200Success

put

/api/v2/formfield/{id}

HTTPcURLJavaScriptPython

PUT /api/v2/formfield/{id} HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 116

"form_id=1&title='text'&input_type='text'&field_order=1&external_code='text'&required_statuses=['open']"

200Success

No content

item

delete

Permanently deletes this form field.

Authorizations

apiKey

apiKeystringRequired

Path parameters

idnumberRequired

Body

application/x-www-form-urlencoded

descriptionstringOptional

Optional parameter if you want to send a description for deletion.

Responses

200Success

delete

/api/v2/formfield/{id}

HTTPcURLJavaScriptPython

DELETE /api/v2/formfield/{id} HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 22

"description='text'"

200Success

No content