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