Sign in

v1

latestOpenAPI 3.0.02026-08-063014193.1 MB
Report Presets

Return the data for all ReportPresets

Outlines the parameters, optional and required, used when requesting the data for all ReportPresets

get/report_presets.json

Query parameters

category'billing' | 'client' | 'compliance' | 'financial' | 'matter' | 'online_payments' | 'productivity' | 'revenue' | 'task'

Filters ReportPreset data by category.

created_sincestring date-time

Filter ReportPreset records to those having the created_at field after a specific time. (Expects an ISO-8601 timestamp).

fieldsstring

The fields to be returned. See response samples for what fields are available. For more information see the fields section.

has_scheduleboolean

Filters ReportPreset records to those that have or do not have a Report Schedule.

ids[]integer

Filter ReportPreset records to those having the specified unique identifiers.

limitinteger

A limit on the number of ReportPreset records to be returned. Limit can range between 1 and 200. Default: 200.

order'created_at(asc)' | 'created_at(desc)' | 'last_generated_at(asc)' | 'last_generated_at(desc)' | 'last_modified_at(asc)' | 'last_modified_at(desc)' | 'name(asc)' | 'name(desc)' | 'next_scheduled_date(asc)' | 'next_scheduled_date(desc)'

Orders the ReportPreset records by the given field. Default: id(asc).

output_formatstring

Filters ReportPreset data by format.

page_tokenstring

A token specifying which page to return.

querystring

Wildcard search for ReportPreset name.

schedule_frequency'daily' | 'weekly' | 'monthly'

Filters ReportPreset records to those that have a Report Schedule of the specified frequency.

updated_sincestring date-time

Filter ReportPreset records to those having the updated_at field after a specific time. (Expects an ISO-8601 timestamp).

Headers

X-API-VERSIONstring

The API minor version. Default: latest version.

Response

Ok