Sign in

v1

latestOpenAPI 3.0.02026-08-063014193.1 MB
Activities

Return the data for all Activities

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

get/activities.json

Query parameters

activity_description_idinteger

The unique identifier for a single ActivityDescription. Use the keyword null to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.

calendar_entry_idinteger

The unique identifier for a single CalendarEntry. Use the keyword null to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.

communication_idinteger

The unique identifier for a single Communication. Use the keyword null to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.

contact_note_idinteger

The unique identifier for a single Note. Use the keyword null to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.

created_sincestring date-time

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

end_datestring date-time

Filter Activity records to those whose date is on or before the date provided (Expects an ISO-8601 date).

expense_category_idinteger

The unique identifier for a single ExpenseCategory. Use the keyword null to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.

fieldsstring

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

flat_rateboolean

Filter Activity TimeEntry records to those that have a flat rate, or not.

grant_idinteger

The unique identifier for a single Grant. Use the keyword null to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.

ids[]integer

Filter Activity records to those having the specified unique identifiers.

limitinteger

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

matter_idinteger

The unique identifier for a single Matter. Use the keyword null to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.

matter_note_idinteger

The unique identifier for a single Note. Use the keyword null to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.

only_unaccounted_forboolean

Only unaccounted for activities.

order'id(asc)' | 'id(desc)' | 'display_number(asc)' | 'display_number(desc)' | 'user.name(asc)' | 'user.name(desc)' | 'price(asc)' | 'price(desc)' | 'total(asc)' | 'total(desc)' | 'type(asc)' | 'type(desc)' | 'date(asc)' | 'date(desc)' | 'note(asc)' | 'note(desc)' | 'updated_at(asc)' | 'updated_at(desc)' | 'vendor.name(asc)' | 'vendor.name(desc)' | 'expense_category.name(asc)' | 'expense_category.name(desc)' | 'non_billable(asc)' | 'non_billable(desc)' | 'non_billable_total(asc)' | 'non_billable_total(desc)'

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

page_tokenstring

A token specifying which page to return.

querystring

Wildcard search for note matching a given string.

start_datestring date-time

Filter Activity records to those whose date is on or after the date provided (Expects an ISO-8601 date).

status'billed' | 'draft' | 'unbilled' | 'non_billable' | 'billable' | 'written_off'

Filter Activity records to those that are draft, billed, unbilled or non-billable.

task_idinteger

The unique identifier for a single Task. Use the keyword null to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.

type'TimeEntry' | 'ExpenseEntry' | 'HardCostEntry' | 'SoftCostEntry'

Filter Activity records to those of a specific type.

updated_sincestring date-time

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

user_idinteger

The unique identifier for a single User. Use the keyword null to match those without a Activity. The list will be filtered to include only the Activity records with the matching property.

Headers

X-API-VERSIONstring

The API minor version. Default: latest version.

Response

Ok