v1

latestOpenAPI 3.0.02026-07-24378968.5 KB

Contacts

/contacts

Get all contacts or filter using search criteria

get/contacts

Query parameters

propertystring required

Name of the property

operator'eq' | 'ne' | 'lt' | 'gt' | 'le' | 'ge' | 'in' | 'nin' required

Comparison operator

[
  {
    "property": "name",
    "operator": "eq"
  }
]

pagenumber

Number of the page

limitnumber

Limit of items per page. MAX = 100, MIN = 1

propertystring required

Name of the property to sort

direction'asc' | 'desc' required

'asc' or 'desc' to order the result

{
  "property": "name",
  "direction": "asc"
}

Headers

octa-agent-emailstring

Response

idstring

Customer ID

namestring

Customer name

emailstring

Customer email

Example response

[
  {
    "name": "Jane Doe",
    "email": "jane_doe@test.com",
    "phoneContacts": [
      {
        "number": "119999999999",
        "countryCode": "55"
      }
    ]
  }
]