Chatlabs icon

Chatlabs

Interaja com a API do Chatlabs

Actions22

Cliente → Listar

AI-generated

Summary

List clients with optional filtering by specific client fields and pagination control.

Inputs

  • Por Página — Number of clients to return per page, between 1 and 100. Defaults to 10.
  • Campo de Pesquisa — Optional client field to filter the list by; can be None, Name, Email, Identification, Phone, or Tags.
  • Valor da Pesquisa — Value to search for in the selected filter field; required only if a filter field other than None is chosen.

Output shape

A JSON object with the list of clients returned from the API.

Supports optional query parameters for filtering clients by a specific field and value. Pagination is controlled via the 'Por Página' parameter. The API request performs an HTTP GET to /api/client with query parameters perPage, field, and value where applicable.

Examples

Example 1: Retrieve 20 clients per page with no filtering.

Set 'Por Página' to 20 and leave 'Campo de Pesquisa' and 'Valor da Pesquisa' empty.

Example 2: Search for clients by email containing 'example.com'.

Set 'Campo de Pesquisa' to 'E-mail' and 'Valor da Pesquisa' to 'example.com', with 'Por Página' set as desired (e.g., 10).

Links

Discussion