---
title: "Search contacts (iCloud Contacts)"
method: POST
path: "/v1/icloud_contacts/search"
tags: ["read"]
---

# Search contacts (iCloud Contacts)

`POST /v1/icloud_contacts/search`

## Request

- Base URL: `https://muse.space`
- URL: `https://muse.space/v1/icloud_contacts/search`
- Auth: HTTP bearer

Search contacts by part of a name, email address, phone number or organization, and return each match’s addresses and numbers.

## Request body

- ContactsSearchInput
  - `query` string, required: Part of a name, email address, phone number or organization, ignoring case.
  - `address_book_id` string: Only this address book, by id from list_address_books; omit for all.
  - `limit` integer: How many contacts to return.

## Response `200`

The result.

- ContactsSearchOutput
  - `contacts` object[], required
    - `id` string, required
    - `address_book_id` string, required
    - `name` string, required
    - `emails` string[], required
    - `phones` string[], required
    - `organization` string
  - `truncated` boolean, required

## Other responses

- `401`: `unauthorized`, `token_revoked`, `token_expired`
- `403`: `forbidden`, `recipient_not_allowed`
- `404`: `not_found`
- `409`: `reconnect_required`, `changed_since_read`
- `413`: `too_large`
- `422`: `invalid_arguments`, `unreadable`
- `429`: `rate_limited`, `send_cap_reached`, `send_cooldown`
- `500`: `internal`
- `502`: `upstream_unavailable`, `upstream_rejected`, `delivery_unconfirmed`

---

[API](https://skmtc.dev/muse/apis/muse-space-tool-catalogue.md) · [All operations](https://skmtc.dev/muse/apis/muse-space-tool-catalogue/llms.txt) · [OpenAPI document](https://skmtc.dev/muse/apis/muse-space-tool-catalogue/revisions/8bef59003b3c?raw)