Search messages within a conversation
Searches messages inside one conversation in the active site or authorized All-sites scope.
/api/search/messagesSearches messages inside one conversation in the active site or authorized All-sites scope. The conversation must belong to the current organization and selected site scope before messages are searched. Results are ordered by text relevance and then by the newest matching message. Pagination defaults to page 1 with 50 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. Unique identifier of the related conversation.
^([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. One-based page number.
1 <= value <= 90071992547409911Query parameter. Maximum number of records to return.
1 <= value <= 10050Header 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": "55555555-5555-4555-8555-555555555555", "orgId": "11111111-1111-4111-8111-111111111111", "projectId": "66666666-6666-4666-8666-666666666666", "projectName": "Storefront", "conversationId": "22222222-2222-4222-8222-222222222222", "senderType": "visitor", "senderId": "33333333-3333-4333-8333-333333333333", "content": "I need help with a refund request.", "contentLocale": "en", "type": "text", "metadata": {}, "isRead": true, "isEdited": false, "editedAt": null, "createdAt": "2026-06-23T11:00:00.000Z", "deletedAt": null, "replyToId": null, "mentions": [] } ], "pagination": { "totalItems": 1, "page": 1, "pageSize": 50, "hasNextPage": false, "hasPrevPage": false }}Request examples
curl
curl --request GET \
'https://api.convor.io/api/search/messages?q=refund+request&conversation_id=22222222-2222-4222-8222-222222222222' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...'JavaScript
const response = await fetch("https://api.convor.io/api/search/messages?q=refund+request&conversation_id=22222222-2222-4222-8222-222222222222", {
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?