Ricky logorickyDocs

Search conversations

GET
/conversations/search

Conversations whose contact or messages contain the text, latest activity first. Answers one page of at most limit; next_cursor is always null.

Scope: conversations:read.

Authorization

bearerAuth
headerAuthorizationBearer <token>

An organization API key, rky_live_…, created in Settings → API. Send it only from a server.

Query Parameters

query*string

Text in the contact's name, phone, email or company, its name or handle on the channel, or the conversation's messages.

Length1 <= length <= 200
limit?integer

Most results to return.

Range1 <= value <= 50
Default10

Response Body

Success.

application/json
  1. response
data*array<>
next_cursor*|

Pass as cursor for the next page; null on the last page.

curl -X GET 'https://getricky.ai/api/v1/conversations/search?query=string'
{  "data": [    {      "id": "9b2e4c61-7a3f-4d18-b5c2-6e0f1a2b3c4d",      "channel": {        "id": "8f3c2a5e-6b1d-4c7a-9e2f-1a2b3c4d5e6f",        "type": "whatsapp"      },      "contact": {        "id": "3f6c2b1e-8d4a-4b7e-9a51-2c7d8e9f0a1b",        "display_name": "Ana Pérez",        "external_id": "50760001234",        "username": null      },      "status": "open",      "close_category": "resolved",      "assigned_user_id": "2d4f6a8c-1b3d-4e5f-8a7b-9c0d1e2f3a4b",      "agent_id": "7e8f9a0b-1c2d-4e3f-a4b5-c6d7e8f9a0b1",      "created_at": "2026-10-14T15:30:00.000Z",      "opened_at": "2026-10-14T15:30:00.000Z",      "closed_at": "2026-10-14T15:30:00.000Z",      "last_activity_at": "2026-10-14T15:30:00.000Z",      "last_activity_preview": "¿Ya están mis lentes?",      "unread": true,      "active_handoff": {        "id": "2e3f4a5b-6c7d-4e8f-9a0b-1c2d3e4f5a6b",        "status": "requested",        "requested_by": "agent",        "reason": "customer_requested",        "summary": "La clienta pide hablar con alguien sobre un reembolso.",        "assigned_user_id": "2d4f6a8c-1b3d-4e5f-8a7b-9c0d1e2f3a4b",        "requested_at": "2026-10-14T15:30:00.000Z"      }    }  ],  "next_cursor": "string"}