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