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