Search Contacts [Complex]

POST

/v1/contacts/search

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.voxa.sa/v1/contacts/search' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "skipCount": 0,
    "maxResultCount": 10,
    "customPropertyFilters": [
      {
        "propertyDefinitionId": "3a1d7c79-903d-73b4-c400-1fe5df9828e5",
        "operator": 1,
        "value": "Lead"
      }
    ]
  }'

Response Example

{
    "totalCount": 0,
    "items": [
        {
            "workspaceId": "string",
            "name": "string",
            "phoneNumber": "string",
            "contactType": 0,
            "email": "string",
            "company": "string",
            "position": "string",
            "customFields": {
                "ww": null
            },
            "notes": [
                {
                    "contactId": "string",
                    "text": "string",
                    "creatorName": "string",
                    "lastModificationTime": null,
                    "lastModifierId": null,
                    "creationTime": "string",
                    "creatorId": "string",
                    "id": "string"
                }
            ],
            "customProperties": [
                {
                    "propertyDefinitionId": "string",
                    "propertyName": "string",
                    "propertyType": 0,
                    "textValue": null,
                    "numberValue": null,
                    "dateValue": null,
                    "selectValue": "string"
                }
            ],
            "lastModificationTime": "string",
            "lastModifierId": "string",
            "creationTime": "string",
            "creatorId": "string",
            "id": "string"
        }
    ]
}

Modified at 2026-02-11 22:55:55

Set Property Value on Contact

Delete Property Value on Contact