Get Contact

GET 
/crm/contacts/:contactId

Get contact based on id

Request

Path Parameters

contactId stringrequired

The item id of the contact record

Query Parameters

credentialId stringrequired

The ID of the credential.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

contact

object

remoteId string

firstName string

lastName string

account

addresses

object[]

Array [

addressType string

]

emailAddresses array

phoneNumbers array

lastActivityAt string

id string

remoteCreatedAt string

remoteUpdatedAt string

remoteDeleted boolean

Default value: true

createdAt string

updatedAt string

Example (from schema)

{
  "contact": {
    "remoteId": "151",
    "firstName": "Brandon",
    "lastName": "Looker",
    "account": {},
    "addresses": [
      {
        "addressType": "main"
      }
    ],
    "emailAddresses": [
      null
    ],
    "phoneNumbers": [
      null
    ],
    "lastActivityAt": "2023-10-27T14:42:44.054Z",
    "id": "4b5cc100-b204-44fa-74df-109e233541a8",
    "remoteCreatedAt": "2023-11-19T17:00:17.000Z",
    "remoteUpdatedAt": "2023-11-19T17:00:17.000Z",
    "remoteDeleted": false,
    "createdAt": "2024-02-22T11:17:53.264Z",
    "updatedAt": "2024-02-22T13:54:03.445Z"
  }
}

Result

{
  "contact": {
    "remoteId": "151",
    "firstName": "Brandon",
    "lastName": "Looker",
    "account": null,
    "addresses": [
      {
        "addressType": "main"
      }
    ],
    "emailAddresses": [],
    "phoneNumbers": [],
    "lastActivityAt": "2023-10-27T14:42:44.054Z",
    "id": "4b5cc100-b204-44fa-74df-109e233541a8",
    "remoteCreatedAt": "2023-11-19T17:00:17.000Z",
    "remoteUpdatedAt": "2023-11-19T17:00:17.000Z",
    "remoteDeleted": false,
    "createdAt": "2024-02-22T11:17:53.264Z",
    "updatedAt": "2024-02-22T13:54:03.445Z"
  }
}

400

400

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

Loading...