1. Contact
Hatif
  • Rate Limiting
  • Account API
    • Service Login
      POST
  • Channels API
    • Get Channels
      GET
  • Support API
    • Upload Image, Video, or PDF
      POST
    • Upload Audio File
      POST
  • Whatsapp API
    • Send Text
      POST
    • Send Template
      POST
    • Send Image
      POST
    • Send Audio
      POST
    • Send Video
      POST
    • Send File
      POST
    • Send Interactive Buttons
      POST
    • List Templates (Service Account)
      GET
  • Contact
    • Set Property Value on Contact
      PUT
    • Search Contacts
      POST
    • Delete Property Value on Contact
      DELETE
    • Create Contact
      POST
    • Update Contact
      PUT
    • Get Contacts
      GET
    • Get Contact By Id
      GET
    • Create Bulk Contacts vCards
      POST
    • Contacts History
      GET
  • Contact Properties
    • List Contact Properties
      GET
    • Contact Properties Statistics
      POST
    • Create Contact Property
      POST
    • Update Contact Property
      PUT
    • Delete Contact Property
      DELETE
  • Workspace API
    • Get Workspace Users
  • Conversations API
    • Get Conversation Timeline
    • List Conversations
    • Create Conversation
    • Assign Conversation
    • Get Conversation
    • Assign Conversation
  • Tags API
    • Tag a conversation
    • Create Tag
    • Delete Tag
    • Update Tag
    • List Tags
  • Outbound IVR
    • Create Outbound IVR
    • Get Outbound IVR Request
  • Outbound IVR Flows
    • Create Outbound IVR Flow
    • List Outbound IVR Flows
    • Get Outbound IVR Flow
    • Update Outbound IVR Flow
    • Delete Outbound IVR Flow
  • Tasks API
    • Create Task
    • List Tasks
    • Get Task
    • Update Task
    • Delete Task
    • List Task Properties
    • Create Task Property
    • List Task Projects
    • Create Task Project
    • Get Task Project
    • Rename Task Project
    • Delete Task Project
    • List Task Sections
    • Create Task Section
    • List Tasks By Conversation
    • Move Task
    • Schedule Task
    • Assign Task
    • Set Task Due Date
    • Complete Task
    • Reopen Task
    • Set Task Section
    • Move Task Project
    • Rename Task Section
    • Delete Task Section
    • Move Task Section
    • Update Task Property
    • Delete Task Property
    • Set Task Property Value
    • List Task Comments
    • Create Task Comment
    • Edit Task Comment
    • Delete Task Comment
    • Set Task Reminder
  • Teams API
    • Create Team
    • Get Team
    • Update Team
    • Delete Team
    • Add Team Members
    • Update Team Member Conversation Access
    • Remove Team Member
    • List Teams
    • List Team Member Options
    • List Team Assignment Targets
    • Assign Conversation to Team
  • Partner API
    • 2. Register customer
      • 1) Create registration
      • Update registration details
      • Resend mobile code
      • 2) Verify mobile code
      • 3) Send email code
      • 4) Verify email code
      • 5) Complete registration → workspace + workspace key
      • Issue another workspace key
    • 3. Subscribe (plan & balance)
      • Add wallet balance (top-up) → payment link
      • Plans you can sell (find the Builder plan ID)
      • Get wallet balance
      • Create quote (plan) → payment link
      • Get quote status (poll for payment)
    • 4. Phone number
      • Assign number (after payment)
      • Available numbers
      • List the workspace's channels
    • 5. Contract
      • Replaced: use Get activation link
      • Replaced: number status is on the channel
      • Get activation link
    • 6. AI agent (SIP)
      • Connect the number to your AI agent
      • Disconnect your AI agent
    • 7. Calls & events
      • Not available yet: list calls
      • Not available yet: set events webhook
  • Call Webhook
  • WhatsApp Message Webhook
  • Schemas
    • Call Webhook
    • WhatsApp Message Webhook
    • ServiceAccountTemplateDto
    • OutboundIvrOption
    • ConversationDto
    • RegistrationDetails
    • CreateTagDto
    • AbpError
    • ServiceAccountTemplateParameterDto
    • OutboundIvrQuestionStepProps
    • ChannelConversationDto
    • UpdateTagDto
    • TaskPropertyValue
    • CreateRegistration
    • ServiceAccountCreateTaskDto
    • TemplateParameterDto
    • OutboundIvrStep
    • OtpCode
    • TagDto
    • PagedResultOfTagDto
    • TaskActivityPropertySnapshot
    • ConversationTimelineDto
    • ApiCredential
    • ParameterValueDto
    • CreateOutboundIvrRequest
    • TaskActivitySnapshot
    • SaveOutboundIvrFlow
    • ChannelNotFoundError
    • OutboundIvrFlow
    • Quote
    • AiSummaryDto
    • TaskActivityDto
    • ReplyInfoDto
    • OutboundIvrAnswer
    • TaskSummaryDto
    • InternalThreadDto
    • OutboundIvrStatus
    • TaskDto
    • LocationMessageDto
    • OutboundIvrResult
    • PagedResultOfTaskDto
    • AssignationInfoDto
    • TaskPropertyDefinitionDto
    • PagedResultOfConversationDto
    • OutboundIvrAudioType
    • OutboundIvrRequest
    • PagedResultOfConversationTimelineDto
    • TaskProjectDto
    • TaskSectionDto
    • OutboundIvrWebhookPayload
    • PagedResultOfTaskProjectDto
    • PagedResultOfTaskSectionDto
    • UpdateTaskDto
    • MoveTaskDto
    • SetTaskSectionDto
    • SetTaskScheduleDto
    • AssignTaskDto
    • SetTaskDueDateDto
    • NameDto
    • MoveBeforeDto
    • TaskPropertyOptionDto
    • CreateTaskPropertyDto
    • UpdateTaskPropertyDto
    • TaskCommentDto
    • WriteTaskCommentDto
    • PagedResultOfTaskCommentDto
    • SetTaskReminderDto
  1. Contact

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 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 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
Previous
Update Contact
Next
Get Contact By Id
Built with