Sign in
Contact

List

Retrieve a paginated list of Contact records. Supports filtering, sorting, and search.

get/api/cp/contact

Query parameters

contact_type'General' | 'Sales' | 'Accounts' | 'NOC' | 'Rates'

Filter by Contact Type

Response

Successful response

idinteger

Id

company_idinteger

Company Id (references company.id)

namestring

Name

emailstring email

Email

contact_type'General' | 'Sales' | 'Accounts' | 'NOC' | 'Rates'

Contact Type

phonestring

Phone

mobilestring

Mobile

skypestring

Skype

public_notesstring

Public Notes

private_notesstring

Private Notes

loginsinteger

Logins

last_loginstring date-time nullable

Last Login

portal_areastring

Portal Area

mobile_verifyinteger

Mobile Verify

email_verifyinteger

Email Verify

ip_whiteliststring

Ip Whitelist

Example response

[
  {
    "id": 12345,
    "company_id": 1,
    "name": "Example Name",
    "email": "user@example.com",
    "contact_type": "General",
    "phone": "+1-555-123-4567",
    "mobile": "+1-555-123-4567",
    "skype": "example_skype",
    "public_notes": "Sample public_notes text content",
    "private_notes": "Sample private_notes text content",
    "logins": 123,
    "last_login": "2025-01-17T10:30:00Z",
    "portal_area": "example_portal_area",
    "mobile_verify": 1,
    "email_verify": 1,
    "ip_whitelist": "example_ip_whitelist"
  }
]

Changes