Retrieve Assistance Fields

get

https://example.com/assistance_fields

Returns a list of Assistance Fields applicable to the scope of the API auth token

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

agency

integer

Filter via Agency by ID. Will return all Assistance Field records that are associated with the provided Agency.

template_key

string

Filter via Template Key. Wildcards supported. eg. template_key=B% will return all Assistance Fields with a template key beginning with 'B'. Do not use quotations like template_key="B%".

field_type

string

Filter via Field Type. Accepted values are "date", "select", "checklist", "integer", "decimal", and "text".

required

boolean

Filter via required boolean value, accepts true or false. Determines whether or not an Assistance Field is required when creating an Assistance Record via the user interface.

disabled

boolean

Filter via disabled boolean value, accepts true or false. Determines whether or not an Assistance Field is enabled or disabled when creating an Assistance Record via the user interface.

200search results matching criteria