Sign in

v4

OpenAPI 3.0.02026-07-314441026.8 MB
Forms

List forms

get/forms

Query parameters

owner_idstring

Filter forms based on the owner.

work_assignment_idstring

Filter forms based on the Work Assignment.

employee_idstring

Filter forms owned by the Employee or the Employee's Work Assignments.

form_batch_idstring

Filter forms by Form Batch.

'rl1' | 'roe' | 't4' | 't4a' | 'td1' | 'td1ab' | 'td1bc' | 'td1mb' | 'td1nb' | 'td1nl' | 'td1ns' | 'td1nt' | 'td1nu' | 'td1on' | 'td1pe' | 'td1sk' | 'td1x' | 'td1yt' | 'tp_1015_3_v' | 'tp_1015_r_13_v'
OR
string[]

Filter forms based on the type of form.

'approved' | 'done' | 'draft' | 'processing' | 'rejected' | 'submitted'
OR
string[]

Filter forms based on the status of form.

owner_type'contractor' | 'employee' | 'work_assignment'

Filter forms based on the type of the form's owner.

owner_namestring

Filter forms based on the owner's name.

created_atobject

Only return forms with a created_at date matching the filter.

Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: created_at=2024-01-01 Use an array-like syntax to specify a range with one or more comparison operators:

  • gt (greater than)
  • gte (greater than or equal to)
  • lte (less than or equal to)
  • lt (less than) Example: created_at[gte]=2024-01-01&created_at[lt]=2024-12-31
fieldsobject[]

Filter forms by field content. An array of objects with field (required) and value (optional) keys. Providing only field returns forms that have any value for that field; providing both returns forms where that field matches the given value.

fields.*string
fields.*.fieldstring required
fields.*.valuestring
sort'effective_date'

Sort order is specified using the format sort=field[:direction][,field[:direction],...] where field is the name of the field to sort by and direction is the optional sort direction (asc or desc).

expandstring[]

Response

OK

objectstring

The type of the object in Nmbr ("list").