API Reference
  1. CT:OI External API
  2. Assistances
  3. Assistance Field Option

Retrieve Assistance Field Options

get
https://example.com/assistance_field_options

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

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

string

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

boolean

Filter via default state. Must supply boolean value - eg default=true

string

Filter via option name. Wildcards supported. e.g. name=B% will return all records beginning with 'B'. Do not use quotations like name="B%".

boolean

Filter by require_signature status. Returns records matching the supplied boolean value.

Response

Updated 4 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?