Response

Each time a form is filled out, a response is generated. The response links all of the data together. To get a complete response, you will need to also include related values.

Response fields

Field	Type	Fillable	Reference
id	Integer
The unique ID to identify the response

Response relations

activity, activity.user, assigned, call, contact, contact.enrolments, device, event, event.parent, form, form.fields, form.fields.option, geoip, imports, labels, notes, notes.user, publication, synchronisations, synchronisations.integration, user, values, values.field, values.field.option, values.media,

Response endpoints

GET List all responses /responses toggle

GET Return data about a single Response /responses/:id toggle

POST Create, or Update a Response /responses/:id? toggle

URL slugs

id: Integer The unique ID to identify the response

Paramaters

assigned_id: Reference The ID of the user who is assigned to this response. References user model.
call_id: Reference The ID of the call the response was created during, if any. References call model.
contact_id: Reference References contact model.
created_at: Timestamp The date the response was created.
device_id: Reference References device model.
event_id: Reference References event model.
form_id: Reference References form model. Required
import_id: Reference References import model.
publication_id: Reference References publication model.
publication_page: Reference page in References publication model.
referer: String The HTTP Referer of the response
secret: String The secret allows unauthenticated access to update a single response if it was saved as a draft.
sync_status: String [No documentation available]
user_agent: String The user agent of the browser used
user_id: Reference References user model.

Response

Response fields

Response relations

Response endpoints

GET List all responses /responses toggle

Paramaters

Example response

GET Return data about a single Response /responses/:id toggle

URL slugs

Paramaters

Example response

POST Create, or Update a Response /responses/:id? toggle

URL slugs

Paramaters

POST Add a label to a response /responses/:id/add_label/:label_id toggle

URL slugs

Paramaters

POST Link a response to a contact /responses/:id/link/:contact_id toggle

URL slugs

Paramaters

POST Unlink a response from a contact /responses/:id/unlink/:contact_id toggle

URL slugs

Paramaters

POST Sync a response to the relevent CRM /responses/:id/sync toggle

URL slugs

Paramaters

DELETE Delete a Response /responses/:id toggle

URL slugs

Paramaters