{ "opencollection": "1.0.0", "info": { "name": "Pipedrive API v1 Activities Files API", "version": "1.0.0" }, "items": [ { "info": { "name": "Files", "type": "folder" }, "items": [ { "info": { "name": "Get all files", "type": "http" }, "http": { "method": "GET", "url": "https://api.pipedrive.com/v1/files", "params": [ { "name": "start", "value": "", "type": "query", "description": "Pagination start" }, { "name": "limit", "value": "", "type": "query", "description": "Items shown per page. Please note that a maximum value of 100 is allowed." }, { "name": "sort", "value": "", "type": "query", "description": "Supported fields: `id`, `update_time`" } ], "auth": { "type": "apikey", "key": "x-api-token", "value": "{{x-api-token}}", "placement": "header" } }, "docs": "Returns data about all files." }, { "info": { "name": "Add file", "type": "http" }, "http": { "method": "POST", "url": "https://api.pipedrive.com/v1/files", "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" }, { "name": "deal_id", "type": "text", "value": "" }, { "name": "person_id", "type": "text", "value": "" }, { "name": "org_id", "type": "text", "value": "" }, { "name": "product_id", "type": "text", "value": "" }, { "name": "activity_id", "type": "text", "value": "" }, { "name": "lead_id", "type": "text", "value": "" } ] }, "auth": { "type": "apikey", "key": "x-api-token", "value": "{{x-api-token}}", "placement": "header" } }, "docs": "Lets you upload a file and associate it with a deal, person, organization, activity, product or lead. For more information, see the tutorial for adding a file." }, { "info": { "name": "Create a remote file and link it to an item", "type": "http" }, "http": { "method": "POST", "url": "https://api.pipedrive.com/v1/files/remote", "body": { "type": "form-urlencoded", "data": [ { "name": "file_type", "value": "" }, { "name": "title", "value": "" }, { "name": "item_type", "value": "" }, { "name": "item_id", "value": "" }, { "name": "remote_location", "value": "" } ] }, "auth": { "type": "apikey", "key": "x-api-token", "value": "{{x-api-token}}", "placement": "header" } }, "docs": "Creates a new empty file in the remote location (`googledrive`) that will be linked to the item you supply. For more information, see the tutorial for adding a remote file." }, { "info": { "name": "Link a remote file to an item", "type": "http" }, "http": { "method": "POST", "url": "https://api.pipedrive.com/v1/files/remoteLink", "body": { "type": "form-urlencoded", "data": [ { "name": "item_type", "value": "" }, { "name": "item_id", "value": "" }, { "name": "remote_id", "value": "" }, { "name": "remote_location", "value": "" } ] }, "auth": { "type": "apikey", "key": "x-api-token", "value": "{{x-api-token}}", "placement": "header" } }, "docs": "Links an existing remote file (`googledrive`) to the item you supply. For more information, see the tutorial for adding a remote file." }, { "info": { "name": "Get one file", "type": "http" }, "http": { "method": "GET", "url": "https://api.pipedrive.com/v1/files/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the file" } ], "auth": { "type": "apikey", "key": "x-api-token", "value": "{{x-api-token}}", "placement": "header" } }, "docs": "Returns data about a specific file." }, { "info": { "name": "Update file details", "type": "http" }, "http": { "method": "PUT", "url": "https://api.pipedrive.com/v1/files/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the file" } ], "body": { "type": "form-urlencoded", "data": [ { "name": "name", "value": "" }, { "name": "description", "value": "" } ] }, "auth": { "type": "apikey", "key": "x-api-token", "value": "{{x-api-token}}", "placement": "header" } }, "docs": "Updates the properties of a file." }, { "info": { "name": "Delete a file", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pipedrive.com/v1/files/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the file" } ], "auth": { "type": "apikey", "key": "x-api-token", "value": "{{x-api-token}}", "placement": "header" } }, "docs": "Marks a file as deleted. After 30 days, the file will be permanently deleted." }, { "info": { "name": "Download one file", "type": "http" }, "http": { "method": "GET", "url": "https://api.pipedrive.com/v1/files/:id/download", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the file" } ], "auth": { "type": "apikey", "key": "x-api-token", "value": "{{x-api-token}}", "placement": "header" } }, "docs": "Initializes a file download." } ] } ], "bundled": true }