---
title: "Find saved contacts by name, alias, phone or note"
method: GET
path: "/v1/contacts"
tags: ["Public API"]
---

# Find saved contacts by name, alias, phone or note

`GET /v1/contacts`

## Request

- Base URL: `https://otprun.com`
- URL: `https://otprun.com/v1/contacts`
- Auth: HTTP bearer

## Query parameters

- `search` string: Part of a name, alias, phone or note
- `limit` integer

## Response `200`

OK

- ListOutputBody4
  - `items` ContactBody[], nullable, required
    - `aliases` string[], nullable, required: Other names the contact goes by, such as wife or mom
    - `id` integer, required
    - `name` string, required
    - `note` string, required
    - `on_whatsapp` boolean, nullable, required: null until the number was checked
    - `phone` string, required
    - `saved_at` string, date-time, required
    - `source` 'manual' | 'api' | 'whatsapp' | 'vcard' | 'csv', required
    - `updated_at` string, date-time, required

## Other responses

- `404`: Not Found
- `422`: Unprocessable Entity
- `500`: Internal Server Error

---

[API](https://skmtc.dev/otprun/apis/otp-run-api.md) · [All operations](https://skmtc.dev/otprun/apis/otp-run-api/llms.txt) · [OpenAPI document](https://skmtc.dev/otprun/apis/otp-run-api/revisions/43d40d5f4050?raw)