Contacts

Manage individuals and business contacts. No subscription add-on required.

List contacts

GET /v1/contacts

Query parameters

Parameter	Type	Description
`pageSize`	integer	Results per page (default `10`, max `100`)
`pageIndex`	integer	Zero-based page index (default `0`)
`search`	string	Search by name or email
`type`	integer	`1` = Individual, `2` = Business
`sortBy`	string	Field to sort by
`sortOrder`	string	`asc` \| `desc`

Example response

{
  "success": true,
  "data": {
    "data": [
      {
        "cstid": 10,
        "cstname": "Sarah Johnson",
        "cstemail": "sarah@acmecorp.com",
        "cstmobile": "501234567",
        "contact_type": 1,
        "cstcreated_on": "2026-05-15T08:30:00Z"
      }
    ],
    "current_page": 1,
    "total_records": 210,
    "total_pages": 21
  }
}

Get a contact

GET /v1/contacts/{id}

Parameter	Description
`id`	The `cstid` of the contact

Create a contact

POST /v1/contacts
Content-Type: application/json

Request body

Field	Type	Required	Description
`cstname`	string	yes	Contact name (max 100 chars)
`contact_type`	integer	yes	`1` = Individual, `2` = Business
`cstemail`	string	no	Email address
`cstmobile`	string	no	Phone number
`cstmobile_country_id`	integer	no	Country ID for phone ISD prefix
`cstaddress`	string	no	Address (max 255 chars)
`ct_taxnumber`	string	no	Tax registration number (max 50 chars)
`cstnotes`	string	no	Notes (max 2000 chars)
`cstemailnotify`	boolean	no	Email notifications (default `true`)
`cstsmsnotify`	boolean	no	SMS notifications (default `true`)
`cst_whatsapp_notify`	boolean	no	WhatsApp notifications (default `true`)
`contact_parent`	integer	no	Parent `cstid` (for Individual linked to a Business)
`cst_tag_id`	integer[]	no	Array of tag IDs

Example request

{
  "cstname": "Sarah Johnson",
  "contact_type": 1,
  "cstemail": "sarah@acmecorp.com",
  "cstmobile": "501234567",
  "cstmobile_country_id": 101
}

Example response

{
  "success": true,
  "message": "New contact has been created successfully.",
  "data": {
    "cstid": 10,
    "cstname": "Sarah Johnson"
  }
}

Update a contact

PUT /v1/contacts/{id}
Content-Type: application/json

All fields are optional — send only the fields you want to change.

Field	Type	Description
`cstname`	string	Contact name
`cstemail`	string	Email address
`cstmobile`	string	Phone number
`cstmobile_country_id`	integer	Country ID
`cstaddress`	string	Address
`ct_taxnumber`	string	Tax number
`contact_type`	integer	`1` or `2`
`contact_parent`	integer	Parent contact `cstid`
`tag_ids`	integer[]	Replace tags (full array)

Example response

{
  "success": true,
  "message": "Contact updated successfully!"
}

Delete a contact

DELETE /v1/contacts/{id}

Parameter	Description
`id`	The `cstid` of the contact

Example response

{
  "success": true,
  "message": "Contact deleted successfully!"
}