Retrieves messages from multiple conversations (org-scoped batch)

get

https://messaging.api.eu1.scalar.zf.com/v1/conversations/messages

Retrieves messages from multiple conversations with optional filtering by conversation IDs, time range, and chat type. Org-scoped endpoint supporting up to 100 conversations per request. Supports cursor-based pagination for efficient message retrieval.

📘
The rate limit for this API is normal.

Query Params

conversationIds

string

Comma-separated list of conversation IDs to fetch (max 100). If not provided, retrieves from all conversations.

from

date-time

Start of time range (inclusive) in ISO 8601 UTC format (based on message registered time on the server).

until

date-time

End of time range (exclusive) in ISO 8601 UTC format (based on message registered time on the server).

conversationType

string

enum

Defaults to chat

Filter by conversation type. Supported values are 'chat' (direct chats) and 'groupchat'. Defaults to 'chat' if not provided.

Allowed:

limit

integer

1 to 250

Defaults to 100

Number of records to return per page.

after

string

^[A-Za-z0-9_-]+$

Base64 URL-encoded cursor for forward polling (loading newer messages). Opaque string returned from previous response in metadata.pagination.nextCursor. Cannot be decoded by clients.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Messages retrieved successfully, grouped by conversation.

400Failure code. The request was unacceptable.

401Failure code. Unauthorized access.

403Forbidden

429Too many incoming requests.

500Failure code. Indicates an internal server error (unhandled exception).