v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB

Contacts

Get contact

Fetch a contact.

Required scope: contacts:read

get/contacts/{contact_id}

Path parameters

contact_idstring required

The contact ID. Alternatively, you can supply the contact's source and handle as a resource alias.

Response

A contact

idstring

Unique identifier of the contact

namestring

Contact name

descriptionstring

Contact description

avatar_urlstring

URL of the contact's avatar

linksstring[]

List of all the links of the contact

custom_fieldsCustomFieldParameter

An object whose key is the name property defined for the custom field in the Front UI. The value of the key must use the same type specified for the custom field, as described in https://dev.frontapp.com/reference/custom-fields

is_privateboolean

Whether or not the contact is individual

Example response

{
  "_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
}