{ "opencollection": "1.0.0", "info": { "name": "Channel Accounts Links API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Links", "type": "folder" }, "items": [ { "info": { "name": "List links", "type": "http" }, "http": { "method": "GET", "url": "https://api2.frontapp.com/links", "params": [ { "name": "q", "value": "", "type": "query", "description": "[Search query object](https://dev.frontapp.com/docs/query-object-q) with a property `types`, whose value should be a list of link types. Links created via the API have type `web` and links created by application objects have type `app_`, matching the app UID where the object is configured. There are also types `jira`, `asana`, `monday`, `trello`, and `github`, which correspond to the integrations built by Front." }, { "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 links. Only supports `id`." }, { "name": "sort_order", "value": "", "type": "query", "description": "Order by which results should be sorted" } ] }, "docs": "List the links of the company paginated by id. Allows filtering by link type via the q.types param.\nThese links include application objects; for more details, see the [Links](https://dev.frontapp.com/reference/links) topic.\n\n\nRequired scope: `links:read`" }, { "info": { "name": "Create link", "type": "http" }, "http": { "method": "POST", "url": "https://api2.frontapp.com/links", "body": { "type": "json", "data": "{}" } }, "docs": "Create a link. You must supply either `pattern` or `external_url` in the request, but not both (`pattern` is for application objects while `external_url` is for standard links). If `pattern` is provided, the API call updates the application objects matching the exact pattern. Keep in mind this endpoint only creates or updates an existing link from an application object. It does not create new application objects. If the link is resolved to an installed links integration, any name retrieved from " }, { "info": { "name": "Get link", "type": "http" }, "http": { "method": "GET", "url": "https://api2.frontapp.com/links/:link_id", "params": [ { "name": "link_id", "value": "", "type": "path", "description": "The link ID" } ] }, "docs": "Fetch a link.\nFor more information on links, see the [Links](https://dev.frontapp.com/reference/links) topic.\n\n\nRequired scope: `links:read`" }, { "info": { "name": "Update a link", "type": "http" }, "http": { "method": "PATCH", "url": "https://api2.frontapp.com/links/:link_id", "params": [ { "name": "link_id", "value": "", "type": "path", "description": "The Link ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a link.\nFor more information on links, see the [Links](https://dev.frontapp.com/reference/links) topic.\n\n\nRequired scope: `links:write`" }, { "info": { "name": "List link conversations", "type": "http" }, "http": { "method": "GET", "url": "https://api2.frontapp.com/links/:link_id/conversations", "params": [ { "name": "link_id", "value": "", "type": "path", "description": "The Link ID" }, { "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)" }, { "name": "sort_by", "value": "", "type": "query", "description": "Field used to sort the conversations. Only supports `date`." }, { "name": "sort_order", "value": "", "type": "query", "description": "Order by which results should be sorted" } ] }, "docs": "List the conversations linked to a specific link. For more advanced filtering, see the [search endpoint](https://dev.frontapp.com/reference/conversations#search-conversations).\nFor more information on links, see the [Links](https://dev.frontapp.com/reference/links) topic.\n\n\nRequired scope: `conversations:read`" } ] } ], "bundled": true }