---
title: "Search Texts"
method: GET
path: "/api/v1/phone/numbers/{phone_number_id}/texts/search"
tags: ["Text Messages"]
---

# Search Texts

`GET /api/v1/phone/numbers/{phone_number_id}/texts/search`

## Request

- Base URL: `https://api.inkbox.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.inkbox.ai/api/v1/phone/numbers/{phone_number_id}/texts/search`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

## Path parameters

- `phone_number_id` string, uuid, required

## Query parameters

- `q` string, required
- `limit` integer
- `is_blocked` boolean, nullable

## Response `200`

Successful Response

- TextMessageResponse[]
  - `id` string, uuid, required
  - `direction` 'inbound' | 'outbound', required
  - `local_phone_number` string, required
  - `remote_phone_number` string, nullable
  - `text` string, nullable, required
  - `type` 'sms' | 'mms', required
  - `media` TextMediaItem[], nullable, required
    - `content_type` string, required
    - `size` integer, required
    - `url` string, required
  - `is_read` boolean, required
  - `delivery_status` 'queued' | 'sent' | 'delivered' | 'delivery_failed' | 'delivery_unconfirmed' | 'sending_failed' | 'blocked_spam_filter'
  - `origin` 'user_initiated' | 'auto_reply'
  - `error_code` string, nullable
  - `error_detail` string, nullable
  - `sent_at` string, date-time, nullable
  - `delivered_at` string, date-time, nullable
  - `failed_at` string, date-time, nullable
  - `conversation_id` string, uuid, nullable
  - `sender_phone_number` string, nullable
  - `recipients` RecipientResponse[], nullable
    - `recipient_phone_number` string, required
    - `delivery_status` 'queued' | 'sent' | 'delivered' | 'delivery_failed' | 'delivery_unconfirmed' | 'sending_failed' | 'blocked_spam_filter'
    - `carrier` string, nullable
    - `line_type` string, nullable
    - `error_code` string, nullable
    - `error_detail` string, nullable
    - `sent_at` string, date-time, nullable
    - `delivered_at` string, date-time, nullable
    - `failed_at` string, date-time, nullable
  - `is_blocked` boolean
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required

## Other responses

- `422`: Validation Error
- `4XX`: Client error with Support Agent information.
- `5XX`: Server error with Support Agent information.

---

[API](https://skmtc.dev/inkbox/apis/inkbox-api.md) - [All operations](https://skmtc.dev/inkbox/apis/inkbox-api/llms.txt) - [OpenAPI document](https://skmtc.dev/inkbox/apis/inkbox-api/revisions/3e862146bf53?raw)
