CEcequens

Get Contacts

Get Contacts endpoint to get contacts. When you send a request using this API, the API will return to you a group of contacts.

get/contacts

Request

  • Base URL
    https://apis.cequens.net/console/v2
  • URL
    https://apis.cequens.net/console/v2/contacts
  • Auth
    API key in header Authorization

Query parameters

pageNointeger

current page number that used for pagination purpose.

pageCountinteger

The page size that can be retrieved for each page.

groupIdstring

contacts group Id.

searchStringstring

string to search for

orderBystring

ordering column name

orderDirection'asc' | 'desc'

Direction of ordering 'asc', 'desc', default is'asc

Response

200

Example response

{
  "result": [
    {
      "id": "xxxxxxxxxxxxxxxxxxxxxxxx",
      "accountId": 11111,
      "number": "010xxxxxxxx",
      "createdBy": "xxxxx-xxx-xxx-xxx-xxxxx",
      "createdOn": "2023-04-26T10:33:25.637Z",
      "updatedOn": "2023-05-29T14:40:12.840Z",
      "statusId": 1,
      "groups": [
        {
          "id": "xxxxxxxxxxxxxxxxxxxxxxxx",
          "name": "User",
          "description": "groupDesc_1550195597096",
          "accountId": 11927,
          "version": 1,
          "createdBy": "xxxxx-xxx-xxx-xxx-xxxxx",
          "createdOn": "2019-02-15T03:53:17.380Z",
          "updatedBy": "xxxxx-xxx-xxx-xxx-xxxxx",
          "updatedOn": "2022-11-01T14:44:26.482Z",
          "statusId": 1,
          "contactsCount": 2
        }
      ]
    }
  ]
}

Changes

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