{ "opencollection": "1.0.0", "info": { "name": "Clio API Documentation Activities Billable Clients API", "version": "v4" }, "items": [ { "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" } ] } ], "bundled": true }