SuriInstall

Summary

List contacts from the Suri platform filtered by various criteria like queue, channel, attendant, session type, tags, phones, contact variables, and supports ordering and pagination.

Inputs

• orderBy (required) — Select the field to order the results by: 'Última Atividade' (last activity) or 'Data de Criação' (creation date).
• orderType (required) — Select ordering direction: 'Decrescente (mais recente primeiro)' for descending or 'Crescente' for ascending.
• filterLimit — Set the maximum number of contacts to return in the response (items per page). Defaults to 100.
• continuationToken — Token for paginating results; leave empty for the first page.
• queue — Filter contacts by queue status: Automatic, Waiting for Service, In Service, or no filter.
• filterChannelId — Filter contacts by the channel ID.
• departmentId — Filter contacts by department ID.
• attendantId — Filter contacts by attendant ID.
• sessionType — Filter by session type: Receptive, Active, or no filter.
• filterTags — Comma-separated tag IDs to filter contacts by.
• filterPhones — Comma-separated phone numbers (digits only, with country code) to filter contacts.
• filterVariables — JSON object to filter contacts by their stored variables (key-value pairs).

Output shape

a single JSON object representing the filtered list of contacts, including pagination tokens

The operation returns a JSON with a list of contacts matching the applied filters, ordered and limited as specified. Pagination is controlled via the continuationToken input; supply the token from prior responses to fetch subsequent pages.

Examples

Example 1: Retrieve up to 50 contacts who are in 'Em Atendimento' queue, ordered by 'Data de Criação' ascending

orderBy: 'dateCreated', orderType: 'asc', filterLimit: 50, queue: 2

Links

• n8n community nodes installation guide