COcoevera
Contact

Get a contact

Returns one contact by id. expand returns related records inline instead of their URIs.

get/entities/Contacts/{id}

Request

Path parameters

idstring uuid required

Id of the Contact record to retrieve.

Query parameters

expandstring

Related records to return inline instead of their URIs, comma-separated; dots reach nested relations. The only parameter this call accepts.

Response

The Contact record.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "address": "string",
    "city": "string",
    "comments": "string",
    "contact_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "country": "string",
    "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
    "email1": "string",
    "email2": "string",
    "email3": "string",
    "email4": "string",
    "email5": "string",
    "first_name": "string",
    "last_name": "string",
    "middle_name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "phone1": "string",
    "phone2": "string",
    "phone3": "string",
    "phone4": "string",
    "phone5": "string",
    "picture_id": "01234567-abcd-dcba-ffff-000000000000",
    "position": "string",
    "quick_account_name": "string",
    "state_province": "string",
    "title": "string",
    "unit_id": "01234567-abcd-dcba-ffff-000000000000",
    "zip_code": "string",
    "revision": 1,
    "formatted_name": "string",
    "exchange_entity_id": "string",
    "gapi_entity_id": "string",
    "o365_entity_id": "string",
    "primary_account_position": "string",
    "account_position": "string",
    "primary_account_relationship": "string",
    "modified_by_user": "2019-01-01T00:00:00"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.