Retrieve Documents

get

https://example.com/documents/

Returns a list of Documents applicable to the scope of the API auth token

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

case

integer

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

entry_agent

integer

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

mod_agent

integer

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

date

string

Filter via Date. Will return all appointment slots configured for this date. Accepts YYYY-MM-DD format.

entry_date_before

string

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

entry_date_after

string

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

mod_date_before

string

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

mod_date_after

string

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

date_before

string

Filter via Document Date. Will return all Documents entered before the date. Accepts YYYY-MM-DD format. eg. date_before=2023-11-30 will return all Documents dated from before November 30th, 2023. Can be combined with date_after.

date_after

string

Filter via Document Date. Will return all Documents entered after the date. Accepts YYYY-MM-DD format. eg. date_after=2023-11-01 will return all Documents dated from after November 1st, 2023. Can be combined with date_before.

date_gte

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_lte

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).

entry_date_gte

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).

entry_date_lte

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).

mod_date_gte

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).

mod_date_lte

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).

order_by

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

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200search results matching criteria