{ "opencollection": "1.0.0", "info": { "name": "Channel Accounts Contacts API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Contacts", "type": "folder" }, "items": [ { "info": { "name": "List contacts", "type": "http" }, "http": { "method": "GET", "url": "https://api2.frontapp.com/contacts", "params": [ { "name": "q", "value": "", "type": "query", "description": "[Search query object](https://dev.frontapp.com/docs/query-object-q) with the optional properties `updated_after` and `updated_before`, whose value should be a timestamp in seconds with up to 3 decimal places." }, { "name": "limit", "value": "", "type": "query", "description": "Max number of results per [page](https://dev.frontapp.com/docs/pagination)" }, { "name": "page_token", "value": "", "type": "query", "description": "Token to use to request the [next page](https://dev.frontapp.com/docs/pagination)" }, { "name": "sort_by", "value": "", "type": "query", "description": "Field used to sort the contacts. Either `created_at` or `updated_at`." }, { "name": "sort_order", "value": "", "type": "query", "description": "Order by which results should be sorted" } ] }, "docs": "List the contacts of the company.\n\nRequired scope: `contacts:read`" }, { "info": { "name": "Create contact", "type": "http" }, "http": { "method": "POST", "url": "https://api2.frontapp.com/contacts", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new contact at the company level.\n\nRequired scope: `contacts:write`" }, { "info": { "name": "Merge contacts", "type": "http" }, "http": { "method": "POST", "url": "https://api2.frontapp.com/contacts/merge", "body": { "type": "json", "data": "{}" } }, "docs": "Merges the contacts specified into a single contact, deleting the merged-in contacts.\nIf a target contact ID is supplied, the other contacts will be merged into that one.\nOtherwise, some contact in the contact ID list will be treated as the target contact.\nMerge conflicts will be resolved in the following ways:\n * name will prioritize manually-updated and non-private contact names\n * descriptions will be concatenated and separated by newlines in order from\n oldest to newest with the (option" }, { "info": { "name": "Get contact", "type": "http" }, "http": { "method": "GET", "url": "https://api2.frontapp.com/contacts/:contact_id", "params": [ { "name": "contact_id", "value": "", "type": "path", "description": "The contact ID. Alternatively, you can supply the contact's source and handle as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1)." } ] }, "docs": "Fetch a contact.\n\nRequired scope: `contacts:read`" }, { "info": { "name": "Update a contact", "type": "http" }, "http": { "method": "PATCH", "url": "https://api2.frontapp.com/contacts/:contact_id", "params": [ { "name": "contact_id", "value": "", "type": "path", "description": "The contact ID. Alternatively, you can supply the contact's source and handle as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a contact.\n\nRequired scope: `contacts:write`" }, { "info": { "name": "Delete a contact", "type": "http" }, "http": { "method": "DELETE", "url": "https://api2.frontapp.com/contacts/:contact_id", "params": [ { "name": "contact_id", "value": "", "type": "path", "description": "The contact ID. Alternatively, you can supply the contact's source and handle as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1)." } ] }, "docs": "Delete a contact.\n\nRequired scope: `contacts:delete`" }, { "info": { "name": "List contact conversations", "type": "http" }, "http": { "method": "GET", "url": "https://api2.frontapp.com/contacts/:contact_id/conversations", "params": [ { "name": "contact_id", "value": "", "type": "path", "description": "The Contact ID. Alternatively, you can supply the contact's source and handle as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1)." }, { "name": "q", "value": "", "type": "query", "description": "[Search query object](https://dev.frontapp.com/docs/query-object-q) with a property `statuses`, whose value should be a list of conversation statuses (`assigned`, `unassigned`, `archived`, or `trashed`). If ticketing is enabled, this endpoint accepts either `status_categories` (`open`, `waiting`, `resolved`) or `status_ids` as an alternative." }, { "name": "limit", "value": "", "type": "query", "description": "Max number of results per [page](https://dev.frontapp.com/docs/pagination)" }, { "name": "page_token", "value": "", "type": "query", "description": "Token to use to request the [next page](https://dev.frontapp.com/docs/pagination)" } ] }, "docs": "List the conversations for a contact in reverse chronological order (newest first). For more advanced filtering, see the [search endpoint](https://dev.frontapp.com/reference/conversations#search-conversations).\n\n\nRequired scope: `conversations:read`" }, { "info": { "name": "List teammate contacts", "type": "http" }, "http": { "method": "GET", "url": "https://api2.frontapp.com/teammates/:teammate_id/contacts", "params": [ { "name": "teammate_id", "value": "", "type": "path", "description": "The teammate ID. Alternatively, you can supply an email as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1)." }, { "name": "q", "value": "", "type": "query", "description": "[Search query object](https://dev.frontapp.com/docs/query-object-q) with the optional properties `updated_after` and `updated_before`, whose value should be a timestamp in seconds with up to 3 decimal places." }, { "name": "limit", "value": "", "type": "query", "description": "Max number of results per [page](https://dev.frontapp.com/docs/pagination)" }, { "name": "page_token", "value": "", "type": "query", "description": "Token to use to request the [next page](https://dev.frontapp.com/docs/pagination)" }, { "name": "sort_by", "value": "", "type": "query", "description": "Field used to sort the contacts. Either `created_at` or `updated_at`." }, { "name": "sort_order", "value": "", "type": "query", "description": "Order by which results should be sorted" } ] }, "docs": "List the contacts of a teammate.\n\nRequired scope: `contacts:read`" }, { "info": { "name": "Create teammate contact", "type": "http" }, "http": { "method": "POST", "url": "https://api2.frontapp.com/teammates/:teammate_id/contacts", "params": [ { "name": "teammate_id", "value": "", "type": "path", "description": "The teammate ID. Alternatively, you can supply an email as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a contact for a teammate.\n\nRequired scope: `contacts:write`" }, { "info": { "name": "List team contacts", "type": "http" }, "http": { "method": "GET", "url": "https://api2.frontapp.com/teams/:team_id/contacts", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The team ID" }, { "name": "q", "value": "", "type": "query", "description": "[Search query object](https://dev.frontapp.com/docs/query-object-q) with the optional properties `updated_after` and `updated_before`, whose value should be a timestamp in seconds with up to 3 decimal places." }, { "name": "limit", "value": "", "type": "query", "description": "Max number of results per [page](https://dev.frontapp.com/docs/pagination)" }, { "name": "page_token", "value": "", "type": "query", "description": "Token to use to request the [next page](https://dev.frontapp.com/docs/pagination)" }, { "name": "sort_by", "value": "", "type": "query", "description": "Field used to sort the contacts. Either `created_at` or `updated_at`." }, { "name": "sort_order", "value": "", "type": "query", "description": "Order by which results should be sorted" } ] }, "docs": "List the contacts of a team (workspace).\n\nRequired scope: `contacts:read`" }, { "info": { "name": "Create team contact", "type": "http" }, "http": { "method": "POST", "url": "https://api2.frontapp.com/teams/:team_id/contacts", "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The team ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a contact for a team (workspace).\n\nRequired scope: `contacts:write`" } ] } ], "bundled": true }