{ "opencollection": "1.0.0", "info": { "name": "Proton Call Notes Contacts API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "X-Api-Key", "value": "{{X-Api-Key}}", "placement": "header" } }, "items": [ { "info": { "name": "Contacts", "type": "folder" }, "items": [ { "info": { "name": "Search Contacts V1", "type": "http" }, "http": { "method": "POST", "url": "https://api.proton.ai/:company/v1/contacts/search", "headers": [ { "name": "X-User-Id", "value": "" }, { "name": "X-Company", "value": "" } ], "params": [ { "name": "company", "value": "", "type": "path" } ] }, "docs": "Contact Search API v1\nOverview\nThe Contact Search API v1 endpoint allows you to search for contacts within a specific company using a query string and advanced filtering options. This endpoint supports various search operators for flexible and precise contact searches. Contacts represent individual people associated with customers, including their roles, contact information, custom fields, and audit metadata.\nEndpoint\nMethod: POSTURL: {{domain}}/{{company}}/v1/contacts/search\nRequest Format\nRequ" }, { "info": { "name": "Create Contact V1", "type": "http" }, "http": { "method": "POST", "url": "https://api.proton.ai/:company/v1/contacts", "headers": [ { "name": "X-User-Id", "value": "" }, { "name": "X-Company", "value": "" } ], "params": [ { "name": "company", "value": "", "type": "path" } ] }, "docs": "Contact Create API v1\nOverview\nThe Contact Create API v1 endpoint allows you to create a new contact within a specific company. Contacts represent individual people associated with one or more customers, including their roles, contact information, custom fields, and relationship details. This endpoint supports comprehensive contact information including multiple email addresses, phone numbers (with type and extension), custom fields, and multi-customer associations.\nEndpoint\nMethod: POSTURL: {{d" }, { "info": { "name": "Get Contact V1", "type": "http" }, "http": { "method": "GET", "url": "https://api.proton.ai/:company/v1/contacts/:identifier", "headers": [ { "name": "X-User-Id", "value": "" }, { "name": "X-Company", "value": "" } ], "params": [ { "name": "company", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Contact Get API v1\nOverview\nThe Contact Get API v1 endpoint allows you to retrieve a single contact by its identifier within a specific company. The endpoint returns comprehensive contact information including basic details, contact methods, customer associations, and activity counts (calls, emails, quotes, orders). Contacts represent individual people associated with customers, including their roles, contact information, and relationship details.\nEndpoint\nMethod: GETURL: {{domain}}/{{company}}/" }, { "info": { "name": "Edit Contact V1", "type": "http" }, "http": { "method": "PUT", "url": "https://api.proton.ai/:company/v1/contacts/:identifier", "headers": [ { "name": "X-User-Id", "value": "" }, { "name": "X-Company", "value": "" } ], "params": [ { "name": "company", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Contact Update API v1\nOverview\nThe Contact Update API v1 endpoint allows you to edit an existing contact within a specific company. All editable fields are optional; only the fields you supply are updated, and the request must include at least one editable field. The endpoint also supports re-linking a contact to a different set of customers via customer_ids.\nEndpoint\nMethod: PUTURL: {{domain}}/{{company}}/v1/contacts/{identifier}\nPath Parameters\n\n\n\nParameter\nType\nRequired\nDescription\n\n\n\n\nidenti" }, { "info": { "name": "Delete Contact V1", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.proton.ai/:company/v1/contacts/:identifier", "headers": [ { "name": "X-User-Id", "value": "" }, { "name": "X-Company", "value": "" } ], "params": [ { "name": "company", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Contact Delete API v1\nOverview\nThe Contact Delete API v1 endpoint allows you to permanently delete a contact within a specific company. This endpoint performs a hard delete, physically removing the contact record from the database. The deletion is recorded in the audit trail for compliance and tracking purposes.\nEndpoint\nMethod: DELETEURL: {{domain}}/{{company}}/v1/contacts/{{identifier}}\nRequest Format\nURL Parameters\n\n\n\nParameter\nType\nRequired\nDescription\n\n\n\n\ncompany\nstring\nYes\nThe company iden" } ] } ], "bundled": true }