{ "opencollection": "1.0.0", "info": { "name": "Clio API Documentation", "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" } ] }, { "info": { "name": "Activity Rates", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all ActivityRates", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/activity_rates.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "co_counsel_contact_id", "value": "", "type": "query", "description": "The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the ActivityRate records with the matching property." }, { "name": "contact_id", "value": "", "type": "query", "description": "The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the ActivityRate records with the matching property." }, { "name": "created_since", "value": "", "type": "query", "description": "Filter ActivityRate records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter ActivityRate records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of ActivityRate records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter ActivityRate records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all ActivityRates" }, { "info": { "name": "Create a new ActivityRate", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/activity_rates.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 ActivityRate" }, { "info": { "name": "Return the data for a single ActivityRate", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/activity_rates/: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 ActivityRate." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single ActivityRate" }, { "info": { "name": "Update a single ActivityRate", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/activity_rates/: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 ActivityRate." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single ActivityRate" }, { "info": { "name": "Delete a single ActivityRate", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/activity_rates/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the ActivityRate." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single ActivityRate" } ] }, { "info": { "name": "Activity Descriptions", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all ActivityDescriptions", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/activity_descriptions.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter ActivityDescription records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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 ActivityDescription records to those that have a flat rate, or not." }, { "name": "ids[]", "value": "", "type": "query", "description": "Filter ActivityDescription records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of ActivityDescription records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "rate_for[matter_id]", "value": "", "type": "query", "description": "Matter id for rate calculation." }, { "name": "rate_for[user_id]", "value": "", "type": "query", "description": "User id for rate calculation. If not provided, the user associated to the API request is assumed." }, { "name": "type", "value": "", "type": "query", "description": "Filter ActivityDescription records to those of a specific type." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter ActivityDescription 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. The keyword `null` is not valid for this field. The list will be filtered to include only the ActivityDescription records with the matching property." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all ActivityDescriptions" }, { "info": { "name": "Create a new ActivityDescription", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/activity_descriptions.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 ActivityDescription" }, { "info": { "name": "Return the data for a single ActivityDescription", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/activity_descriptions/: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 ActivityDescription." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single ActivityDescription" }, { "info": { "name": "Update a single ActivityDescription", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/activity_descriptions/: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 ActivityDescription." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single ActivityDescription" }, { "info": { "name": "Delete a single ActivityDescription", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/activity_descriptions/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the ActivityDescription." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single ActivityDescription" } ] }, { "info": { "name": "Allocations", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all Allocations", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/allocations.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "bill_id", "value": "", "type": "query", "description": "The unique identifier for a single Bill. The keyword `null` is not valid for this field. The list will be filtered to include only the Allocation records with the matching property." }, { "name": "contact_id", "value": "", "type": "query", "description": "The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the Allocation records with the matching property." }, { "name": "created_since", "value": "", "type": "query", "description": "Filter Allocation records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter Allocation records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of Allocation 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. The keyword `null` is not valid for this field. The list will be filtered to include only the Allocation records with the matching property." }, { "name": "order", "value": "", "type": "query", "description": "Orders the Allocation records by the given field. Default: `date(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "parent_id", "value": "", "type": "query", "description": "ID of parent (either a Payment or CreditMemo) this allocation belongs to" }, { "name": "parent_type", "value": "", "type": "query", "description": "Filter Allocation records based on whether the parent is a CreditMemo or a Payment." }, { "name": "status", "value": "", "type": "query", "description": "Filter Allocation records to only those that are voided (`\"invalid\"`) or not voided (`\"valid\"`)." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter Allocation records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all Allocations" }, { "info": { "name": "Return the data for a single Allocation", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/allocations/: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 Allocation." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Allocation" } ] }, { "info": { "name": "Bank Accounts", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all BankAccounts", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/bank_accounts.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter BankAccount records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter BankAccount records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of BankAccount records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "order", "value": "", "type": "query", "description": "Orders the BankAccount records by the given field. Default: `id(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "show_empty_accounts", "value": "", "type": "query", "description": "Filter BankAccount records to those having a zero or non zero balance." }, { "name": "status", "value": "", "type": "query", "description": "Filter BankAccount records to those having a specific status." }, { "name": "type", "value": "", "type": "query", "description": "Filter BankAccount records to those having a specific type." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter BankAccount 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 BankAccount. The list will be filtered to include only the BankAccount records with the matching property." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all BankAccounts" }, { "info": { "name": "Create a new BankAccount", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/bank_accounts.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 BankAccount" }, { "info": { "name": "Return the data for a single BankAccount", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/bank_accounts/: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 BankAccount." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single BankAccount" }, { "info": { "name": "Update a single BankAccount", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/bank_accounts/: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 BankAccount." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single BankAccount" }, { "info": { "name": "Delete a single BankAccount", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/bank_accounts/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the BankAccount." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single BankAccount" } ] }, { "info": { "name": "Bank Transactions", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all BankTransactions", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/bank_transactions.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "bank_account_id", "value": "", "type": "query", "description": "The unique identifier for a single BankAccount. The keyword `null` is not valid for this field. The list will be filtered to include only the BankTransaction records with the matching property." }, { "name": "client_id", "value": "", "type": "query", "description": "The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the BankTransaction records with the matching property." }, { "name": "created_since", "value": "", "type": "query", "description": "Filter BankTransaction records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter BankTransaction records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of BankTransaction 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. The keyword `null` is not valid for this field. The list will be filtered to include only the BankTransaction records with the matching property." }, { "name": "order", "value": "", "type": "query", "description": "Orders the BankTransaction records by the given field. Default: `id(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "type", "value": "", "type": "query", "description": "Filter BankTransaction records to those having a specific type." }, { "name": "unreconciled_only", "value": "", "type": "query", "description": "Filter BankTransaction records to only those that are unreconciled" }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter BankTransaction records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all BankTransactions" }, { "info": { "name": "Create a new BankTransaction", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/bank_transactions.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 BankTransaction" }, { "info": { "name": "Return the data for a single BankTransaction", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/bank_transactions/: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 BankTransaction." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single BankTransaction" }, { "info": { "name": "Update a single BankTransaction", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/bank_transactions/: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 BankTransaction." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single BankTransaction" }, { "info": { "name": "Delete a single BankTransaction", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/bank_transactions/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the BankTransaction." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single BankTransaction" } ] }, { "info": { "name": "Bank Transfers", "type": "folder" }, "items": [ { "info": { "name": "Return the data for a single BankTransfer", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/bank_transfers/: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 BankTransfer." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single BankTransfer" } ] }, { "info": { "name": "Bill Themes", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all BillThemes", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/bill_themes.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter BillTheme records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter BillTheme records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of BillTheme records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter BillTheme records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all BillThemes" }, { "info": { "name": "Update a single BillTheme", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/bill_themes/: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 BillTheme." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single BillTheme" } ] }, { "info": { "name": "Billable Clients", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all BillableClients", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/billable_clients.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "client_id", "value": "", "type": "query", "description": "The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the BillableClient records with the matching property." }, { "name": "custom_field_values", "value": "", "type": "query", "description": "Filter records to only those with the given custom field(s) set. The value is compared using the operator provided, or,\nif the value type only supports one operator, the supported operator is used. In the latter case, no check for operator is performed on the input string.\nThe key for the custom field value filter is the custom_field.id. e.g. `custom_field_values[12345]`\nIf an operator is used for a type that does not support it, an `400 Bad Request` is returned.\n\n*Supported operators:*\n* `checkbox`, `contact`, `matter`, `picklist` : `=`\n\ne.g. `?custom_field_values[1]=42`\n\n* `currency`, `date`, `time`, `numeric` : `=`, `<`, `>`, `<=`, `>=`\n\ne.g. `?custom_field_values[1]=>=105.4`\n\n* `email`, `text_area`, `text_line`, `url` : `=`\n\ne.g. `?custom_field_values[1]=url_encoded`\n\n*Multiple conditions for the same custom field:*\n\nIf you want to use more than one operator to filter a custom field, you can do so by passing in an array of values.\ne.g. `?custom_field_values[1]=[<=50, >=45]`\n" }, { "name": "end_date", "value": "", "type": "query", "description": "Filter BillableClient records to those that have Matters with unbilled Activities on or before this date (Expects an ISO-8601 date)." }, { "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": "limit", "value": "", "type": "query", "description": "A limit on the number of BillableClient records to be returned. Limit can range between 1 and 25. Default: `25`." }, { "name": "matter_id", "value": "", "type": "query", "description": "The unique identifier for a single Matter. The keyword `null` is not valid for this field. The list will be filtered to include only the BillableClient records with the matching property." }, { "name": "originating_attorney_id", "value": "", "type": "query", "description": "The unique identifier for a single User. Use the keyword `null` to match those without a BillableClient. The list will be filtered to include only the BillableClient records with the matching property." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "query", "value": "", "type": "query", "description": "Wildcard search for `display_number` or `number` or `description` matching a given string." }, { "name": "responsible_attorney_id", "value": "", "type": "query", "description": "The unique identifier for a single User. Use the keyword `null` to match those without a BillableClient. The list will be filtered to include only the BillableClient records with the matching property." }, { "name": "start_date", "value": "", "type": "query", "description": "Filter BillableClient records to those that have Matters with unbilled Activities on or after this date (Expects an ISO-8601 date)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all BillableClients" } ] }, { "info": { "name": "Billable Matters", "type": "folder" }, "items": [ { "info": { "name": "Returns the unique identifiers of all BillableMatter", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/billable_matters/ids.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "client_id", "value": "", "type": "query", "description": "The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the BillableMatter records with the matching property." }, { "name": "custom_field_values", "value": "", "type": "query", "description": "Filter records to only those with the given custom field(s) set. The value is compared using the operator provided, or,\nif the value type only supports one operator, the supported operator is used. In the latter case, no check for operator is performed on the input string.\nThe key for the custom field value filter is the custom_field.id. e.g. `custom_field_values[12345]`\nIf an operator is used for a type that does not support it, an `400 Bad Request` is returned.\n\n*Supported operators:*\n* `checkbox`, `contact`, `matter`, `picklist` : `=`\n\ne.g. `?custom_field_values[1]=42`\n\n* `currency`, `date`, `time`, `numeric` : `=`, `<`, `>`, `<=`, `>=`\n\ne.g. `?custom_field_values[1]=>=105.4`\n\n* `email`, `text_area`, `text_line`, `url` : `=`\n\ne.g. `?custom_field_values[1]=url_encoded`\n\n*Multiple conditions for the same custom field:*\n\nIf you want to use more than one operator to filter a custom field, you can do so by passing in an array of values.\ne.g. `?custom_field_values[1]=[<=50, >=45]`\n" }, { "name": "end_date", "value": "", "type": "query", "description": "Filter BillableMatter records to those that have matters with unbilled activities on or before this date (Expects an ISO-8601 date)." }, { "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": "limit", "value": "", "type": "query", "description": "A limit on the number of BillableMatter records to be returned. Limit can range between 1 and 1000. Default: `1000`." }, { "name": "matter_id", "value": "", "type": "query", "description": "The unique identifier for a single Matter. The keyword `null` is not valid for this field. The list will be filtered to include only the BillableMatter records with the matching property." }, { "name": "originating_attorney_id", "value": "", "type": "query", "description": "The unique identifier for a single User. Use the keyword `null` to match those without a BillableMatter. The list will be filtered to include only the BillableMatter records with the matching property." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "query", "value": "", "type": "query", "description": "Wildcard search for `display_number` or `number` or `description` matching a given string." }, { "name": "responsible_attorney_id", "value": "", "type": "query", "description": "The unique identifier for a single User. Use the keyword `null` to match those without a BillableMatter. The list will be filtered to include only the BillableMatter records with the matching property." }, { "name": "start_date", "value": "", "type": "query", "description": "Filter BillableMatter records to those that have matters with unbilled activities on or after this date (Expects an ISO-8601 date)." } ] }, "docs": "This data is retrieved asynchronously" }, { "info": { "name": "Return the data for all BillableMatters", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/billable_matters.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "client_id", "value": "", "type": "query", "description": "The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the BillableMatter records with the matching property." }, { "name": "custom_field_values", "value": "", "type": "query", "description": "Filter records to only those with the given custom field(s) set. The value is compared using the operator provided, or,\nif the value type only supports one operator, the supported operator is used. In the latter case, no check for operator is performed on the input string.\nThe key for the custom field value filter is the custom_field.id. e.g. `custom_field_values[12345]`\nIf an operator is used for a type that does not support it, an `400 Bad Request` is returned.\n\n*Supported operators:*\n* `checkbox`, `contact`, `matter`, `picklist` : `=`\n\ne.g. `?custom_field_values[1]=42`\n\n* `currency`, `date`, `time`, `numeric` : `=`, `<`, `>`, `<=`, `>=`\n\ne.g. `?custom_field_values[1]=>=105.4`\n\n* `email`, `text_area`, `text_line`, `url` : `=`\n\ne.g. `?custom_field_values[1]=url_encoded`\n\n*Multiple conditions for the same custom field:*\n\nIf you want to use more than one operator to filter a custom field, you can do so by passing in an array of values.\ne.g. `?custom_field_values[1]=[<=50, >=45]`\n" }, { "name": "end_date", "value": "", "type": "query", "description": "Filter BillableMatter records to those that have matters with unbilled activities on or before this date (Expects an ISO-8601 date)." }, { "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": "limit", "value": "", "type": "query", "description": "A limit on the number of BillableMatter records to be returned. Limit can range between 1 and 1000. Default: `1000`." }, { "name": "matter_id", "value": "", "type": "query", "description": "The unique identifier for a single Matter. The keyword `null` is not valid for this field. The list will be filtered to include only the BillableMatter records with the matching property." }, { "name": "originating_attorney_id", "value": "", "type": "query", "description": "The unique identifier for a single User. Use the keyword `null` to match those without a BillableMatter. The list will be filtered to include only the BillableMatter records with the matching property." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "query", "value": "", "type": "query", "description": "Wildcard search for `display_number` or `number` or `description` matching a given string." }, { "name": "responsible_attorney_id", "value": "", "type": "query", "description": "The unique identifier for a single User. Use the keyword `null` to match those without a BillableMatter. The list will be filtered to include only the BillableMatter records with the matching property." }, { "name": "start_date", "value": "", "type": "query", "description": "Filter BillableMatter records to those that have matters with unbilled activities on or after this date (Expects an ISO-8601 date)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all BillableMatters" } ] }, { "info": { "name": "Bills", "type": "folder" }, "items": [ { "info": { "name": "Returns the pre-rendered html for the Bill", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/bills/:id/preview.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Bill." } ] }, "docs": "This endpoint returns a pre-rendered HTML object that you can use to view a preview of your bills.\nThe HTML provided contains all of the CSS rules it requires to show the bill correctly,\nas well as the DOCTYPE setting it requires.\nIt's best to use an iframe, or similar object, to render the results of this endpoint.\n" }, { "info": { "name": "Return the data for all Bills", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/bills.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "bill_number", "value": "", "type": "query", "description": "Filter Bill records to those with this exact bill number" }, { "name": "client_id", "value": "", "type": "query", "description": "The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the Bill records with the matching property." }, { "name": "created_since", "value": "", "type": "query", "description": "Filter Bill records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "name": "currency_id", "value": "", "type": "query", "description": "Filter Bill records to those of a specific currency." }, { "name": "custom_field_values", "value": "", "type": "query", "description": "Filter records to only those with the given custom field(s) set. The value is compared using the operator provided, or,\nif the value type only supports one operator, the supported operator is used. In the latter case, no check for operator is performed on the input string.\nThe key for the custom field value filter is the custom_field.id. e.g. `custom_field_values[12345]`\nIf an operator is used for a type that does not support it, an `400 Bad Request` is returned.\n\n*Supported operators:*\n* `checkbox`, `contact`, `matter`, `picklist` : `=`\n\ne.g. `?custom_field_values[1]=42`\n\n* `currency`, `date`, `time`, `numeric` : `=`, `<`, `>`, `<=`, `>=`\n\ne.g. `?custom_field_values[1]=>=105.4`\n\n* `email`, `text_area`, `text_line`, `url` : `=`\n\ne.g. `?custom_field_values[1]=url_encoded`\n\n*Multiple conditions for the same custom field:*\n\nIf you want to use more than one operator to filter a custom field, you can do so by passing in an array of values.\ne.g. `?custom_field_values[1]=[<=50, >=45]`\n" }, { "name": "due_after", "value": "", "type": "query", "description": "Filter Bill records to those that have a `due_date` after the one provided (Expects an ISO-8601 date)." }, { "name": "due_at", "value": "", "type": "query", "description": "Filter Bill records to those that have a specific `due_date` (Expects an ISO-8601 date)." }, { "name": "due_before", "value": "", "type": "query", "description": "Filter Bill records to those that have a `due_date` before the one provided (Expects an ISO-8601 date)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter Bill records to those having the specified unique identifiers." }, { "name": "issued_after", "value": "", "type": "query", "description": "Filter Bill records to those that have an `issue_date` after the one provided (Expects an ISO-8601 date)." }, { "name": "issued_before", "value": "", "type": "query", "description": "Filter Bill records to those that have an `issue_date` before the one provided (Expects an ISO-8601 date)." }, { "name": "last_sent_end_date", "value": "", "type": "query", "description": "Filter Bill records for those whose bills have been sent before the specified date" }, { "name": "last_sent_start_date", "value": "", "type": "query", "description": "Filter Bill records for those whose bills have been sent after the specified date" }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of Bill 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 Bill. The list will be filtered to include only the Bill records with the matching property." }, { "name": "order", "value": "", "type": "query", "description": "Orders the Bill records by the given field. Default: `id(asc)`." }, { "name": "originating_attorney_id", "value": "", "type": "query", "description": "The unique identifier for a single User. Use the keyword `null` to match those without a Bill. The list will be filtered to include only the Bill records with the matching property." }, { "name": "overdue_only", "value": "", "type": "query", "description": "Filter Bill records to those that are overdue." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "query", "value": "", "type": "query", "description": "Allows matching search on invoice number." }, { "name": "responsible_attorney_id", "value": "", "type": "query", "description": "The unique identifier for a single User. Use the keyword `null` to match those without a Bill. The list will be filtered to include only the Bill records with the matching property." }, { "name": "state", "value": "", "type": "query", "description": "Filter Bill records to those in a given state." }, { "name": "status", "value": "", "type": "query", "description": "Filter Bill records to those with particular payment status." }, { "name": "type", "value": "", "type": "query", "description": "Filter Bill records to those of a specific type." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter Bill records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all Bills" }, { "info": { "name": "Return the data for a single Bill", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/bills/: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 Bill." }, { "name": "navigation.next", "value": "", "type": "query", "description": "The id of the next *Bill* available for viewing" }, { "name": "navigation.previous", "value": "", "type": "query", "description": "The id of the previous *Bill* available for viewing" } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Bill" }, { "info": { "name": "Update a single Bill", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/bills/: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 Bill." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single Bill" }, { "info": { "name": "Delete or void a Bill", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/bills/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Bill." } ] }, "docs": "This endpoint will transition a bill to either its deleted or voided state.\nA bill can only be deleted or voided if it has no payments recorded\nand its current state is one of the following:\n* Draft\n* Pending Approval\n* Unpaid\n\nA bill will automatically be moved to a deleted or void state based on its current state.\nThe mappings for this are:\n* Draft -> Deleted\n* Pending Approval -> Deleted\n* Unpaid -> Void\n" } ] }, { "info": { "name": "Calendar Entries", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all CalendarEntries", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/calendar_entries.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "calendar_id", "value": "", "type": "query", "description": "The unique identifier for a single Calendar. The keyword `null` is not valid for this field. The list will be filtered to include only the CalendarEntry records with the matching property." }, { "name": "created_since", "value": "", "type": "query", "description": "Filter CalendarEntry records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "name": "expanded", "value": "", "type": "query", "description": "Returns a record for each occurrence of a recurring calendar event. Non-recurring calendar events are unaffected and returned as separate records regardless of the expanded setting." }, { "name": "external_property_name", "value": "", "type": "query", "description": "Filter records to only those with the given external property(s) name set.\n\ne.g. `?external_property_name=Name`\n" }, { "name": "external_property_value", "value": "", "type": "query", "description": "Filter records to only those with the given external property(s) value set. Requires external property name as well.\n\ne.g. `?external_property_name=Name&external_property_value=Value`\n" }, { "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": "from", "value": "", "type": "query", "description": "Filter CalendarEntry records to those that end on or after the provided time (Expects an ISO-8601 timestamp)." }, { "name": "has_court_rule", "value": "", "type": "query", "description": "Allows matching court rule on calendar entry." }, { "name": "ids[]", "value": "", "type": "query", "description": "Filter CalendarEntry records to those having the specified unique identifiers." }, { "name": "is_all_day", "value": "", "type": "query", "description": "Filter CalendarEntry records to those that are marked as all day events." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of CalendarEntry 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 CalendarEntry. The list will be filtered to include only the CalendarEntry records with the matching property." }, { "name": "owner_entries_across_all_users", "value": "", "type": "query", "description": "Returns CalendarEntry records for all users related to a matter. Requires matter id." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "query", "value": "", "type": "query", "description": "Allows matching search on calendar entry." }, { "name": "source", "value": "", "type": "query", "description": "Filter CalendarEntry records to those having a specific calendar visibility source (mobile, web)." }, { "name": "to", "value": "", "type": "query", "description": "Filter CalendarEntry records to those that begin on or before the provided time (Expects an ISO-8601 timestamp)." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter CalendarEntry records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "name": "visible", "value": "", "type": "query", "description": "Filter CalendarEntry records to those that are visible." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all CalendarEntries" }, { "info": { "name": "Create a new CalendarEntry", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/calendar_entries.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 CalendarEntry" }, { "info": { "name": "Return the data for a single CalendarEntry", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/calendar_entries/: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 CalendarEntry." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single CalendarEntry" }, { "info": { "name": "Update a single CalendarEntry", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/calendar_entries/: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 CalendarEntry." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single CalendarEntry" }, { "info": { "name": "Delete a single CalendarEntry", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/calendar_entries/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the CalendarEntry." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single CalendarEntry" } ] }, { "info": { "name": "Calendar Entry Event Types", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all calendar entry event types", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/calendar_entry_event_types.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter CalendarEntryEventType records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter CalendarEntryEventType records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of CalendarEntryEventType records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter CalendarEntryEventType records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all CalendarEntryEventTypes" }, { "info": { "name": "Create a new calendar entry event type", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/calendar_entry_event_types.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 CalendarEntryEventType" }, { "info": { "name": "Return the data for a single calendar entry event type", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/calendar_entry_event_types/: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 CalendarEntryEventType." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single CalendarEntryEventType" }, { "info": { "name": "Update a single calendar entry event type", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/calendar_entry_event_types/: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 CalendarEntryEventType." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single CalendarEntryEventType" }, { "info": { "name": "Delete a single calendar entry event type", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/calendar_entry_event_types/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the CalendarEntryEventType." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single CalendarEntryEventType" } ] }, { "info": { "name": "Calendars", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all Calendars", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/calendars.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter Calendar records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "filter_inactive_users", "value": "", "type": "query", "description": "Filter any shared UserCalendar records whose owner is inactive." }, { "name": "ids[]", "value": "", "type": "query", "description": "Filter Calendar records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of Calendar records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "order", "value": "", "type": "query", "description": "Orders the Calendar records by the given field. Default: `id(asc)`." }, { "name": "owner", "value": "", "type": "query", "description": "Filter Calendar records to those that the user owns." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "source", "value": "", "type": "query", "description": "Filter Calendar records to those having a specific calendar visibility source (mobile, web)." }, { "name": "type", "value": "", "type": "query", "description": "Filter Calendar records to those of the specified type." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter Calendar records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "name": "visible", "value": "", "type": "query", "description": "Filter Calendar records to those that are visible." }, { "name": "writeable", "value": "", "type": "query", "description": "Filter Calendar records to those which the user can write to." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all Calendars" }, { "info": { "name": "Create a new Calendar", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/calendars.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 Calendar" }, { "info": { "name": "Return the data for a single Calendar", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/calendars/: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 Calendar." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Calendar" }, { "info": { "name": "Update a single Calendar", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/calendars/: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 Calendar." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single Calendar" }, { "info": { "name": "Delete a single Calendar", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/calendars/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Calendar." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single Calendar" } ] }, { "info": { "name": "Clio Payments Links", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all ClioPaymentsLinks", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/clio_payments/links.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "active", "value": "", "type": "query", "description": "Filter ClioPaymentsLink records based on whether or not they have expired." }, { "name": "created_since", "value": "", "type": "query", "description": "Filter ClioPaymentsLink records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter ClioPaymentsLink records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of ClioPaymentsLink records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter ClioPaymentsLink records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all ClioPaymentsLinks" }, { "info": { "name": "Create a new ClioPaymentsLink", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/clio_payments/links.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 ClioPaymentsLink" }, { "info": { "name": "Return the data for a single ClioPaymentsLink", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/clio_payments/links/: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 ClioPaymentsLink." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single ClioPaymentsLink" }, { "info": { "name": "Update a single ClioPaymentsLink", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/clio_payments/links/: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 ClioPaymentsLink." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single ClioPaymentsLink" } ] }, { "info": { "name": "Clio Payments Payments", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all ClioPaymentsPayments", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/clio_payments/payments.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "bill_id", "value": "", "type": "query", "description": "Filter ClioPaymentsPayment records to those that are allocated to the specified bill." }, { "name": "contact_id", "value": "", "type": "query", "description": "Filter ClioPaymentsPayment records to those that are assigned to the specified contact." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter ClioPaymentsPayment records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of ClioPaymentsPayment records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "state", "value": "", "type": "query", "description": "Filter ClioPaymentsPayment records to those in a given state." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all ClioPaymentsPayments" }, { "info": { "name": "Return the data for a single ClioPaymentsPayment", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/clio_payments/payments/: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 ClioPaymentsPayment." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single ClioPaymentsPayment" } ] }, { "info": { "name": "Communications", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all Communications", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/communications.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "contact_id", "value": "", "type": "query", "description": "The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the Communication records with the matching property." }, { "name": "created_since", "value": "", "type": "query", "description": "Filter Communication records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "name": "date", "value": "", "type": "query", "description": "Filter Communication records to those that occur on the specified date (Expects an ISO-8601 date)." }, { "name": "external_property_name", "value": "", "type": "query", "description": "Filter records to only those with the given external property(s) name set.\n\ne.g. `?external_property_name=Name`\n" }, { "name": "external_property_value", "value": "", "type": "query", "description": "Filter records to only those with the given external property(s) value set. Requires external property name as well.\n\ne.g. `?external_property_name=Name&external_property_value=Value`\n" }, { "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": "having_time_entries", "value": "", "type": "query", "description": "Filter Communication records to those that do or do not have time entries." }, { "name": "ids[]", "value": "", "type": "query", "description": "Filter Communication records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of Communication 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 Communication. The list will be filtered to include only the Communication records with the matching property." }, { "name": "order", "value": "", "type": "query", "description": "Orders the Communication records by the given field. Default: `date(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "query", "value": "", "type": "query", "description": "Wildcard search for `body` or `subject` matching a given string." }, { "name": "received_at", "value": "", "type": "query", "description": "Filter Communication records to those that occur on the specified date (Expects an ISO-8601 date-time)." }, { "name": "received_before", "value": "", "type": "query", "description": "Filter Communication records to those whose `date` is on or before the date provided (Expects an ISO-8601 date)." }, { "name": "received_since", "value": "", "type": "query", "description": "Filter Communication records to those whose `date` is on or after the date provided (Expects an ISO-8601 date)." }, { "name": "type", "value": "", "type": "query", "description": "Filter Communication records to those of the specified type." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter Communication 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. The keyword `null` is not valid for this field. The list will be filtered to include only the Communication records with the matching property." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all Communications" }, { "info": { "name": "Create a new Communication", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/communications.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 Communication" }, { "info": { "name": "Return the data for a single Communication", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/communications/: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 Communication." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Communication" }, { "info": { "name": "Update a single Communication", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/communications/: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 Communication." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single Communication" }, { "info": { "name": "Delete a single Communication", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/communications/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Communication." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single Communication" } ] }, { "info": { "name": "Email Addresses", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all EmailAddresses", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/contacts/:contact_id/email_addresses.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "contact_id", "value": "", "type": "path", "description": "ID of the Contact" }, { "name": "created_since", "value": "", "type": "query", "description": "Filter EmailAddress records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter EmailAddress records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of EmailAddress records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter EmailAddress records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all EmailAddresses" } ] }, { "info": { "name": "Phone Numbers", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all PhoneNumbers", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/contacts/:contact_id/phone_numbers.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "contact_id", "value": "", "type": "path", "description": "ID of the Contact" }, { "name": "created_since", "value": "", "type": "query", "description": "Filter PhoneNumber records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter PhoneNumber records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of PhoneNumber records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter PhoneNumber records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all PhoneNumbers" } ] }, { "info": { "name": "Contacts", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all Contacts", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/contacts.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "client_only", "value": "", "type": "query", "description": "Filter Contact records to those that are clients." }, { "name": "clio_connect_only", "value": "", "type": "query", "description": "Filter Contact records to those that are Clio Connect users." }, { "name": "created_since", "value": "", "type": "query", "description": "Filter Contact records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "name": "custom_field_ids[]", "value": "", "type": "query", "description": "Filter Contact's custom_field_values to only include values for the given custom field unique identifiers." }, { "name": "custom_field_values", "value": "", "type": "query", "description": "Filter records to only those with the given custom field(s) set. The value is compared using the operator provided, or,\nif the value type only supports one operator, the supported operator is used. In the latter case, no check for operator is performed on the input string.\nThe key for the custom field value filter is the custom_field.id. e.g. `custom_field_values[12345]`\nIf an operator is used for a type that does not support it, an `400 Bad Request` is returned.\n\n*Supported operators:*\n* `checkbox`, `contact`, `matter`, `picklist` : `=`\n\ne.g. `?custom_field_values[1]=42`\n\n* `currency`, `date`, `time`, `numeric` : `=`, `<`, `>`, `<=`, `>=`\n\ne.g. `?custom_field_values[1]=>=105.4`\n\n* `email`, `text_area`, `text_line`, `url` : `=`\n\ne.g. `?custom_field_values[1]=url_encoded`\n\n*Multiple conditions for the same custom field:*\n\nIf you want to use more than one operator to filter a custom field, you can do so by passing in an array of values.\ne.g. `?custom_field_values[1]=[<=50, >=45]`\n" }, { "name": "email_only", "value": "", "type": "query", "description": "Filter Contact records to those that have email addresses." }, { "name": "exclude_ids[]", "value": "", "type": "query", "description": "Filter Contact records to those who are not included in the given list of unique identifiers." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter Contact records to those having the specified unique identifiers." }, { "name": "initial", "value": "", "type": "query", "description": "Filter Contact records to those where the last name or company name start with the given initial." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of Contact records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "order", "value": "", "type": "query", "description": "Orders the Contact 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 name, title, email address, address, phone number, web site, instant messenger address,\ncustom fields, related matter name, or company name matching a given string.\n" }, { "name": "shared_resource_id", "value": "", "type": "query", "description": "Filter Contact records to those that currently have access to a given shared resource." }, { "name": "type", "value": "", "type": "query", "description": "Filter Contact records to those that match the given type." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter Contact records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all Contacts" }, { "info": { "name": "Create a new Contact", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/contacts.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "custom_field_ids[]", "value": "", "type": "query", "description": "Filter Contact's custom_field_values to only include values for the given custom field unique identifiers." }, { "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 Contact" }, { "info": { "name": "Return the data for a single Contact", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/contacts/:id.json", "headers": [ { "name": "IF-MODIFIED-SINCE", "value": "" }, { "name": "IF-NONE-MATCH", "value": "" }, { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "custom_field_ids[]", "value": "", "type": "query", "description": "Filter Contact's custom_field_values to only include values for the given custom field unique identifiers." }, { "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 Contact." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Contact" }, { "info": { "name": "Update a single Contact", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/contacts/:id.json", "headers": [ { "name": "IF-MATCH", "value": "" }, { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "custom_field_ids[]", "value": "", "type": "query", "description": "Filter Contact's custom_field_values to only include values for the given custom field unique identifiers." }, { "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 Contact." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single Contact" }, { "info": { "name": "Delete a single Contact", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/contacts/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Contact." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single Contact" } ] }, { "info": { "name": "Conversation Messages", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all ConversationMessages", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/conversation_messages.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "conversation_id", "value": "", "type": "query", "description": "The unique identifier for a single Conversation. Use the keyword `null` to match those without a ConversationMessage. The list will be filtered to include only the ConversationMessage records with the matching property." }, { "name": "created_since", "value": "", "type": "query", "description": "Filter ConversationMessage records to those having the `created_at` field on the related Conversation after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter ConversationMessage records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of ConversationMessage records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "order", "value": "", "type": "query", "description": "Orders the ConversationMessage 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 `body` matching a given string." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter ConversationMessage records to those having the `updated_at` field on the related Conversation after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all ConversationMessages" }, { "info": { "name": "Create a new ConversationMessage", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/conversation_messages.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 ConversationMessage" }, { "info": { "name": "Return the data for a single ConversationMessage", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/conversation_messages/: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 ConversationMessage." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single ConversationMessage" } ] }, { "info": { "name": "Conversations", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all Conversations", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/conversations.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "archived", "value": "", "type": "query", "description": "Filter archived Conversation records." }, { "name": "contact_id", "value": "", "type": "query", "description": "Filter Conversation records for the contact." }, { "name": "created_since", "value": "", "type": "query", "description": "Filter Conversation records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "name": "date", "value": "", "type": "query", "description": "Filter Conversation records created on a given date. (Expects an ISO-8601 date)." }, { "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": "for_user", "value": "", "type": "query", "description": "If set to true, filter Conversation records accessible to any groups of the user.\nNote that the user may not be member of the conversations.\n\nIf set to false, filter Conversation records of which the user is a member.\n" }, { "name": "ids[]", "value": "", "type": "query", "description": "Filter Conversation records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of Conversation 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 Conversation. The list will be filtered to include only the Conversation records with the matching property." }, { "name": "order", "value": "", "type": "query", "description": "Orders the Conversation records by the given field. Default: `id(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "read_status", "value": "", "type": "query", "description": "Filter Conversation records to those which have been read." }, { "name": "time_entries", "value": "", "type": "query", "description": "Filter Conversation records to those with or without associated time entries." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter Conversation records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all Conversations" }, { "info": { "name": "Return the data for a single Conversation", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/conversations/: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 Conversation." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Conversation" }, { "info": { "name": "Update a single Conversation", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/conversations/: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 Conversation." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single Conversation" } ] }, { "info": { "name": "Jurisdictions To Triggers", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all triggers", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/court_rules/jurisdictions/:jurisdiction_id/triggers.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter JurisdictionsToTrigger records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter JurisdictionsToTrigger records to those having the specified unique identifiers." }, { "name": "is_requirements_required", "value": "", "type": "query", "description": "Filter JurisdictionsToTrigger records to those which require addition requirements to be checked (usually specifying trigger time)." }, { "name": "is_served", "value": "", "type": "query", "description": "Filter JurisdictionsToTrigger records to those which require a service type to be selected." }, { "name": "jurisdiction_id", "value": "", "type": "path", "description": "The unique identifier for the Jurisdiction." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of JurisdictionsToTrigger records to be returned. Limit can range between 1 and 1000. Default: `1000`." }, { "name": "order", "value": "", "type": "query", "description": "Orders the JurisdictionsToTrigger 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 `description` matching a given string." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter JurisdictionsToTrigger records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all JurisdictionsToTriggers" }, { "info": { "name": "Return the data for the trigger", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/court_rules/jurisdictions/:jurisdiction_id/triggers/: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 JurisdictionsToTrigger." }, { "name": "jurisdiction_id", "value": "", "type": "path", "description": "The unique identifier for the Jurisdiction." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single JurisdictionsToTrigger" } ] }, { "info": { "name": "Jurisdictions", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all jurisdictions", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/court_rules/jurisdictions.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter Jurisdiction records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "for_current_account", "value": "", "type": "query", "description": "Filter Jurisdiction records to those set up for this account." }, { "name": "ids[]", "value": "", "type": "query", "description": "Filter Jurisdiction records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of Jurisdiction records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "order", "value": "", "type": "query", "description": "Orders the Jurisdiction 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 `description` matching a given string." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter Jurisdiction records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all Jurisdictions" }, { "info": { "name": "Return the data for the jurisdiction", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/court_rules/jurisdictions/: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 Jurisdiction." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Jurisdiction" } ] }, { "info": { "name": "Matter Dockets", "type": "folder" }, "items": [ { "info": { "name": "Preview calendar dates for the docket", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/court_rules/matter_dockets/preview.json", "params": [ { "name": "event_prefix", "value": "", "type": "query", "description": "The prefix that will be added to the beginning of all court rule event titles" }, { "name": "jurisdiction[id]", "value": "", "type": "query", "description": "The unique identifier for a single Jurisdiction. The keyword `null` is not valid for this field. The list will be filtered to include only the MatterDocket records with the matching property." }, { "name": "service_type[id]", "value": "", "type": "query", "description": "The unique identifier for a single ServiceType. The keyword `null` is not valid for this field. The list will be filtered to include only the MatterDocket records with the matching property." }, { "name": "start_date", "value": "", "type": "query", "description": "The date the MatterDocket should start. (Expects an ISO-8601 date)." }, { "name": "start_time", "value": "", "type": "query", "description": "The time the MatterDocket should start. (Expects an ISO-8601 timestamp)." }, { "name": "trigger[id]", "value": "", "type": "query", "description": "The unique identifier for a single JurisdictionsToTrigger. The keyword `null` is not valid for this field. The list will be filtered to include only the MatterDocket records with the matching property." } ] }, "docs": "Preview calendar dates for the docket" }, { "info": { "name": "Return the data for all matter dockets", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/court_rules/matter_dockets.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter MatterDocket records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter MatterDocket records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of MatterDocket 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. The keyword `null` is not valid for this field. The list will be filtered to include only the MatterDocket records with the matching property." }, { "name": "matter_status", "value": "", "type": "query", "description": "Filter MatterDocket records to those with Matters having a specific status." }, { "name": "order", "value": "", "type": "query", "description": "Orders the MatterDocket 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 `name` matching a given string." }, { "name": "service_type_id", "value": "", "type": "query", "description": "The unique identifier for a single ServiceType. Use the keyword `null` to match those without a MatterDocket. The list will be filtered to include only the MatterDocket records with the matching property." }, { "name": "status", "value": "", "type": "query", "description": "Filter MatterDocket records to those having a specific status." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter MatterDocket records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all MatterDockets" }, { "info": { "name": "Creates a matter docket", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/court_rules/matter_dockets.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 MatterDocket" }, { "info": { "name": "Return the data for the matter docket", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/court_rules/matter_dockets/: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 MatterDocket." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single MatterDocket" }, { "info": { "name": "Deletes the requested matter docket", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/court_rules/matter_dockets/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the MatterDocket." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single MatterDocket" } ] }, { "info": { "name": "Service Types", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all service types", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/court_rules/service_types.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter ServiceType records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter ServiceType records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of ServiceType records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "order", "value": "", "type": "query", "description": "Orders the ServiceType records by the given field. Default: `id(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter ServiceType records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all ServiceTypes" }, { "info": { "name": "Return the data for the service type", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/court_rules/service_types/: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 ServiceType." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single ServiceType" } ] }, { "info": { "name": "Credit Memos", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all CreditMemos", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/credit_memos.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "contact_id", "value": "", "type": "query", "description": "The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the CreditMemo records with the matching property." }, { "name": "created_since", "value": "", "type": "query", "description": "Filter CreditMemo records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter CreditMemo records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of CreditMemo records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "order", "value": "", "type": "query", "description": "Orders the CreditMemo records by the given field. Default: `date(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter CreditMemo records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all CreditMemos" }, { "info": { "name": "Return the data for a single CreditMemo", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/credit_memos/: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 CreditMemo." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single CreditMemo" } ] }, { "info": { "name": "Currencies", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all Currencies", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/currencies.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter Currency records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter Currency records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of Currency records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter Currency records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all Currencies" } ] }, { "info": { "name": "Custom Fields", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all CustomFields", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/custom_fields.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter CustomField records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "name": "deleted", "value": "", "type": "query", "description": "Filter CustomField records to those that have been deleted for future use." }, { "name": "field_type", "value": "", "type": "query", "description": "Field type of this custom field" }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter CustomField records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of CustomField records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "order", "value": "", "type": "query", "description": "Orders the CustomField records by the given field. Default: `id(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "parent_type", "value": "", "type": "query", "description": "Filter CustomField records to those that have the specified `parent_type`." }, { "name": "query", "value": "", "type": "query", "description": "Wildcard search for `name` matching a given string." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter CustomField records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "name": "visible_and_required", "value": "", "type": "query", "description": "Filter CustomField records to those that are visible and required." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all CustomFields" }, { "info": { "name": "Create a new CustomField", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/custom_fields.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 CustomField" }, { "info": { "name": "Return the data for a single CustomField", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/custom_fields/: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 CustomField." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single CustomField" }, { "info": { "name": "Update a single CustomField", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/custom_fields/: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 CustomField." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single CustomField" }, { "info": { "name": "Delete a single CustomField", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/custom_fields/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the CustomField." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single CustomField" } ] }, { "info": { "name": "Custom Field Sets", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all CustomFieldSets", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/custom_field_sets.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter CustomFieldSet records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "name": "displayed", "value": "", "type": "query", "description": "Filter CustomFieldSet records to those that should be displayed by default." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter CustomFieldSet records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of CustomFieldSet records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "order", "value": "", "type": "query", "description": "Orders the CustomFieldSet records by the given field. Default: `id(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "parent_type", "value": "", "type": "query", "description": "Filter CustomFieldSet records to those that have the specified `parent_type`." }, { "name": "query", "value": "", "type": "query", "description": "Wildcard search for `name` matching a given string." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter CustomFieldSet records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all CustomFieldSets" }, { "info": { "name": "Create a new CustomFieldSet", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/custom_field_sets.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 CustomFieldSet" }, { "info": { "name": "Return the data for a single CustomFieldSet", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/custom_field_sets/: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 CustomFieldSet." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single CustomFieldSet" }, { "info": { "name": "Update a single CustomFieldSet", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/custom_field_sets/: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 CustomFieldSet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single CustomFieldSet" }, { "info": { "name": "Delete a single CustomFieldSet", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/custom_field_sets/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the CustomFieldSet." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single CustomFieldSet" } ] }, { "info": { "name": "Custom Actions", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all CustomActions", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/custom_actions.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter CustomAction records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter CustomAction records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of CustomAction records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter CustomAction records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all CustomActions" }, { "info": { "name": "Create a new CustomAction", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/custom_actions.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 CustomAction" }, { "info": { "name": "Return the data for a single CustomAction", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/custom_actions/: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 CustomAction." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single CustomAction" }, { "info": { "name": "Update a single CustomAction", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/custom_actions/: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 CustomAction." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single CustomAction" }, { "info": { "name": "Delete a single CustomAction", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/custom_actions/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the CustomAction." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single CustomAction" } ] }, { "info": { "name": "Damages", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all Damages", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/damages.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter Damage records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter Damage records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of Damage records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter Damage records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all Damages" }, { "info": { "name": "Creating a Damage", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/damages.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 Damage" }, { "info": { "name": "Return a specific Damage", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/damages/: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 Damage." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Damage" }, { "info": { "name": "Updating a Damage", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/damages/: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 Damage." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single Damage" }, { "info": { "name": "Deleting a Damage", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/damages/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Damage." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single Damage" } ] }, { "info": { "name": "Expense Categories", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all ExpenseCategories", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/expense_categories.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter ExpenseCategory records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "name": "entry_type", "value": "", "type": "query", "description": "Filter ExpenseCategory records to those that match the given type." }, { "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": "limit", "value": "", "type": "query", "description": "A limit on the number of ExpenseCategory records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "order", "value": "", "type": "query", "description": "Orders the ExpenseCategory 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": "Allows matching search on expense category name." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter ExpenseCategory records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all ExpenseCategories" }, { "info": { "name": "Create a new ExpenseCategory", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/expense_categories.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 ExpenseCategory" }, { "info": { "name": "Return the data for a single ExpenseCategory", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/expense_categories/: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 ExpenseCategory." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single ExpenseCategory" }, { "info": { "name": "Update a single ExpenseCategory", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/expense_categories/: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 ExpenseCategory." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single ExpenseCategory" }, { "info": { "name": "Delete a single ExpenseCategory", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/expense_categories/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the ExpenseCategory." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single ExpenseCategory" }, { "info": { "name": "List Expense Categories", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/lauk_expense_categories.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)." }, { "name": "key", "value": "", "type": "query", "description": "Filter by key." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of LaukExpenseCategory records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "name", "value": "", "type": "query", "description": "Filter by expense name." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "practice_area", "value": "", "type": "query", "description": "Filter by expense practice area." }, { "name": "region", "value": "", "type": "query", "description": "Sets the expense rate returned based on the region. If the region is set to London, it will return the London rate; otherwise, it will return the non-London rate." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all LaukExpenseCategories" } ] }, { "info": { "name": "Grants", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all grants", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/grants.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter Grant records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter Grant records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of Grant records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "name", "value": "", "type": "query", "description": "Filter Grant records to those that match the given name." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter Grant records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all Grants" }, { "info": { "name": "Create a new grant", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/grants.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 Grant" }, { "info": { "name": "Return the data for a single grant", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/grants/: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 Grant." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Grant" }, { "info": { "name": "Update a single grant", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/grants/: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 Grant." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single Grant" }, { "info": { "name": "Deletes a single grant", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/grants/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Grant." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single Grant" } ] }, { "info": { "name": "Grant Funding Sources", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all grant funding sources", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/grant_funding_sources.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter GrantFundingSource records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter GrantFundingSource records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of GrantFundingSource records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "name", "value": "", "type": "query", "description": "Filter GrantFundingSource records to those that match the given name." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter GrantFundingSource records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all GrantFundingSources" }, { "info": { "name": "Create a new grant funding source", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/grant_funding_sources.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 GrantFundingSource" }, { "info": { "name": "Update a single grant funding source", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/grant_funding_sources/: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 GrantFundingSource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single GrantFundingSource" }, { "info": { "name": "Delete a single grant funding source", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/grant_funding_sources/: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 GrantFundingSource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single GrantFundingSource" } ] }, { "info": { "name": "Groups", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all Groups", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/groups.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "archived", "value": "", "type": "query", "description": "Filter archived Group records." }, { "name": "created_since", "value": "", "type": "query", "description": "Filter Group records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter Group records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of Group records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "name", "value": "", "type": "query", "description": "Filter Group records to those that match the given name." }, { "name": "order", "value": "", "type": "query", "description": "Orders the Group 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 `name` matching a given string." }, { "name": "type", "value": "", "type": "query", "description": "Filter Group records to those that match the given type." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter Group 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. The keyword `null` is not valid for this field. The list will be filtered to include only the Group records with the matching property." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all Groups" }, { "info": { "name": "Create a new Group", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/groups.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 Group" }, { "info": { "name": "Return the data for a single Group", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/groups/: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 Group." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Group" }, { "info": { "name": "Update a single Group", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/groups/: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 Group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single Group" }, { "info": { "name": "Delete a single Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/groups/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Group." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single Group" } ] }, { "info": { "name": "Event Metrics", "type": "folder" }, "items": [ { "info": { "name": "Unread in-app notification events", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/internal_notifications/event_metrics.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)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting Event Metrics" } ] }, { "info": { "name": "My Events", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all of my in-app notification events", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/internal_notifications/my_events.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)." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of MyEvent records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all MyEvents" }, { "info": { "name": "Mark a single in-app notification event as read/unread", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/internal_notifications/my_events/: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 MyEvent." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single MyEvent" }, { "info": { "name": "Clear (delete) a single in-app notification event", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/internal_notifications/my_events/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the MyEvent." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single MyEvent" } ] }, { "info": { "name": "Interest Charges", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all InterestCharges", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/interest_charges.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "bill_id", "value": "", "type": "query", "description": "The unique identifier for a single Bill. The keyword `null` is not valid for this field. The list will be filtered to include only the InterestCharge records with the matching property." }, { "name": "created_since", "value": "", "type": "query", "description": "Filter InterestCharge records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "name": "exclude_ids[]", "value": "", "type": "query", "description": "Array containing *InterestCharge* identifiers that should be excluded from the query." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter InterestCharge records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of InterestCharge records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter InterestCharge records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all InterestCharges" }, { "info": { "name": "Delete a single InterestCharge", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/interest_charges/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the InterestCharge." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single InterestCharge" } ] }, { "info": { "name": "Line Items", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all LineItems", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/line_items.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "activity_id", "value": "", "type": "query", "description": "The unique identifier for a single Activity. Use the keyword `null` to match those without a LineItem. The list will be filtered to include only the LineItem records with the matching property." }, { "name": "bill_id", "value": "", "type": "query", "description": "The unique identifier for a single Bill. The keyword `null` is not valid for this field. The list will be filtered to include only the LineItem records with the matching property." }, { "name": "created_since", "value": "", "type": "query", "description": "Filter LineItem records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "name": "display", "value": "", "type": "query", "description": "Set this flag to true to return only LineItems displayed on the bill." }, { "name": "exclude_ids[]", "value": "", "type": "query", "description": "Array containing LineItem identifiers that should be excluded from the query." }, { "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": "group_ordering", "value": "", "type": "query", "description": "Filters LineItem records to match given group ordering." }, { "name": "ids[]", "value": "", "type": "query", "description": "Filter LineItem records to those having the specified unique identifiers." }, { "name": "kind", "value": "", "type": "query", "description": "The kind of LineItem." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of LineItem 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 LineItem. The list will be filtered to include only the LineItem records with the matching property." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "query", "value": "", "type": "query", "description": "Wildcard search for `description` or `note` matching a given string." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter LineItem records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all LineItems" }, { "info": { "name": "Update a single LineItem", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/line_items/: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 LineItem." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single LineItem" }, { "info": { "name": "Delete a single LineItem", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/line_items/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the LineItem." } ] }, "docs": "A LineItem can not be deleted if it's Bill is not editable" } ] }, { "info": { "name": "Log Entries", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all LogEntries", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/log_entries.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter LogEntry records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter LogEntry records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of LogEntry records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "order", "value": "", "type": "query", "description": "Orders the LogEntry records by the given field. Default: `id(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter LogEntry records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all LogEntries" } ] }, { "info": { "name": "Clients", "type": "folder" }, "items": [ { "info": { "name": "Return the client data for a single matter", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/matters/:matter_id/client.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": "matter_id", "value": "", "type": "path", "description": "Filters Client data by matter." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Client" } ] }, { "info": { "name": "Related Contacts", "type": "folder" }, "items": [ { "info": { "name": "Return the related contact data for a single matter", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/matters/:matter_id/related_contacts.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)." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of RelatedContacts records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "matter_id", "value": "", "type": "path", "description": "Filters RelatedContacts data by matter." }, { "name": "order", "value": "", "type": "query", "description": "Orders the RelatedContacts records by the given field. Note that `id` is ordered by the `id` of the nested Relationship record. Default: `id(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all RelatedContacts" } ] }, { "info": { "name": "Matter Contacts", "type": "folder" }, "items": [ { "info": { "name": "Return the related contact data for a single matter", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/matters/:matter_id/contacts.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "custom_field_ids[]", "value": "", "type": "query", "description": "IDs of custom fields to include in results." }, { "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": "limit", "value": "", "type": "query", "description": "A limit on the number of MatterContacts records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "matter_id", "value": "", "type": "path", "description": "Filters contact data by matter." }, { "name": "order", "value": "", "type": "query", "description": "Orders the MatterContacts records by the given field. Note that `id` is ordered by the `id` of the nested Relationship record. Default: `is_client(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all MatterContacts" } ] }, { "info": { "name": "Matters", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all Matters", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/matters.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "billable", "value": "", "type": "query", "description": "Filter Matter records to those which are billable." }, { "name": "client_id", "value": "", "type": "query", "description": "The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the Matter records with the matching property." }, { "name": "close_date[]", "value": "", "type": "query", "description": "Filter Matter records by the close date. The date should be provided in the format YYYY-MM-DD.\n\ne.g. `?close_date==2020-01-01`, `?close_date=<=2021-12-31`\n\nYou can provide more than one value to narrow the results of this filter. You can do so by passing several individual values and appending `[]` to the parameter name.\n\ne.g. `?close_date[]=>=2020-01-01&close_date[]=<=2021-12-31`\n\nNote that, when providing multiple values for this filter, only Matter records that meet *all* filter conditions will be returned.\n" }, { "name": "created_since", "value": "", "type": "query", "description": "Filter Matter records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "name": "currency_id", "value": "", "type": "query", "description": "Filter Matter records to those of a specific currency." }, { "name": "custom_field_ids[]", "value": "", "type": "query", "description": "Filter Matter's custom_field_values to only include values for the given custom field unique identifiers." }, { "name": "custom_field_values", "value": "", "type": "query", "description": "Filter records to only those with the given custom field(s) set. The value is compared using the operator provided, or,\nif the value type only supports one operator, the supported operator is used. In the latter case, no check for operator is performed on the input string.\nThe key for the custom field value filter is the custom_field.id. e.g. `custom_field_values[12345]`\nIf an operator is used for a type that does not support it, an `400 Bad Request` is returned.\n\n*Supported operators:*\n* `checkbox`, `contact`, `matter`, `picklist` : `=`\n\ne.g. `?custom_field_values[1]=42`\n\n* `currency`, `date`, `time`, `numeric` : `=`, `<`, `>`, `<=`, `>=`\n\ne.g. `?custom_field_values[1]=>=105.4`\n\n* `email`, `text_area`, `text_line`, `url` : `=`\n\ne.g. `?custom_field_values[1]=url_encoded`\n\n*Multiple conditions for the same custom field:*\n\nIf you want to use more than one operator to filter a custom field, you can do so by passing in an array of values.\ne.g. `?custom_field_values[1]=[<=50, >=45]`\n" }, { "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": "grant_id", "value": "", "type": "query", "description": "The unique identifier for a single Grant. Use the keyword `null` to match those without a Matter. The list will be filtered to include only the Matter records with the matching property." }, { "name": "group_id", "value": "", "type": "query", "description": "The unique identifier for a single Group. The keyword `null` is not valid for this field. The list will be filtered to include only the Matter records with the matching property." }, { "name": "ids[]", "value": "", "type": "query", "description": "Filter Matter records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of Matter records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "notification_event_subscriber_user_id", "value": "", "type": "query", "description": "The unique identifier for a single NotificationEventSubscriber. Use the keyword `null` to match those without a Matter. The list will be filtered to include only the Matter records with the matching property." }, { "name": "open_date[]", "value": "", "type": "query", "description": "Filter Matter records by the open date. The date should be provided in the format YYYY-MM-DD.\n\ne.g. `?open_date==2020-01-01`, `?open_date=<=2021-12-31`\n\nYou can provide more than one value to narrow the results of this filter. You can do so by passing several individual values and appending `[]` to the parameter name.\n\ne.g. `?open_date[]=>=2020-01-01&open_date[]=<=2021-12-31`\n\nNote that, when providing multiple values for this filter, only Matter records that meet *all* filter conditions will be returned.\n" }, { "name": "order", "value": "", "type": "query", "description": "Orders the Matter records by the given field. Default: `id(asc)`." }, { "name": "originating_attorney_id", "value": "", "type": "query", "description": "The unique identifier for a single User. Use the keyword `null` to match those without a Matter. The list will be filtered to include only the Matter records with the matching property." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "pending_date[]", "value": "", "type": "query", "description": "Filter Matter records by the pending date. The date should be provided in the format YYYY-MM-DD.\n\ne.g. `?pending_date==2020-01-01`, `?pending_date=<=2021-12-31`\n\nYou can provide more than one value to narrow the results of this filter. You can do so by passing several individual values and appending `[]` to the parameter name.\n\ne.g. `?pending_date[]=>=2020-01-01&pending_date[]=<=2021-12-31`\n\nNote that, when providing multiple values for this filter, only Matter records that meet *all* filter conditions will be returned.\n" }, { "name": "practice_area_id", "value": "", "type": "query", "description": "The unique identifier for a single PracticeArea. The keyword `null` is not valid for this field. The list will be filtered to include only the Matter records with the matching property." }, { "name": "query", "value": "", "type": "query", "description": "Wildcard search for `display_number`, `number` or `description` matching a given string, as well as the `first_name`, `last_name` or `name` of the associated client." }, { "name": "responsible_attorney_id", "value": "", "type": "query", "description": "The unique identifier for a single User. Use the keyword `null` to match those without a Matter. The list will be filtered to include only the Matter records with the matching property." }, { "name": "responsible_staff_id", "value": "", "type": "query", "description": "The unique identifier for a single User. Use the keyword `null` to match those without a Matter. The list will be filtered to include only the Matter records with the matching property." }, { "name": "status", "value": "", "type": "query", "description": "Filter Matter records to those with a given status. It accepts comma-separated statuses, e.g. `open,pending`." }, { "name": "subscriber_user_id", "value": "", "type": "query", "description": "The unique identifier for a single NotificationEventSubscriber. Use the keyword `null` to match those without a Matter. The list will be filtered to include only the Matter records with the matching property." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter Matter records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all Matters" }, { "info": { "name": "Create a new Matter", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/matters.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "custom_field_ids[]", "value": "", "type": "query", "description": "Filter Matter's custom_field_values to only include values for the given custom field unique identifiers." }, { "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 Matter" }, { "info": { "name": "Return the data for a single Matter", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/matters/:id.json", "headers": [ { "name": "IF-MODIFIED-SINCE", "value": "" }, { "name": "IF-NONE-MATCH", "value": "" }, { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "custom_field_ids[]", "value": "", "type": "query", "description": "Filter Matter's custom_field_values to only include values for the given custom field unique identifiers." }, { "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 Matter." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Matter" }, { "info": { "name": "Update a single Matter", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/matters/:id.json", "headers": [ { "name": "IF-MATCH", "value": "" }, { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "custom_field_ids[]", "value": "", "type": "query", "description": "Filter Matter's custom_field_values to only include values for the given custom field unique identifiers." }, { "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 Matter." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single Matter\n\nWhen updating data that could change the display_number, reset_matter_number must be set in order for the display_number to be updated\n" }, { "info": { "name": "Delete a single Matter", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/matters/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Matter." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single Matter" } ] }, { "info": { "name": "Matter Stages", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all MatterStages", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/matter_stages.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter MatterStage records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter MatterStage records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of MatterStage records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "practice_area_id", "value": "", "type": "query", "description": "The unique identifier for a single PracticeArea. The keyword `null` is not valid for this field. The list will be filtered to include only the MatterStage records with the matching property." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter MatterStage records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all MatterStages" } ] }, { "info": { "name": "Medical Records", "type": "folder" }, "items": [ { "info": { "name": "Updating a Medical Record", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/medical_records/: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 MedicalRecord." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single MedicalRecord" }, { "info": { "name": "Destroying a Medical Record", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/medical_records/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the MedicalRecord." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single MedicalRecord" } ] }, { "info": { "name": "Medical Records Details", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all Medical Records Details", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/medical_records_details.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter MedicalRecordsRequest records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter MedicalRecordsRequest records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of Medical Records Detail records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "treatment_end_date", "value": "", "type": "query", "description": "Filters Medical Records data by treatment end date." }, { "name": "treatment_start_date", "value": "", "type": "query", "description": "Filters Medical Records data by treatment start date." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter MedicalRecordsRequest records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all Medical Records Details\n" }, { "info": { "name": "Creating a Medical Records Detail, Medical Records and Medical Bills", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/medical_records_details.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": "This endpoint allows a creation of a Medical Records Detail, multiple Medical Records and Medical Bills.\nMedical Liens can also be created as a property under Medical Bills.\n\nReference the payload to see how the records are being passed in.\n" }, { "info": { "name": "Return the data for a single Medical Records Detail", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/medical_records_details/: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 Medical Records Detail." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Medical Records Details\n" }, { "info": { "name": "Updating a Medical Records Detail", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/medical_records_details/: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 Medical Records Detail." } ], "body": { "type": "json", "data": "{}" } }, "docs": "If there are records being passed into the Medical Records or Medical Bills parameter they will be treated\nas new records and new Medical Records / Medical Bills will be created.\n" }, { "info": { "name": "Destroying a Medical Records Detail", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/medical_records_details/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Medical Records Detail." } ] }, "docs": "When a Medical Records Detail is destroyed, the child records, such as Medical Records, Medical Bills and Liens\nwill also be destroyed in the same transaction.\n" } ] }, { "info": { "name": "Medical Bills", "type": "folder" }, "items": [ { "info": { "name": "Updating a Medical Bill", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/medical_bills/: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 Medical Bill." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single Medical Bill\n" }, { "info": { "name": "Destroying a Medical Bill", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/medical_bills/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Medical Bill." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single Medical Bill\n" } ] }, { "info": { "name": "Notes", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all Notes", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/notes.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "contact_id", "value": "", "type": "query", "description": "The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the Note records with the matching property." }, { "name": "created_since", "value": "", "type": "query", "description": "Filter Note records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "has_time_entries", "value": "", "type": "query", "description": "Filter Note records to those with or without associated time entries." }, { "name": "ids[]", "value": "", "type": "query", "description": "Filter Note records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of Note 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. The keyword `null` is not valid for this field. The list will be filtered to include only the Note records with the matching property." }, { "name": "order", "value": "", "type": "query", "description": "Orders the Note 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 across note subject and detail." }, { "name": "type", "value": "", "type": "query", "description": "Filter Note records to those of the specified type." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter Note records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all Notes" }, { "info": { "name": "Create a new Note", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/notes.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 Note" }, { "info": { "name": "Return the data for a single Note", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/notes/: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 Note." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Note" }, { "info": { "name": "Update a single Note", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/notes/: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 Note." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single Note" }, { "info": { "name": "Delete a single Note", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/notes/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Note." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single Note" } ] }, { "info": { "name": "Outstanding Client Balances", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all OutstandingClientBalances", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/outstanding_client_balances.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "contact_id", "value": "", "type": "query", "description": "The unique identifier for a single Contact. Use the keyword `null` to match those without a OutstandingClientBalance. The list will be filtered to include only the OutstandingClientBalance 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": "last_paid_end_date", "value": "", "type": "query", "description": "Filter OutstandingClientBalance records for those whose bills have been paid before the specified date" }, { "name": "last_paid_start_date", "value": "", "type": "query", "description": "Filter OutstandingClientBalance records for those whose bills have been paid after the specified date" }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of OutstandingClientBalance records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "newest_bill_due_end_date", "value": "", "type": "query", "description": "Filter OutstandingClientBalance records for the contact's newest bill due date before the specified date" }, { "name": "newest_bill_due_start_date", "value": "", "type": "query", "description": "Filter OutstandingClientBalance records for the contact's newest bill due date after the specified date" }, { "name": "originating_attorney_id", "value": "", "type": "query", "description": "Filters OutstandingClientBalance records to those with matters that have a matching originating attorney." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "responsible_attorney_id", "value": "", "type": "query", "description": "Filter OutstandingClientBalance records to those with matters that have a matching responsible attorney" } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all OutstandingClientBalances" } ] }, { "info": { "name": "Practice Areas", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all PracticeAreas", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/practice_areas.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "code", "value": "", "type": "query", "description": "Filter PracticeArea records to those that match the given code." }, { "name": "created_since", "value": "", "type": "query", "description": "Filter PracticeArea records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter PracticeArea records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of PracticeArea records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "matter_id", "value": "", "type": "query", "description": "Filter PracticeArea records to exclude Legal Aid UK Practice Areas when activities exist on the matter." }, { "name": "name", "value": "", "type": "query", "description": "Filter PracticeArea records to those that match the given name." }, { "name": "order", "value": "", "type": "query", "description": "Orders the PracticeArea records by the given field. Default: `id(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter PracticeArea records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all PracticeAreas" }, { "info": { "name": "Create a new PracticeArea", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/practice_areas.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 PracticeArea" }, { "info": { "name": "Return the data for a single PracticeArea", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/practice_areas/: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 PracticeArea." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single PracticeArea" }, { "info": { "name": "Update a single PracticeArea", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/practice_areas/: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 PracticeArea." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single PracticeArea" }, { "info": { "name": "Delete a single PracticeArea", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/practice_areas/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the PracticeArea." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single PracticeArea" } ] }, { "info": { "name": "Relationships", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all Relationships", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/relationships.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "contact_id", "value": "", "type": "query", "description": "The unique identifier for a single Contact. The keyword `null` is not valid for this field. The list will be filtered to include only the Relationship records with the matching property." }, { "name": "created_since", "value": "", "type": "query", "description": "Filter Relationship records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter Relationship records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of Relationship 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. The keyword `null` is not valid for this field. The list will be filtered to include only the Relationship records with the matching property." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter Relationship records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all Relationships" }, { "info": { "name": "Create a new Relationship", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/relationships.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 Relationship" }, { "info": { "name": "Return the data for a single Relationship", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/relationships/: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 Relationship." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Relationship" }, { "info": { "name": "Update a single Relationship", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/relationships/: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 Relationship." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single Relationship" }, { "info": { "name": "Delete a single Relationship", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/relationships/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Relationship." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single Relationship" } ] }, { "info": { "name": "Reminders", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all Reminders", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/reminders.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter Reminder records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter Reminder records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of Reminder records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "notification_method_id", "value": "", "type": "query", "description": "The unique identifier for a single NotificationMethod. The keyword `null` is not valid for this field. The list will be filtered to include only the Reminder records with the matching property." }, { "name": "order", "value": "", "type": "query", "description": "Orders the Reminder records by the given field. Default: `id(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "state", "value": "", "type": "query", "description": "Filter Reminder records to those with a given state." }, { "name": "subject_id", "value": "", "type": "query", "description": "The unique identifier for a single CalendarEntry or Task. The keyword `null` is not valid for this field. The list will be filtered to include only the Reminder records with the matching property." }, { "name": "subject_type", "value": "", "type": "query", "description": "Filter Reminder records to those of a given subject type, required if using subject_id." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter Reminder 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. The keyword `null` is not valid for this field. The list will be filtered to include only the Reminder records with the matching property." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all Reminders" }, { "info": { "name": "Create a new Reminder", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/reminders.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 Reminder" }, { "info": { "name": "Return the data for a single Reminder", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/reminders/: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 Reminder." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Reminder" }, { "info": { "name": "Update a single Reminder", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/reminders/: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 Reminder." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single Reminder" }, { "info": { "name": "Delete a single Reminder", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/reminders/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Reminder." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single Reminder" } ] }, { "info": { "name": "Reports", "type": "folder" }, "items": [ { "info": { "name": "Download the completed Report", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/reports/:id/download.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Report." } ] }, "docs": "Download the completed Report" }, { "info": { "name": "Return the data for all Reports", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/reports.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "category", "value": "", "type": "query", "description": "Filters Report data by category." }, { "name": "created_before", "value": "", "type": "query", "description": "Filters Report data by date. (Expects an ISO-8601 date)." }, { "name": "created_since", "value": "", "type": "query", "description": "Filter Report records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter Report records to those having the specified unique identifiers." }, { "name": "kind", "value": "", "type": "query", "description": "Filters Report data by kind." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of Report records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "output_format", "value": "", "type": "query", "description": "Filters Report data by format." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "query", "value": "", "type": "query", "description": "Wildcard search for Report name." }, { "name": "source", "value": "", "type": "query", "description": "Filters Report data by source." }, { "name": "state", "value": "", "type": "query", "description": "Filters Report data by state." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter Report records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all Reports" }, { "info": { "name": "Create a new Report", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/reports.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 Report" }, { "info": { "name": "Return the data for a single Report", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/reports/: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 Report." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Report" } ] }, { "info": { "name": "Report Presets", "type": "folder" }, "items": [ { "info": { "name": "Generate a new report for a given preset", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/report_presets/:id/generate_report.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the ReportPreset." } ] }, "docs": "Generate a new report for a given preset" }, { "info": { "name": "Return the data for all ReportPresets", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/report_presets.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "category", "value": "", "type": "query", "description": "Filters ReportPreset data by category." }, { "name": "created_since", "value": "", "type": "query", "description": "Filter ReportPreset records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "has_schedule", "value": "", "type": "query", "description": "Filters ReportPreset records to those that have or do not have a Report Schedule." }, { "name": "ids[]", "value": "", "type": "query", "description": "Filter ReportPreset records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of ReportPreset records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "order", "value": "", "type": "query", "description": "Orders the ReportPreset records by the given field. Default: `id(asc)`." }, { "name": "output_format", "value": "", "type": "query", "description": "Filters ReportPreset data by format." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "query", "value": "", "type": "query", "description": "Wildcard search for ReportPreset name." }, { "name": "schedule_frequency", "value": "", "type": "query", "description": "Filters ReportPreset records to those that have a Report Schedule of the specified frequency." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter ReportPreset records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all ReportPresets" }, { "info": { "name": "Create a new ReportPreset", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/report_presets.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 ReportPreset" }, { "info": { "name": "Return the data for a single ReportPreset", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/report_presets/: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 ReportPreset." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single ReportPreset" }, { "info": { "name": "Update a single ReportPreset", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/report_presets/: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 ReportPreset." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single ReportPreset" }, { "info": { "name": "Delete a single ReportPreset", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/report_presets/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the ReportPreset." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single ReportPreset" } ] }, { "info": { "name": "Report Schedules", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all ReportSchedules", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/report_schedules.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter ReportSchedule records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter ReportSchedule records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of ReportSchedule records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter ReportSchedule records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all ReportSchedules" }, { "info": { "name": "Create a new ReportSchedule", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/report_schedules.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 ReportSchedule" }, { "info": { "name": "Return the data for a single ReportSchedule", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/report_schedules/: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 ReportSchedule." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single ReportSchedule" }, { "info": { "name": "Update a single ReportSchedule", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/report_schedules/: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 ReportSchedule." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single ReportSchedule" }, { "info": { "name": "Delete a single ReportSchedule", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/report_schedules/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the ReportSchedule." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single ReportSchedule" } ] }, { "info": { "name": "Billing Settings", "type": "folder" }, "items": [ { "info": { "name": "Return the billing settings", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/settings/billing.json", "headers": [ { "name": "IF-MODIFIED-SINCE", "value": "" }, { "name": "IF-NONE-MATCH", "value": "" }, { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "duration", "value": "", "type": "query", "description": "Duration string for time rounding, conforming to the Chronic date parser. For example: '3h' or '2:15'." }, { "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)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single BillingSetting" } ] }, { "info": { "name": "Text Snippets", "type": "folder" }, "items": [ { "info": { "name": "Return all text snippets", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/settings/text_snippets.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter TextSnippet records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter TextSnippet records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of TextSnippet records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "order", "value": "", "type": "query", "description": "Orders the TextSnippet 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 `snippet` or `phrase` matching a given string." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter TextSnippet records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all TextSnippets" }, { "info": { "name": "Create a text snippet", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/settings/text_snippets.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 TextSnippet" }, { "info": { "name": "Return the data for the text snippet", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/settings/text_snippets/: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 TextSnippet." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single TextSnippet" }, { "info": { "name": "Update a text snippet", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/settings/text_snippets/: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 TextSnippet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single TextSnippet" }, { "info": { "name": "Destroy a text snippet", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/settings/text_snippets/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the TextSnippet." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single TextSnippet" } ] }, { "info": { "name": "Tasks", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all Tasks", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/tasks.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "assignee_id", "value": "", "type": "query", "description": "The unique identifier for a single User or Contact. Use the keyword `null` to match those without a Task. The list will be filtered to include only the Task records with the matching property." }, { "name": "assignee_type", "value": "", "type": "query", "description": "Filter Task records to those with a specific assignee. Must be passed if filtering by assignee." }, { "name": "assigner_id", "value": "", "type": "query", "description": "The unique identifier for a single User. Use the keyword `null` to match those without a Task. The list will be filtered to include only the Task records with the matching property." }, { "name": "cascading_source_id", "value": "", "type": "query", "description": "Filter Task records to those with a parent task that has the specified ID." }, { "name": "client_id", "value": "", "type": "query", "description": "The unique identifier for a single Contact. Use the keyword `null` to match those without a Task. The list will be filtered to include only the Task records with the matching property." }, { "name": "complete", "value": "", "type": "query", "description": "Filter Task records to those which are complete or not." }, { "name": "created_since", "value": "", "type": "query", "description": "Filter Task records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "name": "due_at_from", "value": "", "type": "query", "description": "Start of date range when querying by due_at in a range. (Expects an ISO-8601 date)." }, { "name": "due_at_present", "value": "", "type": "query", "description": "Filter Task records to those that have a due date specified, or not." }, { "name": "due_at_to", "value": "", "type": "query", "description": "End of date range when querying by due_at in a range. (Expects an ISO-8601 date)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter Task records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of Task 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 Task. The list will be filtered to include only the Task records with the matching property." }, { "name": "order", "value": "", "type": "query", "description": "Orders the Task records by the given field. Default: `id(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "permission", "value": "", "type": "query", "description": "Filter Task records to those with the given permission. Returns all tasks by default." }, { "name": "priority", "value": "", "type": "query", "description": "Filter Task records to those with the given priority." }, { "name": "query", "value": "", "type": "query", "description": "Wildcard search for `name` or `description` matching a given string." }, { "name": "responsible_attorney_id", "value": "", "type": "query", "description": "Filter Task records to those that have an associated matter with a responsible attorney ID." }, { "name": "status", "value": "", "type": "query", "description": "Filter Task records to those with the given status. Users without advanced tasks enabled may only specify 'complete' or 'pending'." }, { "name": "statuses[]", "value": "", "type": "query", "description": "Filter Task records to those with the given statuses. Users without advanced tasks enabled may only specify 'complete' or 'pending'." }, { "name": "statute_of_limitations", "value": "", "type": "query", "description": "Filter Task records to those which are a statute of limitations or not." }, { "name": "task_type_id", "value": "", "type": "query", "description": "The unique identifier for a single TaskType. Use the keyword `null` to match those without a Task. The list will be filtered to include only the Task records with the matching property." }, { "name": "time_entries_present", "value": "", "type": "query", "description": "Filter Task records to those that have associated time entries, or not." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter Task records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all Tasks" }, { "info": { "name": "Create a new Task", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/tasks.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 Task" }, { "info": { "name": "Return the data for a single Task", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/tasks/: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 Task." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Task" }, { "info": { "name": "Update a single Task", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/tasks/: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 Task." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single Task" }, { "info": { "name": "Delete a single Task", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/tasks/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Task." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single Task" } ] }, { "info": { "name": "Calendar Visibilities", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all CalendarVisibilities", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/task_calendars.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter CalendarVisibility records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter CalendarVisibility records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of CalendarVisibility records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter CalendarVisibility records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all CalendarVisibilities" }, { "info": { "name": "Return the data for a single CalendarVisibility", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/task_calendars/: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 CalendarVisibility." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single CalendarVisibility" }, { "info": { "name": "Update a single CalendarVisibility", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/task_calendars/: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 CalendarVisibility." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single CalendarVisibility" } ] }, { "info": { "name": "Task Templates", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all TaskTemplates", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/task_templates.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter TaskTemplate records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter TaskTemplate records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of TaskTemplate records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "order", "value": "", "type": "query", "description": "Orders the TaskTemplate records by the given field. Default: `id(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "priority", "value": "", "type": "query", "description": "Filter TaskTemplate records to those with the given priority." }, { "name": "query", "value": "", "type": "query", "description": "Wildcard search for `name` matching a given string." }, { "name": "task_template_list_id", "value": "", "type": "query", "description": "The unique identifier for a single TaskTemplateList. The keyword `null` is not valid for this field. The list will be filtered to include only the TaskTemplate records with the matching property." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter TaskTemplate records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all TaskTemplates" }, { "info": { "name": "Create a new TaskTemplate", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/task_templates.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 TaskTemplate" }, { "info": { "name": "Return the data for a single TaskTemplate", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/task_templates/: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 TaskTemplate." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single TaskTemplate" }, { "info": { "name": "Update a single TaskTemplate", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/task_templates/: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 TaskTemplate." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single TaskTemplate" }, { "info": { "name": "Delete a single TaskTemplate", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/task_templates/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the TaskTemplate." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single TaskTemplate" } ] }, { "info": { "name": "Task Template Lists", "type": "folder" }, "items": [ { "info": { "name": "Copy a TaskTemplateList", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/task_template_lists/:id/copy.json", "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 TaskTemplateList." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a copy of the TaskTemplateList identified by the `id` path parameter.\n" }, { "info": { "name": "Return the data for all TaskTemplateLists", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/task_template_lists.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter TaskTemplateList records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "name": "empty", "value": "", "type": "query", "description": "Filter TaskTemplateList records to those that either contain at least one task template or contain none." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter TaskTemplateList records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of TaskTemplateList records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "order", "value": "", "type": "query", "description": "Orders the TaskTemplateList records by the given field. Default: `id(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "practice_area_id", "value": "", "type": "query", "description": "The unique identifier for a single PracticeArea. Use the keyword `null` to match those without a TaskTemplateList. The list will be filtered to include only the TaskTemplateList records with the matching property." }, { "name": "query", "value": "", "type": "query", "description": "Wildcard search for `name` matching a given string." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter TaskTemplateList records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all TaskTemplateLists" }, { "info": { "name": "Create a new TaskTemplateList", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/task_template_lists.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 TaskTemplateList" }, { "info": { "name": "Return the data for a single TaskTemplateList", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/task_template_lists/: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 TaskTemplateList." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single TaskTemplateList" }, { "info": { "name": "Update a single TaskTemplateList", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/task_template_lists/: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 TaskTemplateList." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single TaskTemplateList" }, { "info": { "name": "Delete a single TaskTemplateList", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/task_template_lists/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the TaskTemplateList." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single TaskTemplateList" } ] }, { "info": { "name": "Task Types", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all TaskTypes", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/task_types.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter TaskType records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "name": "enabled", "value": "", "type": "query", "description": "Filter TaskType records to those that are enabled or disabled." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter TaskType records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of TaskType records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "name", "value": "", "type": "query", "description": "Filter TaskType records to those with the given name." }, { "name": "order", "value": "", "type": "query", "description": "Orders the TaskType 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 `name` matching a given string." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter TaskType records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all TaskTypes" }, { "info": { "name": "Create a new TaskType", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/task_types.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 TaskType" }, { "info": { "name": "Return the data for a single TaskType", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/task_types/: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 TaskType." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single TaskType" }, { "info": { "name": "Update a single TaskType", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/task_types/: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 TaskType." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single TaskType" } ] }, { "info": { "name": "Tax Rate Configurations", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all TaxRateConfigurations", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/tax_rate_configurations.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter TaxRateConfiguration records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter TaxRateConfiguration records to those having the specified unique identifiers." }, { "name": "include_system", "value": "", "type": "query", "description": "When true (default), system tax rates (\"Do not apply tax\", \"Tax exempt\") are included in the response. Pass include_system=false to exclude them." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of TaxRateConfiguration records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "order", "value": "", "type": "query", "description": "Orders the TaxRateConfiguration records by the given field. Default: `id(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter TaxRateConfiguration records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all TaxRateConfigurations" }, { "info": { "name": "Create a new TaxRateConfiguration", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/tax_rate_configurations.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 TaxRateConfiguration" }, { "info": { "name": "Return the data for a single TaxRateConfiguration", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/tax_rate_configurations/: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 TaxRateConfiguration." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single TaxRateConfiguration" }, { "info": { "name": "Update a single TaxRateConfiguration", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/tax_rate_configurations/: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 TaxRateConfiguration." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single TaxRateConfiguration" }, { "info": { "name": "Delete a single TaxRateConfiguration", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/tax_rate_configurations/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the TaxRateConfiguration." } ] }, "docs": "A TaxRateConfiguration can not be deleted if it is a system tax rate, has already been deleted, or is in use — set as an invoice default, used on one or more expenses, used on one or more expense categories, or used in one or more unpaid invoices." } ] }, { "info": { "name": "Timers", "type": "folder" }, "items": [ { "info": { "name": "Return the data for a single Timer", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/timer.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)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Timer" }, { "info": { "name": "Create a new Timer", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/timer.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 Timer" }, { "info": { "name": "Delete a single Timer", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/timer.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single Timer" } ] }, { "info": { "name": "Trust Line Items", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all TrustLineItems", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/trust_line_items.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "bill_id", "value": "", "type": "query", "description": "The unique identifier for a single Bill. The keyword `null` is not valid for this field. The list will be filtered to include only the TrustLineItem records with the matching property." }, { "name": "created_since", "value": "", "type": "query", "description": "Filter TrustLineItem records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter TrustLineItem records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of TrustLineItem 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 TrustLineItem. The list will be filtered to include only the TrustLineItem records with the matching property." }, { "name": "order", "value": "", "type": "query", "description": "Orders the TrustLineItem records by the given field. Default: `id(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter TrustLineItem records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all TrustLineItems" }, { "info": { "name": "Update a single TrustLineItem", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/trust_line_items/: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 TrustLineItem." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single TrustLineItem" } ] }, { "info": { "name": "Trust Requests", "type": "folder" }, "items": [ { "info": { "name": "Create a new TrustRequest", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/trust_requests.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 TrustRequest" } ] }, { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "Return the data for the current User", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/users/who_am_i.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)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single User" }, { "info": { "name": "Return the data for all Users", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/users.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter User records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "name": "enabled", "value": "", "type": "query", "description": "Filter User records to those that are enabled or disabled." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter User records to those having the specified unique identifiers." }, { "name": "include_co_counsel", "value": "", "type": "query", "description": "Filter User to include co-counsel users" }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of User records to be returned. Limit can range between 1 and 2000. Default: `2000`." }, { "name": "name", "value": "", "type": "query", "description": "Filter User records to those with the given name." }, { "name": "order", "value": "", "type": "query", "description": "Orders the User records by the given field. Default: `id(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "pending_setup", "value": "", "type": "query", "description": "Filter User records based on whether or not they are still being setup." }, { "name": "role", "value": "", "type": "query", "description": "Filter User records to those with a specific role." }, { "name": "subscription_type", "value": "", "type": "query", "description": "Filter User records to those with a specific subscription type." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter User records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all Users" }, { "info": { "name": "Return the data for a single User", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/users/: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 User." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single User" } ] }, { "info": { "name": "Utbms Sets", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all the utbms sets", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/utbms/sets.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter UtbmsSet records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter UtbmsSet records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of UtbmsSet records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "order", "value": "", "type": "query", "description": "Orders the UtbmsSet records by the given field. Default: `id(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter UtbmsSet records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all UtbmsSets" } ] }, { "info": { "name": "Utbms Codes", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all UtbmsCodes", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/utbms/codes.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter UtbmsCode records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter UtbmsCode records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of UtbmsCode records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "order", "value": "", "type": "query", "description": "Orders the UtbmsCode records by the given field. Default: `id(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "type", "value": "", "type": "query", "description": "Filter UtbmsCode records to those of a given type." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter UtbmsCode records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "name": "utbms_set_id", "value": "", "type": "query", "description": "The unique identifier for a single UtbmsSet. Use the keyword `null` to match those without a UtbmsCode. The list will be filtered to include only the UtbmsCode records with the matching property." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all UtbmsCodes" }, { "info": { "name": "Return the data for a single UtbmsCode", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/utbms/codes/: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 UtbmsCode." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single UtbmsCode" } ] }, { "info": { "name": "Webhooks", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all Webhooks", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/webhooks.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter Webhook records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter Webhook records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of Webhook records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "order", "value": "", "type": "query", "description": "Orders the Webhook records by the given field. Default: `id(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter Webhook records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all Webhooks" }, { "info": { "name": "Create a new Webhook", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/webhooks.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 Webhook" }, { "info": { "name": "Return the data for a single Webhook", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/webhooks/: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 Webhook." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Webhook" }, { "info": { "name": "Update a single Webhook", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/webhooks/: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 Webhook." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single Webhook" }, { "info": { "name": "Delete a single Webhook", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/webhooks/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Webhook." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single Webhook" } ] }, { "info": { "name": "Civil Certificated Rates", "type": "folder" }, "items": [ { "info": { "name": "List Civil Certificated Rates", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/lauk_civil_certificated_rates.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "activity", "value": "", "type": "query", "description": "Filter by activity." }, { "name": "activity_sub_category", "value": "", "type": "query", "description": "Filter by activity sub-category." }, { "name": "attended_several_hearings_for_multiple_clients", "value": "", "type": "query", "description": "Filter by whether multiple hearings were attended for multiple clients." }, { "name": "category_of_law", "value": "", "type": "query", "description": "Filter by category of law." }, { "name": "change_of_solicitor", "value": "", "type": "query", "description": "Filter by change of solicitor status." }, { "name": "court", "value": "", "type": "query", "description": "Filter by court." }, { "name": "eligible_for_sqm", "value": "", "type": "query", "description": "Filter by SQM eligibility." }, { "name": "fee_scheme", "value": "", "type": "query", "description": "Fee scheme" }, { "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": "first_conducting_solicitor", "value": "", "type": "query", "description": "Filter by first conducting solicitor status." }, { "name": "key", "value": "", "type": "query", "description": "Filter by key." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of LaukCivilCertificatedRate records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "number_of_clients", "value": "", "type": "query", "description": "Filter by number of clients." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "party", "value": "", "type": "query", "description": "Filter by party." }, { "name": "post_transfer_clients_represented", "value": "", "type": "query", "description": "Filter by post-transfer clients represented." }, { "name": "rate_type", "value": "", "type": "query", "description": "Filter by rate type." }, { "name": "region", "value": "", "type": "query", "description": "Filter by region." }, { "name": "session_type", "value": "", "type": "query", "description": "Filter by session type." }, { "name": "user_type", "value": "", "type": "query", "description": "Filter by user type." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all LaukCivilCertificatedRates" } ] }, { "info": { "name": "Civil Controlled Rates", "type": "folder" }, "items": [ { "info": { "name": "List Civil Controlled Rates", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/lauk_civil_controlled_rates.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "activity", "value": "", "type": "query", "description": "Filter by activity." }, { "name": "category_of_law", "value": "", "type": "query", "description": "Filter by category of law." }, { "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": "key", "value": "", "type": "query", "description": "Filter by key." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of LaukCivilControlledRate records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "matter_type_1", "value": "", "type": "query", "description": "Filter by matter type 1." }, { "name": "matter_type_2", "value": "", "type": "query", "description": "Filter by matter type 2." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "rate_type", "value": "", "type": "query", "description": "Filter by rate type." }, { "name": "region", "value": "", "type": "query", "description": "Filter by region." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all LaukCivilControlledRates" } ] }, { "info": { "name": "Criminal Controlled Rates", "type": "folder" }, "items": [ { "info": { "name": "List Criminal Controlled Rates", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/lauk_criminal_controlled_rates.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "activity", "value": "", "type": "query", "description": "Filter by activity." }, { "name": "category_of_law", "value": "", "type": "query", "description": "Filter by category of law." }, { "name": "counsel", "value": "", "type": "query", "description": "Filter by counsel." }, { "name": "court", "value": "", "type": "query", "description": "Filter by court." }, { "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": "key", "value": "", "type": "query", "description": "Filter by key." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of LaukCriminalControlledRate records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "rate_type", "value": "", "type": "query", "description": "Filter by rate type." }, { "name": "region", "value": "", "type": "query", "description": "Filter by region." }, { "name": "solicitor_type", "value": "", "type": "query", "description": "Filter by solicitor type." }, { "name": "standard_fee_category", "value": "", "type": "query", "description": "Filter by standard fee category." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all LaukCriminalControlledRates" } ] }, { "info": { "name": "Comments", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all Comments", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/comments.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter Comment records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "item_id", "value": "", "type": "query", "description": "The ID of the Document or Folder this Comment belongs to" }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of Comment records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter Comment records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all Comments" }, { "info": { "name": "Create a new Comment", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/comments.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 Comment" }, { "info": { "name": "Return the data for a single Comment", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/comments/: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 Comment." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Comment" }, { "info": { "name": "Update a single Comment", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/comments/: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 Comment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single Comment" }, { "info": { "name": "Delete a single Comment", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/comments/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Comment." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single Comment" } ] }, { "info": { "name": "Document Archives", "type": "folder" }, "items": [ { "info": { "name": "Download the DocumentArchive. Will return a 303 See Other redirecting to the download URL for the DocumentArchive", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/document_archives/:id/download.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the DocumentArchive." } ] }, "docs": "Download the DocumentArchive. Will return a 303 See Other redirecting to the download URL for the DocumentArchive" }, { "info": { "name": "Create a new DocumentArchive", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/document_archives.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 DocumentArchive" }, { "info": { "name": "Return the data for a single DocumentArchive", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/document_archives/: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 DocumentArchive." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single DocumentArchive" } ] }, { "info": { "name": "Documents", "type": "folder" }, "items": [ { "info": { "name": "Download the Document. Will return a 303 See Other redirecting to the download URL for the Document", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/documents/:id/download.json", "params": [ { "name": "document_version_id", "value": "", "type": "query", "description": "The unique identifier for a DocumentVersion to be downloaded. Defaults to the latest." }, { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Document." } ] }, "docs": "Download the Document. Will return a 303 See Other redirecting to the download URL for the Document" }, { "info": { "name": "Copy a Document", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/documents/:id/copy.json", "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 Document." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Copies the latest document version of a Document into a new Document. The parameters `filename` and `name` will be copied from the source Document if none are provided.\n" }, { "info": { "name": "Return the data for all Documents", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/documents.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "contact_id", "value": "", "type": "query", "description": "The unique identifier for a single Contact. Use the keyword `null` to match those without a Document. The list will be filtered to include only the Document records with the matching property." }, { "name": "created_since", "value": "", "type": "query", "description": "Filter Document records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "name": "document_category_id", "value": "", "type": "query", "description": "The unique identifier for a single DocumentCategory. Use the keyword `null` to match those without a Document. The list will be filtered to include only the Document records with the matching property." }, { "name": "external_property_name", "value": "", "type": "query", "description": "Filter records to only those with the given external property(s) name set.\n\ne.g. `?external_property_name=Name`\n" }, { "name": "external_property_value", "value": "", "type": "query", "description": "Filter records to only those with the given external property(s) value set. Requires external property name as well.\n\ne.g. `?external_property_name=Name&external_property_value=Value`\n" }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter Document records to those having the specified unique identifiers." }, { "name": "include_deleted", "value": "", "type": "query", "description": "Allow trashed Document record to be included." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of Document records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "locked", "value": "", "type": "query", "description": "Filter Document records to those that are locked." }, { "name": "matter_id", "value": "", "type": "query", "description": "The unique identifier for a single Matter. Use the keyword `null` to match those without a Document. The list will be filtered to include only the Document records with the matching property." }, { "name": "order", "value": "", "type": "query", "description": "Orders the Document records by the given field. Default: `id(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "parent_id", "value": "", "type": "query", "description": "The unique identifier for a single Folder. Use the keyword `null` to match those without a Document. The list will be filtered to include only the Document records with the matching property." }, { "name": "query", "value": "", "type": "query", "description": "Wildcard search for `name` matching the given string." }, { "name": "scope", "value": "", "type": "query", "description": "Filters Document record to those being a child of the parent Folder, or a descendant of the parent Folder. Default is `children`." }, { "name": "show_uncompleted", "value": "", "type": "query", "description": "Allow Document record being uploaded to be included." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter Document records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all Documents" }, { "info": { "name": "Create a new Document", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/documents.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": "Create a Document, or Create Document Version to an existing Document.\n" }, { "info": { "name": "Return the data for a single Document", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/documents/: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 Document." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Document" }, { "info": { "name": "Update a single Document", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/documents/: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 Document." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Document, move Document to another Folder, and/or restore a trashed Document.\n" }, { "info": { "name": "Delete a single Document", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/documents/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Document." } ] }, "docs": "Deleting a Document using this method will move it to the trash instead of permanently deleting it. Trashed Documents are permanently deleted after 30 days. The following errors may be returned:\n\n- `409 Conflict`: The Document (or one of its ancestor folders) is currently being modified by another request, and cannot be trashed.\n" } ] }, { "info": { "name": "Document Versions", "type": "folder" }, "items": [ { "info": { "name": "Save a specific document version as the latest version of the document", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/documents/:id/versions/:document_version_id/save_as_latest_version.json", "params": [ { "name": "document_version_id", "value": "", "type": "path", "description": "ID of the Document Version" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Document" } ] }, "docs": "This operation creates a new document version based on the specified version and updates the document to point to this new version as the latest" }, { "info": { "name": "Return the data for all DocumentVersions", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/documents/:id/versions.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)." }, { "name": "fully_uploaded", "value": "", "type": "query", "description": "Filter DocumentVersion records to those with the given `fully_uploaded` status." }, { "name": "id", "value": "", "type": "query", "description": "The unique identifier for the DocumentVersion." }, { "name": "id", "value": "", "type": "path", "description": "ID of the Document" }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of DocumentVersion records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all DocumentVersions" } ] }, { "info": { "name": "Document Automations", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all DocumentAutomations", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/document_automations.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter DocumentAutomation records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter DocumentAutomation records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of DocumentAutomation records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "order", "value": "", "type": "query", "description": "Orders the DocumentAutomation records by the given field. Default: `id(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter DocumentAutomation records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all DocumentAutomations" }, { "info": { "name": "Create a new DocumentAutomation", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/document_automations.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 DocumentAutomation" }, { "info": { "name": "Return the data for a single DocumentAutomation", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/document_automations/: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 DocumentAutomation." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single DocumentAutomation" } ] }, { "info": { "name": "Document Categories", "type": "folder" }, "items": [ { "info": { "name": "Return the data for all DocumentCategories", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/document_categories.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter DocumentCategory records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter DocumentCategory records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of DocumentCategory records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "order", "value": "", "type": "query", "description": "Orders the DocumentCategory 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 `name` matching a given string." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter DocumentCategory records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all DocumentCategories" }, { "info": { "name": "Create a new DocumentCategory", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/document_categories.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 DocumentCategory" }, { "info": { "name": "Return the data for a single DocumentCategory", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/document_categories/: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 DocumentCategory." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single DocumentCategory" }, { "info": { "name": "Update a single DocumentCategory", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/document_categories/: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 DocumentCategory." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single DocumentCategory" }, { "info": { "name": "Delete a single DocumentCategory", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/document_categories/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the DocumentCategory." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single DocumentCategory" } ] }, { "info": { "name": "Document Templates", "type": "folder" }, "items": [ { "info": { "name": "Get the contents of the DocumentTemplate", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/document_templates/:id/download.json", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the DocumentTemplate." } ] }, "docs": "Get the contents of the DocumentTemplate" }, { "info": { "name": "Return the data for all DocumentTemplates", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/document_templates.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "created_since", "value": "", "type": "query", "description": "Filter DocumentTemplate records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter DocumentTemplate records to those having the specified unique identifiers." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of DocumentTemplate records to be returned. Limit can range between 1 and 200. Default: `200`." }, { "name": "order", "value": "", "type": "query", "description": "Orders the DocumentTemplate records by the given field. Default: `id(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter DocumentTemplate records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all DocumentTemplates" }, { "info": { "name": "Create a new DocumentTemplate", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/document_templates.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 DocumentTemplate" }, { "info": { "name": "Return the data for a single DocumentTemplate", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/document_templates/: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 DocumentTemplate." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single DocumentTemplate" }, { "info": { "name": "Update a single DocumentTemplate", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/document_templates/: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 DocumentTemplate." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Outlines the parameters and data fields used when updating a single DocumentTemplate" }, { "info": { "name": "Delete a single DocumentTemplate", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/document_templates/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the DocumentTemplate." } ] }, "docs": "Outlines the parameters, optional and required, used when deleting the record for a single DocumentTemplate" } ] }, { "info": { "name": "Folders", "type": "folder" }, "items": [ { "info": { "name": "Return the data of the contents of a Folder", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/folders/list.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "contact_id", "value": "", "type": "query", "description": "The unique identifier for a single Contact. Use the keyword `null` to match those without a Folder. The list will be filtered to include only the Folder records with the matching property." }, { "name": "created_since", "value": "", "type": "query", "description": "Filter Folder records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "name": "document_category_id", "value": "", "type": "query", "description": "The unique identifier for a single DocumentCategory. Use the keyword `null` to match those without a Folder. The list will be filtered to include only the Folder records with the matching property." }, { "name": "external_property_name", "value": "", "type": "query", "description": "Filter records to only those with the given external property(s) name set.\n\ne.g. `?external_property_name=Name`\n" }, { "name": "external_property_value", "value": "", "type": "query", "description": "Filter records to only those with the given external property(s) value set. Requires external property name as well.\n\ne.g. `?external_property_name=Name&external_property_value=Value`\n" }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter Folder records to those having the specified unique identifiers." }, { "name": "include_deleted", "value": "", "type": "query", "description": "Allow trashed Folder record to be included." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of Folder 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 Folder. The list will be filtered to include only the Folder records with the matching property." }, { "name": "order", "value": "", "type": "query", "description": "Orders the Folder records by the given field. Default: `id(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "parent_id", "value": "", "type": "query", "description": "The unique identifier for a single Folder.\n\nWhen returning the data of the contents of a Folder, the keyword `null` is not valid for this field. If no Folder is provided, it will default to the account's root Folder.\n\nWhen returning the data for all Folders, use the keyword `null` to match those without a Folder. The list will be filtered to include only the Folder records with the matching property.\n" }, { "name": "query", "value": "", "type": "query", "description": "Wildcard search for `name` matching the given string." }, { "name": "scope", "value": "", "type": "query", "description": "Filters Folder record to those being a child of the parent Folder, or a descendant of the parent Folder. Default is `children`." }, { "name": "show_uncompleted", "value": "", "type": "query", "description": "Allow Folder record being uploaded to be included." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter Folder records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Return the data of the contents of a Folder.\n\nNote: offset pagination is not supported for this endpoint. Use cursor pagination if you're looking to paginate through the results.\n" }, { "info": { "name": "Return the data for all Folders", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/folders.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "contact_id", "value": "", "type": "query", "description": "The unique identifier for a single Contact. Use the keyword `null` to match those without a Folder. The list will be filtered to include only the Folder records with the matching property." }, { "name": "created_since", "value": "", "type": "query", "description": "Filter Folder records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp)." }, { "name": "document_category_id", "value": "", "type": "query", "description": "The unique identifier for a single DocumentCategory. Use the keyword `null` to match those without a Folder. The list will be filtered to include only the Folder records with the matching property." }, { "name": "external_property_name", "value": "", "type": "query", "description": "Filter records to only those with the given external property(s) name set.\n\ne.g. `?external_property_name=Name`\n" }, { "name": "external_property_value", "value": "", "type": "query", "description": "Filter records to only those with the given external property(s) value set. Requires external property name as well.\n\ne.g. `?external_property_name=Name&external_property_value=Value`\n" }, { "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": "ids[]", "value": "", "type": "query", "description": "Filter Folder records to those having the specified unique identifiers." }, { "name": "include_deleted", "value": "", "type": "query", "description": "Allow trashed Folder record to be included." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of Folder 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 Folder. The list will be filtered to include only the Folder records with the matching property." }, { "name": "order", "value": "", "type": "query", "description": "Orders the Folder records by the given field. Default: `id(asc)`." }, { "name": "page_token", "value": "", "type": "query", "description": "A token specifying which page to return." }, { "name": "parent_id", "value": "", "type": "query", "description": "The unique identifier for a single Folder.\n\nWhen returning the data of the contents of a Folder, the keyword `null` is not valid for this field. If no Folder is provided, it will default to the account's root Folder.\n\nWhen returning the data for all Folders, use the keyword `null` to match those without a Folder. The list will be filtered to include only the Folder records with the matching property.\n" }, { "name": "query", "value": "", "type": "query", "description": "Wildcard search for `name` matching the given string." }, { "name": "scope", "value": "", "type": "query", "description": "Filters Folder record to those being a child of the parent Folder, or a descendant of the parent Folder. Default is `children`." }, { "name": "updated_since", "value": "", "type": "query", "description": "Filter Folder records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp)." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for all Folders" }, { "info": { "name": "Create a new Folder", "type": "http" }, "http": { "method": "POST", "url": "https://app.clio.com/api/v4/folders.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": "Create a Folder to an existing folder.\n" }, { "info": { "name": "Return the data for a single Folder", "type": "http" }, "http": { "method": "GET", "url": "https://app.clio.com/api/v4/folders/: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 Folder." } ] }, "docs": "Outlines the parameters, optional and required, used when requesting the data for a single Folder" }, { "info": { "name": "Update a single Folder", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.clio.com/api/v4/folders/: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 Folder." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Folder, move Folder to another Folder, and/or restore a trashed Folder.\n" }, { "info": { "name": "Delete a single Folder", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.clio.com/api/v4/folders/:id.json", "headers": [ { "name": "X-API-VERSION", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier for the Folder." } ] }, "docs": "Deleting a Folder using this method will move it to the trash instead of permanently deleting it. Trashed Folders are permanently deleted after 30 days. The following errors may be returned:\n\n- `400 Bad Request`: The Folder cannot be trashed. The `type` of the error will be `DeleteFailed` and the `message` of the error will be one of the following:\n - `Delete failed: This folder contains more than 100,000 items and cannot be trashed. Please trash some of the items inside it before trying again." } ] } ], "bundled": true }