Contacts

How to find all available information on an existing customer Contact.
Authentication required, please visit this page for Authentication How To.

Parameters

TenantID - How your specific customer instance is identified, this will be a number. Find this in the app Help (?) icon > MotionCX Voice > Tenant:
RelatedID - Numeric Identifier of Agent related to to ticket.
ID - Numeric identifier of agent. (AKA "Contact ID")
Email - agent email address.
FirstName - Agent First Name
LastName - Agent Last Name
Phone - Agent inbound phone number.
Organization - Organization Agent belongs to.
Title - Title field of agent.
Alias - Can be used to hide the real name of the agent for privacy.
IsAgent - Used to identify Agent vs non-Agent staff.
IsDisabled - Used to search for non-active Agents.
AddRelatedTickets - deprecated feature.
RemoveRelatedTickets - deprecated feature.

Responses available:

Example return:

[
  {
    "id": 13722,
    "tenantId": 2,
    "relatedUserId": null,
    "createdAt": "2022-07-11T15:13:42.2566667",
    "email": "[email protected]",
    "firstName": "Test",
    "lastName": "Agent",
    "address1": null,
    "address2": null,
    "city": null,
    "state": null,
    "postCode": null,
    "phone": null,
    "name": "Test Agent",
    "displayName": [
  {
    "id": 13722,
    "tenantId": 2,
    "relatedUserId": null,
    "createdAt": "2022-07-11T15:13:42.2566667",
    "email": "[email protected]",
    "firstName": "Test",
    "lastName": "Agent",
    "address1": null,
    "address2": null,
    "city": null,
    "state": null,
    "postCode": null,
    "phone": null,
    "name": "Test Agent",
    "displayName": "Test Agent",
    "isAgent": true,
    "organization": "",
    "title": "",
    "alias": "",
    "externalId": null,
    "isDisabled": false
  }
],
    "isAgent": true,
    "organization": "",
    "title": "",
    "alias": "",
    "externalId": null,
    "isDisabled": false
  }
]