ACacculynx
contacts

Get Phone Number

Use this endpoint to get the phone number for a specific phoneId associated with a specific contact.

get/contacts/{contactId}/phone-numbers/{phoneId}

Request

  • Base URL
    https://api.acculynx.com/api/v2
  • URL
    https://api.acculynx.com/api/v2/contacts/{contactId}/phone-numbers/{phoneId}
  • Auth
    HTTP bearer

Path parameters

contactIdstring uuid required

The contact's unique identifier

phoneIdstring uuid required

The unique id of a phone number

Response

OK

idstring uuid

The GUID of the Phone Number.

_linkstring

The URI of the Phone Number.

numberstring

10 digit phone number.

extstring
type'Home' | 'Mobile' | 'Work'
primaryboolean

Is this phone number the primary phone number for the related entity?

smsOptOutboolean nullable

This value specifies if SMS messaging is active for this contact number.

Example response

{
  "id": "b2830ef6-c5ff-44ca-a3b9-aa767f50a04b",
  "_link": "https://api.acculynx.com/api/v2/contacts/7f008cca-9789-44c3-afdf-7ec2e005c267/phone-numbers/b2830ef6-c5ff-44ca-a3b9-aa767f50a04b",
  "type": "Home"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.