---
title: "Search Contacts"
method: GET
path: "/v1/workspaces/{workspace_id}/contacts/search"
tags: ["Contacts"]
---

# Search Contacts

`GET /v1/workspaces/{workspace_id}/contacts/search`

## Request

- Base URL: `https://api.oxvo.com`
- URL: `https://api.oxvo.com/v1/workspaces/{workspace_id}/contacts/search`
- Auth: API key in header `api_access_token`

Search the resolved contacts using a search key, currently supports email search (Page size = 15). Resolved contacts are the ones with a value for identifier, email or phone number

## Path parameters

- `workspace_id` integer, required

## Query parameters

- `q` string
- `sort` 'name' | 'email' | 'phone_number' | 'last_activity_at' | '-name' | '-email' | '-phone_number' | '-last_activity_at'
- `page` integer

## Response `200`

Success

- ContactsListResponse
  - `meta` ContactMeta
    - `count` integer: Total number of contacts
    - `current_page` union: Current page number
      - string
      - integer
  - `payload` ContactListItem[]: List of contacts
    - `additional_attributes` object: The object containing additional attributes related to the contact
      - `city` string: City of the contact
      - `country` string: Country of the contact
      - `country_code` string, nullable: Country code of the contact
      - `created_at_ip` string: IP address when the contact was created
    - `availability_status` 'online' | 'offline': Availability status of the contact
    - `email` string, nullable: The email address of the contact
    - `id` integer: The ID of the contact
    - `name` string: The name of the contact
    - `phone_number` string, nullable: The phone number of the contact
    - `blocked` boolean: Whether the contact is blocked
    - `identifier` string, nullable: The identifier of the contact
    - `thumbnail` string: The thumbnail of the contact
    - `custom_attributes` object: The custom attributes of the contact
    - `last_activity_at` integer, nullable: Timestamp of last activity
    - `created_at` integer: Timestamp when contact was created
    - `contact_inboxes` ContactInbox[]: List of inboxes associated with this contact
      - `source_id` string: Source identifier for the contact inbox
      - `inbox` object
        - `id` integer: ID of the inbox
        - `avatar_url` string: URL for the inbox avatar
        - `channel_id` integer: ID of the channel
        - `name` string: Name of the inbox
        - `channel_type` string: Type of channel
        - `provider` string, nullable: Provider of the inbox

## Other responses

- `401`: Authentication error

---

[API](https://skmtc.dev/oxvo/apis/oxvo-apis.md) · [All operations](https://skmtc.dev/oxvo/apis/oxvo-apis/llms.txt) · [OpenAPI document](https://skmtc.dev/oxvo/apis/oxvo-apis/revisions/9a8448cbd1fe?raw)