{ "opencollection": "1.0.0", "info": { "name": "Clio API Documentation Activities API", "version": "v4" }, "items": [ { "info": { "name": "Activities", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all Activities", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/activities.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "activity_description_id", "value": "", "type": "query", "description": "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." }, { "name": "calendar_entry_id", "value": "", "type": "query", "description": "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." }, { "name": "communication_id", "value": "", "type": "query", "description": "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." }, { "name": "contact_note_id", "value": "", "type": "query", "description": "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." }, { "name": "created_since", "value": "", "type": "query", "description": "Filter Activity records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "name": "end_date", "value": "", "type": "query", "description": "Filter Activity records to those whose `date` is on or before the date provided (Expects an ISO-8601 date)." }, { "name": "expense_category_id", "value": "", "type": "query", "description": "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." }, { "name": "fields", "value": "", "type": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields)." }, { "name": "flat_rate", "value": "", "type": "query", "description": "Filter Activity TimeEntry records to those that have a flat rate, or not." }, { "name": "grant_id", "value": "", "type": "query", "description": "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." }, { "name": "ids[]", "value": "", "type": "query", "description": "Filter Activity records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of Activity records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "matter_id", "value": "", "type": "query", "description": "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." }, { "name": "matter_note_id", "value": "", "type": "query", "description": "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." }, { "name": "only_unaccounted_for", "value": "", "type": "query", "description": "Only unaccounted for activities." }, { "name": "order", "value": "", "type": "query", "description": "Orders the Activity records by the given field. Default: `id(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "query", "value": "", "type": "query", "description": "Wildcard search for `note` matching a given string." }, { "name": "start_date", "value": "", "type": "query", "description": "Filter Activity records to those whose `date` is on or after the date provided (Expects an ISO-8601 date)." }, { "name": "status", "value": "", "type": "query", "description": "Filter Activity records to those that are draft, billed, unbilled or non-billable." }, { "name": "task_id", "value": "", "type": "query", "description": "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." }, { "name": "type", "value": "", "type": "query", "description": "Filter Activity records to those of a specific type." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter Activity records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "name": "user_id", "value": "", "type": "query", "description": "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." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all Activities" }, { "info": { "name": "Create a new Activity", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/activities.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "fields", "value": "", "type": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when creating a new Activity" }, { "info": { "name": "Return the data for a single Activity", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/activities/:id.json", "headers": [ { "name": "IF-MODIFIED-SINCE", "value": "" }, { "name": "IF-NONE-MATCH", "value": "" }, { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "fields", "value": "", "type": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields)." }, { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Activity." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Activity" }, { "info": { "name": "Update a single Activity", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/activities/:id.json", "headers": [ { "name": "IF-MATCH", "value": "" }, { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "fields", "value": "", "type": "query", "description": "The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields)." }, { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Activity." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single Activity" }, { "info": { "name": "Delete a single Activity", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/activities/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Activity." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single Activity" } ] } ], "bundled": true }