Get Contacts

GET

/v1/contacts

Lists/filters contacts in the calling workspace via query-string parameters. difference is how filters are passed (query string here vs. JSON body there).

This endpoint also accepts additional query parameters beyond SkipCount/MaxResultCount. See the Query Params list below for the full set.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

Responses

🟢200OK

application/json

Paged list of contacts matching the given filters, wrapped under an id key (see the warning above).

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.voxa.sa/v1/contacts?SkipCount=0&MaxResultCount=10&name=undefined&phoneNumber=undefined&customPropertyFilters=undefined&conversationAssigneeIds=undefined&includeUnassignedConversations=undefined&sorting=undefined' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "id": {
        "totalCount": 19961,
        "items": [
            {
                "workspaceId": "d307b8...............",
                "name": " \\شركة هاتف",
                "phoneNumber": "+966501234567",
                "contactType": 1,
                "email": "Noshy@hatif.io",
                "company": null,
                "position": null,
                "customFields": {},
                "notes": [],
                "customProperties": [
                    {
                        "propertyDefinitionId": "3a1f72...............",
                        "propertyName": "ارسلنا له رساله",
                        "propertyType": 3,
                        "textValue": null,
                        "numberValue": null,
                        "dateValue": null,
                        "selectValue": "نعم"
                    },
                    {
                        "propertyDefinitionId": "3a1dbe...............",
                        "propertyName": "مرحلة العميل",
                        "propertyType": 3,
                        "textValue": null,
                        "numberValue": null,
                        "dateValue": null,
                        "selectValue": "اعادة التواصل"
                    }
                ],
                "lastModificationTime": "2026-06-18T14:18:30.610858",
                "lastModifierId": "3a1c45...............",
                "creationTime": "2026-06-15T10:31:19.459646",
                "creatorId": null,
                "id": "3a21dd..............."
            }
        ]
    }
}

Modified at 2026-06-19 16:08:27

Update Contact

Get Contact By Id