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

Retrieve Assistance Values

get
https://example.com/assistance_values

Returns a list of Assistance Values 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 by ID. Will return all Assistance Values associated with the specified Assistance record.

integer

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

integer

Filter by field option ID. Must supply integer value.

string

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

string

Filter by numeric value of the assistance field.

string

Filter by decimal value of the assistance field.

date

Filter by date value of the assistance field. Format: YYYY-MM-DD.

boolean

Filter by checked 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?