Customers

List customer contacts

Returns a list of customer_contacts rows. Pass ?customer_id={id} to scope to a single customer (routes the request through ContactBookService::list() with the parent-row guard); optional ?contact_type=email or ?contact_type=phone filters by type. Without a customer_id filter the generic v2 search-by-attributes behaviour is used (main_attributes[...], additional_attributes[...], order[...], limit, offset per the API intro).

get/admin/customers/customer-contacts

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/customers/customer-contacts
  • Auth: HTTP basic

Query parameters

customer_idinteger
Example:1

Scope to a single customer. When provided, the request goes through the service path with the parent-row guard. Omit to fall back to the generic v2 search-by-attributes.

contact_type'email' | 'phone'
Example:email

Filter by contact type. Only honoured together with customer_id.

Response

idnumber required

Contact row ID.

customer_idnumber required

Owning customer (or lead) ID.

contact_person_idnumber nullable

Optional link to a contact person row.

contact_typestring required

Contact type: email or phone.

contact_valuestring required

Email address or phone number.

labelstring

Contact label.

country_codestring nullable

ISO 3166-1 alpha-2 country code (phone rows only).

is_primarystring

1 for the primary contact in its (customer_id, contact_type, label) tuple, otherwise 0.

is_whatsappstring

1 when the phone is flagged as WhatsApp-enabled, otherwise 0.

metadataobject nullable

Free-form JSON metadata.

created_atstring

Row creation datetime.

updated_atstring

Row last-update datetime.

Example response

[
  {
    "id": 1,
    "customer_id": 1,
    "contact_person_id": 1,
    "contact_type": "email",
    "contact_value": "alpha@example.com",
    "label": "primary",
    "country_code": null,
    "is_primary": "1",
    "is_whatsapp": "0",
    "metadata": null,
    "created_at": "2026-05-21 10:00:00",
    "updated_at": "2026-05-21 10:00:00"
  }
]

Changes

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