{ "opencollection": "1.0.0", "info": { "name": "Freshworks Freshcaller Accounts Contacts API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "X-Api-Auth", "value": "{{X-Api-Auth}}", "placement": "header" } }, "items": [ { "info": { "name": "Contacts", "type": "folder" }, "items": [ { "info": { "name": "List all contacts", "type": "http" }, "http": { "method": "GET", "url": "https://{domain}.freshcaller.com/api/v1/contacts", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number for pagination." }, { "name": "per_page", "value": "", "type": "query", "description": "Number of results per page (max 100)." }, { "name": "email", "value": "", "type": "query", "description": "Filter contacts by email address." }, { "name": "phone", "value": "", "type": "query", "description": "Filter contacts by phone number." }, { "name": "company_id", "value": "", "type": "query", "description": "Filter contacts by company ID." } ] }, "docs": "Retrieves a paginated list of all contacts in the helpdesk. Supports filtering by email, phone, mobile, and company." }, { "info": { "name": "Create a contact", "type": "http" }, "http": { "method": "POST", "url": "https://{domain}.freshcaller.com/api/v1/contacts", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new contact in the helpdesk. At least one of name, email, phone, or mobile is required." }, { "info": { "name": "View a contact", "type": "http" }, "http": { "method": "GET", "url": "https://{domain}.freshcaller.com/api/v1/contacts/:contact_id", "params": [ { "name": "contact_id", "value": "", "type": "path", "description": "The ID of the contact." } ] }, "docs": "Retrieves the details of a specific contact by their ID." }, { "info": { "name": "Update a contact", "type": "http" }, "http": { "method": "PUT", "url": "https://{domain}.freshcaller.com/api/v1/contacts/:contact_id", "params": [ { "name": "contact_id", "value": "", "type": "path", "description": "The ID of the contact." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the properties of an existing contact." }, { "info": { "name": "Delete a contact", "type": "http" }, "http": { "method": "DELETE", "url": "https://{domain}.freshcaller.com/api/v1/contacts/:contact_id", "params": [ { "name": "contact_id", "value": "", "type": "path", "description": "The ID of the contact." } ] }, "docs": "Soft-deletes a contact from the helpdesk." }, { "info": { "name": "Merge contacts", "type": "http" }, "http": { "method": "PUT", "url": "https://{domain}.freshcaller.com/api/v1/contacts/:contact_id/merge", "params": [ { "name": "contact_id", "value": "", "type": "path", "description": "The ID of the contact." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Merges secondary contacts into the primary contact specified by the contact_id path parameter." } ] } ], "bundled": true }