v1

latestOpenAPI 3.1.02026-07-241630614.2 KB

Get contact by ID

This method allows to get a particular contact data by its ID

get/api/v4/contacts/{id}

Path parameters

idinteger required

Contact ID

Query parameters

withstring

This parameter takes a string which may consist of several values separated by commas.

Response

200

idinteger

namestring

first_namestring

last_namestring

responsible_user_idinteger

group_idinteger

created_byinteger

updated_byinteger

created_atinteger

updated_atinteger

{"stackTrail":"paths:/api/v4/contacts/{id}:get:responses:200:content:application/json:schema:properties:closest_task_at","oasType":"schema","type":"unknown"}

account_idinteger

Example response

{
  "id": 3,
  "name": "John Doe",
  "first_name": "John",
  "last_name": "Doe",
  "responsible_user_id": 504141,
  "created_by": 504141,
  "updated_by": 504141,
  "created_at": 1582117331,
  "updated_at": 1590943929,
  "custom_fields_values": [
    {
      "field_id": 3,
      "field_name": "Work phone",
      "field_code": "PHONE",
      "field_type": "multitext",
      "values": [
        {
          "value": "+14155551234",
          "enum_id": 1,
          "enum": "WORK"
        }
      ]
    }
  ],
  "account_id": 28805383,
  "_links": {
    "self": {
      "href": "https://example.amocrm.com/api/v4/contacts/3"
    }
  },
  "_embedded": {
    "leads": [
      {
        "id": 1,
        "_links": {
          "self": {
            "href": "https://example.amocrm.com/api/v4/leads/1"
          }
        }
      }
    ],
    "customers": [
      {
        "id": 134923,
        "_links": {
          "self": {
            "href": "https://example.amocrm.com/api/v4/customers/134923"
          }
        }
      }
    ],
    "companies": [
      {
        "id": 1,
        "_links": {
          "self": {
            "href": "https://example.amocrm.com/api/v4/companies/1"
          }
        }
      }
    ]
  }
}