v1

latestOpenAPI 3.0.32026-07-246304082.0 MB

forms

Get all forms in project

get/api/v3/projects/{project_id}/forms

Path parameters

project_idstring uuid required

ID of the project this entity belongs to

Query parameters

last_synced_atstring date-time

Timestamp since when further updates should be included

filters[form_template_id_eq]string

Example:26462387-8f00-4118-8f1c-419ec8761c23

Filter on form_template_id field being equal to passed in value, allows for filtering with a array of values

filters[owner_user_id_eq]string

Example:100

Filter on owner_user_id field being equal to the passed in value, allows for filtering with a array of values

filters[creator_user_id_eq]string

Example:100

Filter on creator_user_id field being equal to the passed in value, allows for filtering with a array of values

filters[created_at_gte]string

Example:2009-06-15T13:45:30Z

Filter on created_at field being greater than or equal to the passed in value

filters[created_at_gt]string

Example:2009-06-15T13:45:30Z

Filter on created_at field being greater than the passed in value

filters[created_at_lte]string

Example:2009-06-15T13:45:30Z

Filter on created_at field being less than or equal to the passed in value

filters[created_at_lt]string

Example:2009-06-15T13:45:30Z

Filter on created_at field being less than to the passed in value

filters[name_like]string

Example:Form 1

Filter on name field being like passed in value

filters[name_eq]string

Example:Form 1

Filter on name field being equal to passed in value, allows for filtering with a array of values

filters[updated_at_gte]string

Example:2009-06-15T13:45:30Z

Filter on updated_at field being greater than or equal to the passed in value

filters[updated_at_gt]string

Example:2009-06-15T13:45:30Z

Filter on updated_at field being greater than the passed in value

filters[updated_at_lte]string

Example:2009-06-15T13:45:30Z

Filter on updated_at field being less than or equal to the passed in value

filters[updated_at_lt]string

Example:2009-06-15T13:45:30Z

Filter on updated_at field being less than to the passed in value

filters[due_date_gte]string

Example:2009-06-15T13:45:30Z

Filter on due_date field being greater than or equal to the passed in value

filters[due_date_gt]string

Example:2009-06-15T13:45:30Z

Filter on due_date field being greater than the passed in value

filters[due_date_lte]string

Example:2009-06-15T13:45:30Z

Filter on due_date field being less than or equal to the passed in value

filters[due_date_lt]string

Example:2009-06-15T13:45:30Z

Filter on due_date field being less than to the passed in value

filters[end_at_gte]string

Example:2009-06-15T13:45:30Z

Filter on end_at field being greater than or equal to the passed in value

filters[end_at_gt]string

Example:2009-06-15T13:45:30Z

Filter on end_at field being greater than the passed in value

filters[end_at_lte]string

Example:2009-06-15T13:45:30Z

Filter on end_at field being less than or equal to the passed in value

filters[end_at_lt]string

Example:2009-06-15T13:45:30Z

Filter on end_at field being less than to the passed in value

Headers

Fieldwire-Versionstring date required

Specifies the version of the API to talk to

Fieldwire-Filter'active' | 'deleted'

Specifies if request should include active, deleted or all (default) entities

Fieldwire-Per-Pageinteger

Specifies the number of entities to include in the request

Response

Successful response

idstring uuid required

ID of the entity

creator_user_idinteger required

ID of the user who created this entity

last_editor_user_idinteger required

ID of the user who most recently edited this entity

owner_user_idinteger required

ID of the user who owns this form

form_template_form_status_idstring uuid required

ID of the status this form currently is in

form_template_idstring uuid required

ID of the template this form was created from

project_idstring uuid required

ID of the project this entity belongs to

is_generatedboolean required

Whether this form is fully generated (in case cloning from another form)

checksumstring required

Checksum used for verifying whether all relevant structural information for a form is at hand

namestring required

Name of the entity

kind'default' | 'time_range' | 'single_day' required

Kind of the entity

sequence_numberinteger required

Unique number that denotes this form scoped to the template

versioninteger required

Version of the template this form was built out of

created_atstring date-time required

Time when the server created the form

deleted_atstring date-time nullable

Time the server deleted the form

device_created_atstring date-time required

Time when the device created the form

device_updated_atstring date-time required

Time when the device last updated the form

end_atstring date-time nullable

Time when this form is marked as ending

start_atstring date-time nullable

Time when this form is marked as starting

due_datestring date nullable

Time when this form is marked as due

due_date_notifiedboolean nullable

Whether due date notification for this form has been sent

resolved_conflictboolean nullable required

Specifies if PUT/PATCH request was rejected - do not store this field!

updated_atstring date-time required

Time when the server last updated the form

view_edit_permissions'assignee' | 'all_users' | 'null' nullable

View/edit permissions for the form, e.g. assignee, all_users. Consider using form_permissions instead.

form_type'default' | 'fillable_pdf' required

The type of form either custom fieldwire or a fillable_pdf