FRfrontapp
Links

List links

List the links of the company paginated by id. Allows filtering by link type via the q.types param. These links include application objects; for more details, see the Links topic.

Required scope: links:read

get/links

Request

  • Base URL
    https://api2.frontapp.com
  • URL
    https://api2.frontapp.com/links
  • Auth
    HTTP bearer

Query parameters

qstring

Search query object 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_<uid>, 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.

limitinteger
Example:25

Max number of results per page

page_tokenstring
Example:https://yourCompany.api.frontapp.com/endpoint?limit=25&page_token=92f32bcd7625333caf4e0f8fc26d920c812f

Token to use to request the next page

sort_bystring

Field used to sort the links. Only supports id.

sort_order'asc' | 'desc'
Example:asc

Order by which results should be sorted

Response

Array of Links

Example response

{
  "_pagination": {
    "next": "https://yourCompany.api.frontapp.com/links?page_token=4fcb1f8ca11971c5da59c21ea686fd50"
  },
  "_links": {
    "self": "https://yourCompany.api.frontapp.com/links"
  },
  "_results": [
    {
      "_links": {
        "self": "https://yourCompany.api.frontapp.com/links/top_b2wpa"
      },
      "id": "top_b2wpa",
      "name": "JIRA-SCRAN-4567",
      "type": "app_2f76b9ac738de158",
      "external_url": "https://dundermifflin.atlassian.net/browse/PB-SCRAN-4567",
      "custom_fields": {
        "city": "London, UK",
        "isVIP": true,
        "renewal_date": 1525417200,
        "sla_time": 90,
        "owner": "leela@planet-express.com",
        "replyTo": "inb_55c8c149",
        "Job Title": "firefighter"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.