Gerador de Matrículas icon

Gerador de Matrículas

Interaja com a API do Gerador de Matrículas CRM

Contato → Listar

AI-generated

Summary

List contacts from the Gerador de Matrículas CRM using optional filters to narrow results.

Inputs

  • authentication (required) — Select the authentication method: API Token or OAuth2.
  • page — Page number for paginated results (default is 1).
  • limit — Number of contacts per page, maximum 100 (default is 50).
  • filters — Optional filters object with any combination of: busca (q, string), email (string), and telefone (phone, string) to filter the contacts list.

Output shape

a list of contact records, each as a JSON object; pagination details are included in the _pagination property inside each contact object.

Supports pagination via 'page' and 'limit'. Filter parameters are applied as query strings if provided and non-empty. Returns an array of contacts in the response data. If API errors occur and 'Continue on Fail' is enabled, errors appear in output items; otherwise, execution stops with an error.

Examples

Example 1: Retrieve the first page of contacts with up to 50 records, optionally filtering by search term, email, or phone.

Set authentication to 'Token de API' or 'OAuth2', specify page number and limit, set filter values as needed.

Links

Discussion