> ## Documentation Index > Fetch the complete documentation index at: https://docs.heyy.io/llms.txt > Use this file to discover all available pages before exploring further. # Search chats ## OpenAPI ````yaml /api-reference/openapi-v3.json post /chats/search openapi: 3.1.0 info: title: Heyy API version: 3.0.0 servers: - url: https://api.heyy.io/v3 security: - bearerAuth: [] paths: /chats/search: post: summary: Search chats requestBody: required: true content: application/json: schema: type: object properties: query: type: string description: >- Structured filter expression. See [Query syntax](/api-reference/v3/query) for expression functions. Filterable fields: `id`, `createdAt`, `updatedAt`, `handleId`, `contactId`, `status`, `isUnread`, `unreadCount`, `assignedUserId`, `assignedTeamId`, `latestMessage`, `channelId`, `latestMessageTimestamp`, `contactFirstName`, `contactLastName`, `contactIsSubscribed`, `contactLabels`, `contactPhoneNumber`, `contactEmail`, `handleValue`, `isSensitive`. Filter custom contact attributes with `getBy('attributes', 'name', 'your_attribute_name')` or `getBy('attributes', 'id', 'attribute-id')`. sortBy: type: string description: >- Sort expression. See [Sort By syntax](/api-reference/v3/sort-by) for expression functions. Sortable fields: `id`, `createdAt`, `updatedAt`, `handleId`, `contactId`, `status`, `isUnread`, `unreadCount`, `assignedUserId`, `assignedTeamId`, `latestMessage`, `channelId`, `latestMessageTimestamp`, `contactFirstName`, `contactLastName`, `contactIsSubscribed`, `contactLabels`, `contactPhoneNumber`, `contactEmail`, `handleValue`, `isSensitive`. Sort custom contact attributes with `getBy('attributes', 'name', 'your_attribute_name')` or `getBy('attributes', 'id', 'attribute-id')`. search: type: string description: >- Free-text search by contact full name (`firstName` and `lastName` combined with a space), phone number, or email. See [Search](/api-reference/v3/search). pagination: type: object properties: page: type: integer minimum: 0 description: Zero-based page index. Defaults to 0 when omitted. limit: type: integer minimum: 1 maximum: 100 description: Rows per page. Defaults to 10 when omitted. Maximum 100. required: - page - limit additionalProperties: false description: >- Page through results. Defaults to page 0 and limit 10 when omitted. See [Pagination](/api-reference/v3/pagination). additionalProperties: false responses: '200': description: '' content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time status: type: string enum: - open - closed - snoozed isUnread: type: boolean openUntil: type: - string - 'null' unreadCount: type: number channelId: type: string contactId: type: string handleId: type: string latestMessage: type: - object - 'null' properties: id: type: string vendorId: type: - string - 'null' sender: type: string enum: - outbound - inbound - unknown - system type: type: string enum: - text - media - audio - location - contact - auth timestamp: type: string text: type: - string - 'null' required: - id - vendorId - sender - type - timestamp - text assignedUserId: type: - string - 'null' assignedTeamId: type: - string - 'null' isSensitive: type: boolean required: - id - createdAt - updatedAt - status - isUnread - openUntil - unreadCount - channelId - contactId - handleId - latestMessage - assignedUserId - assignedTeamId - isSensitive additionalProperties: false pagination: type: object properties: page: type: integer minimum: 0 limit: type: integer maximum: 1000 total: type: integer minimum: 0 required: - page - limit - total additionalProperties: false query: type: object properties: query: type: string sortBy: type: string search: type: string success: type: boolean enum: - true required: - data - pagination - query - success additionalProperties: false example: success: true data: [] pagination: page: 0 limit: 0 total: 0 query: query: string sortBy: string search: string '400': description: Bad request. The request body or parameters are invalid. content: application/json: schema: type: object properties: success: type: boolean enum: - false error: type: object properties: messageKey: type: string message: type: string invalidParams: type: object additionalProperties: type: object properties: key: type: string message: type: string required: - key - message required: - success additionalProperties: false example: success: false error: messageKey: invalid_body_params message: Invalid body params invalidParams: email: key: invalid_string message: Invalid email '401': description: Unauthorized. A valid API key is required. content: application/json: schema: type: object properties: success: type: boolean enum: - false error: type: object properties: messageKey: type: string message: type: string invalidParams: type: object additionalProperties: type: object properties: key: type: string message: type: string required: - key - message required: - success additionalProperties: false example: success: false error: messageKey: unauthorized message: Unauthorized '402': description: >- Payment required. The current billing plan does not allow this request. content: application/json: schema: type: object properties: success: type: boolean enum: - false error: type: object properties: messageKey: type: string message: type: string invalidParams: type: object additionalProperties: type: object properties: key: type: string message: type: string required: - key - message required: - success additionalProperties: false example: success: false error: messageKey: insufficient_billing_plan message: Insufficient billing plan '403': description: >- Forbidden. The API key does not have permission to perform this action. content: application/json: schema: type: object properties: success: type: boolean enum: - false error: type: object properties: messageKey: type: string message: type: string invalidParams: type: object additionalProperties: type: object properties: key: type: string message: type: string required: - key - message required: - success additionalProperties: false example: success: false error: messageKey: forbidden message: Forbidden '404': description: Not found. The requested resource does not exist. content: application/json: schema: type: object properties: success: type: boolean enum: - false error: type: object properties: messageKey: type: string message: type: string invalidParams: type: object additionalProperties: type: object properties: key: type: string message: type: string required: - key - message required: - success additionalProperties: false example: success: false error: messageKey: contact_not_found message: Contact not found '429': description: >- Too many requests. Retry after the time indicated by the X-RateLimit-Reset header. content: application/json: schema: type: object properties: success: type: boolean enum: - false error: type: object properties: messageKey: type: string message: type: string invalidParams: type: object additionalProperties: type: object properties: key: type: string message: type: string required: - key - message required: - success additionalProperties: false example: success: false error: messageKey: too_many_requests message: >- Too many requests. Limit is applied per minute per tenant. Please retry after the time indicated by the X-RateLimit-Reset header. '500': description: Internal server error. content: application/json: schema: type: object properties: success: type: boolean enum: - false error: type: object properties: messageKey: type: string message: type: string invalidParams: type: object additionalProperties: type: object properties: key: type: string message: type: string required: - key - message required: - success additionalProperties: false example: success: false error: messageKey: internal_error message: Oops! Something went wrong components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````