---
title: "Search contacts"
method: GET
path: "/contacts"
tags: ["contacts"]
---

# Search contacts

`GET /contacts`

## Request

- Base URL: `https://api.voixcall.com/v1`
- URL: `https://api.voixcall.com/v1/contacts`
- Auth: one of:
  - OAuth 2 (authorization code, authorization URL `https://api.voixcall.com/oauth/authorize`, token URL `https://api.voixcall.com/oauth/token`, scopes: `contacts:read`)
  - HTTP bearer

Contacts on the personal account matching q, newest first. Test keys get an empty list. Requires contacts:read.

## Query parameters

- `limit` string: Page size, 1 to 100. Default 10.
- `starting_after` string: Return objects after this id (older).
- `ending_before` string: Return objects before this id (newer).
- `q` string, required: 2 to 64 characters. Matches name, company and number fragments; a query that is itself a number (spaces, dashes and brackets ignored) matches the digits of stored numbers.

## Response `200`

OK

- ListContact
  - `data` Contact[], nullable, required
    - `company` string, nullable, required
    - `created_at` string, date-time, required
    - `id` string, required
    - `livemode` boolean, required
    - `name` string, required
    - `object` 'contact', required: Always "contact".
    - `phone_number` string, required: As stored; usually E.164.
  - `has_more` boolean, required: Whether more objects exist beyond this page in the direction of travel.
  - `object` 'list', required: Always "list".

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Requests
- `500`: Internal Server Error

---

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