v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB

Contacts

List contacts

List the contacts of the company.

Required scope: contacts:read

get/contacts

Query parameters

qstring

Search query object with the optional properties updated_after and updated_before, whose value should be a timestamp in seconds with up to 3 decimal places.

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 contacts. Either created_at or updated_at.

sort_order'asc' | 'desc'

Example:asc

Order by which results should be sorted

Response

Array of contacts

Example response

{
  "_pagination": {
    "next": "https://yourCompany.api.frontapp.com/contacts?page_token=e0b5767cb0f1100743d46f67fcd765caac2ed"
  },
  "_links": {
    "self": "https://yourCompany.api.frontapp.com/contacts"
  },
  "_results": [
    {
      "_links": {
        "self": "https://yourCompany.api.frontapp.com/contacts/crd_3cgz4ge\"",
        "related": {
          "notes": "https://yourCompany.api.frontapp.com/contacts/crd_3cgz4ge/notes",
          "conversations": "https://yourCompany.api.frontapp.com/contacts/crd_3cgz4ge/conversations"
        }
      },
      "id": "crd_3cgz4ge",
      "name": "Dwight Schrute",
      "description": "Assistant to the regional manager",
      "avatar_url": "https://yourCompany.api.frontapp.com/contacts/crd_3cgz4ge/avatar-1673436467707",
      "groups": [
        {
          "_links": {
            "self": "https://yourCompany.api.frontapp.com/contact_lists/grp_3j342",
            "related": {
              "contacts": "https://yourCompany.api.frontapp.com/contact_lists/grp_3j342/contacts",
              "owner": "https://yourCompany.api.frontapp.com/teammates/tea_e35u"
            }
          },
          "id": "grp_3j342",
          "name": "Party Planning Committee"
        }
      ],
      "lists": [
        {
          "_links": {
            "self": "https://yourCompany.api.frontapp.com/contact_lists/grp_3j342",
            "related": {
              "contacts": "https://yourCompany.api.frontapp.com/contact_lists/grp_3j342/contacts",
              "owner": "https://yourCompany.api.frontapp.com/teammates/tea_e35u"
            }
          },
          "id": "grp_3j342",
          "name": "Party Planning Committee"
        }
      ],
      "handles": [
        {
          "handle": "dwight@limitlesspaper.com",
          "source": "email"
        }
      ],
      "custom_fields": {
        "city": "London, UK",
        "isVIP": true,
        "renewal_date": 1525417200,
        "sla_time": 90,
        "owner": "leela@planet-express.com",
        "replyTo": "inb_55c8c149",
        "Job Title": "firefighter"
      },
      "is_private": true
    }
  ]
}