API Reference
  1. CT:OI External API
  2. Forms
  3. CaseForm

Retrieve Case Forms

get
https://example.com/case_forms/

Returns a list of Case Forms 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 Case by ID. Must supply integer value, cannot search by Case name or other field information.

integer

Filter via Entry Agent by ID. Will return all Case Forms entered by the specified agent.

integer

Filter via last Modification Agent by ID. Will return all Case Forms that were last modified by the specified agent.

integer

Filter via Agency by ID. Must supply integer value, cannot search by Agency name or other field information.

integer

Filter via Form Type by ID. Must supply integer value, cannot search by Form Type name or other field information.

string

Filter via Date. Will return all Case Forms with this date. Accepts YYYY-MM-DD format.

string

Filter via Date. Will return all Case Forms with a date value before the date. Accepts YYYY-MM-DD format. eg. date_before=2023-11-30 will return all Case Forms with dates before November 30th, 2023. Can be combined with date_after.

string

Filter via Date. Will return all Case Forms with a date value after the provided date. Accepts YYYY-MM-DD format. eg. date_after=2023-11-01 will return all Case Forms with dates after November 1st, 2023. Can be combined with mod_date_before.

string

Filter via Entry Date. Will return all Case Forms entered before the date. Accepts YYYY-MM-DD format. eg. entry_date_before=2023-11-30 will return all Case Forms from before November 30th, 2023. Can be combined with entry_date_after.

string

Filter via Entry Date. Will return all Case Forms entered after the date. Accepts YYYY-MM-DD format. eg. entry_date_after=2023-11-01 will return all Case Forms from after November 1st, 2023. Can be combined with entry_date_before.

string

Filter via last Modification Date. Will return all Case Forms modified before the date. Accepts YYYY-MM-DD format. eg. mod_date_before=2023-11-30 will return all Case Forms last modified before November 30th, 2023. Can be combined with mod_date_after.

string

Filter via last Modification Date. Will return all Case Forms modified after the date. Accepts YYYY-MM-DD format. eg. mod_date_after=2023-11-01 will return all Case Forms last modified after November 1st, 2023. Can be combined with mod_date_before.

date-time

Return records with a date on or after this date/datetime. Cannot be combined with date_after. Accepted formats: ISO 8601 (eg. 2026-05-01T00:00:00 or 2026-05-01).

date-time

Return records with a date on or before this date/datetime. Cannot be combined with date_before. Accepted formats: ISO 8601 (eg. 2026-05-31T23:59:59 or 2026-05-31).

date-time

Return records entered on or after this date/datetime. Cannot be combined with entry_date_after. Accepted formats: ISO 8601 (eg. 2026-05-01T00:00:00 or 2026-05-01).

date-time

Return records entered on or before this date/datetime. Cannot be combined with entry_date_before. Accepted formats: ISO 8601 (eg. 2026-05-31T23:59:59 or 2026-05-31).

date-time

Return records last modified on or after this date/datetime. Cannot be combined with mod_date_after. Accepted formats: ISO 8601 (eg. 2026-05-01T00:00:00 or 2026-05-01).

date-time

Return records last modified on or before this date/datetime. Cannot be combined with mod_date_before. Accepted formats: ISO 8601 (eg. 2026-05-31T23:59:59 or 2026-05-31).

string

Order results by a field name. Prefix with - for descending order. eg. order_by=mod_date for ascending or order_by=-mod_date for descending. Must be a valid field on the resource; an invalid field returns a 400 error.

Response

Updated 2 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 2 months ago

Did this page help you?