Search conversations by text
Searches conversations in the active site or authorized All-sites scope by matching message text.
/api/search/conversationsSearches conversations in the active site or authorized All-sites scope by matching message text. You can narrow results by status, assigned operator, and created-at date range. Matching tolerates common typos and also falls back to a case-insensitive content match. Pagination defaults to page 1 with 20 items per page, and the maximum page size is 100.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
search:read- Module
- Automation & API module (
api_access) - Organization and site scope
- Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
- Retry behavior
- Safe read: You can safely retry this read-only request after a transport failure. It does not change resource state.
Query Parameters
Query parameter. Search query.
1 <= length <= 500Query parameter. Scope. Allowed values: all.
Value in
- "all"
Query parameter. Status. Allowed values: open, closed, pending.
Value in
- "open"
- "closed"
- "pending"
Query parameter. Unique identifier of the related operator.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidQuery parameter. ISO 8601 date and time for date_from.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$date-timeQuery parameter. ISO 8601 date and time for date_to.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$date-timeQuery parameter. One-based page number.
1 <= value <= 90071992547409911Query parameter. Maximum number of records to return.
1 <= value <= 10020Header Parameters
DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{ "data": [ { "id": "22222222-2222-4222-8222-222222222222", "orgId": "11111111-1111-4111-8111-111111111111", "projectId": "55555555-5555-4555-8555-555555555555", "projectName": "Storefront", "visitorId": "33333333-3333-4333-8333-333333333333", "assignedOperatorId": "11111111-1111-4111-8111-111111111111", "status": "open", "priority": "normal", "resolvedBy": null, "channel": "widget", "aiActive": false, "snoozedUntil": null, "lastMessageAt": "2026-06-23T11:10:00.000Z", "metadata": {}, "createdAt": "2026-06-23T10:55:00.000Z", "updatedAt": "2026-06-23T11:10:00.000Z" } ], "pagination": { "totalItems": 1, "page": 1, "pageSize": 20, "hasNextPage": false, "hasPrevPage": false }}Request examples
curl
curl --request GET \
'https://api.convor.io/api/search/conversations?q=refund+request' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...'JavaScript
const response = await fetch("https://api.convor.io/api/search/conversations?q=refund+request", {
method: "GET",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_..."
},
});
const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
? null
: contentType.includes("json")
? await response.json()
: contentType.startsWith("text/")
? await response.text()
: await response.blob();
if (!response.ok) {
const message = typeof data === "object" && data !== null
&& "error" in data && typeof data.error === "object"
&& data.error !== null && "message" in data.error
? String(data.error.message)
: "Convor API request failed (" + response.status + ")";
throw new Error(message);
}
console.log(data);Was this page helpful?