Fanvue APIInstall

Summary

Lists chats from the Fanvue platform with pagination, filtering, and sort order.

Inputs

• X-Fanvue-API-Version (required) — API version to use for the request, supplied as the X-Fanvue-API-Version header.
• page — Page number to retrieve (starts from 1). Sent as a query parameter.
• size — Number of items to return per page (1-50, default: 15). Sent as a query parameter.
• customListId — Filter chats by custom list UUID. Sent as a query parameter.
• smartListIds — Filter chats by smart list type(s). Sent as a query parameter.
• filter — Filter types to apply (can specify multiple via repeated params). Sent as a query parameter.
• search — Search term to filter chats by user name/handle. Sent as a query parameter.
• sortBy — Sort order for chat list. Options: most_recent_messages (default), online_now, most_unanswered_chats. Sent as a query parameter.
• allowUnauthorizedCerts — Whether to accept the response even if SSL certificate validation is not possible.
• proxy — HTTP proxy to use. If authentication is required, format as http://username:password@myproxy:3128.
• timeout — Time in ms to wait for the server to send response headers before aborting the request.
• requestOptions — Batching and other request configuration. Contains batching options: batchSize (number, default 50, -1 to disable) and batchInterval (ms, default 1000, 0 to disable).

Output shape

An array of chat objects representing the requested chats, each containing metadata such as ID, user info, message timestamps, and status.

All query parameters are optional except X-Fanvue-API-Version. The operation consumes only query parameters and headers; no input data is required from the workflow.

Links

• n8n community nodes installation guide