{ "opencollection": "1.0.0", "info": { "name": "API Endpoints subpackage_activities subpackage_playbooks API", "version": "1.0.0" }, "items": [ { "info": { "name": "subpackage_playbooks", "type": "folder" }, "items": [ { "info": { "name": "List or filter playbooks", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/playbook/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "is_archived", "value": "", "type": "query", "description": "Filter for archived or not-archived playbooks. When not provided, both archived and not-archived playbooks will be returned." }, { "name": "position__gt", "value": "", "type": "query", "description": "Filters for where the playbook's `position` is greater than the given value." }, { "name": "created_at__lt", "value": "", "type": "query", "description": "Filters for where the playbook's `created_at` (creation date) is before the given value." } ] }, "docs": "Fetch a list of playbooks for the organization. Results are sorted by position ascending." }, { "info": { "name": "Create a playbook", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/playbook/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new playbook for the organization." }, { "info": { "name": "Fetch a single playbook", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/playbook/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Fetch a single playbook" }, { "info": { "name": "Update a playbook", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/playbook/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing playbook." }, { "info": { "name": "Delete a playbook", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/playbook/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete an existing playbook." }, { "info": { "name": "Archive a playbook", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/playbook/:id/archive/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Archive an existing playbook. Archived playbooks are hidden from active listings but retain their associated history." }, { "info": { "name": "Unarchive a playbook", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/playbook/:id/unarchive/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Restore a previously archived playbook to active status." } ] } ], "bundled": true }