PipeRun API icon

PipeRun API

Interact with the PipeRun CRM API.

Actions220

Users → Listar Usuarios

AI-generated

Summary

Lists PipeRun CRM users with optional filtering and pagination.

Inputs

  • userslistarUsuariosAdditionalFields (required) — Collection of filters to apply to the user list query. Options include pagination (show, cursor), filters (email, account_id, name, permission, active), and date ranges (created_at_start, created_at_end, updated_at_start, updated_at_end).
  • userslistarUsuariosAdditionalFields.customQueryParameters — Adds custom query parameters to the request URL (key-value pairs).
  • userslistarUsuariosAdditionalFields.customQueryJson — Merges a JSON object of query parameters into the request URL.
  • requestOptions — Settings for request handling, including batching, proxy, timeout, and SSL verification.

Output shape

A list of items, each representing a user record with standard PipeRun fields.

The default page size is 200 items. Results can be paginated using the 'cursor' field from a previous response to fetch subsequent pages.

Examples

Example 1: Fetch the first page of all users with the default settings.

Leave 'userslistarUsuariosAdditionalFields' empty; the node uses default pagination (show: 200) and no filters.

Example 2: Filter users by email and fetch the next page using a cursor.

Set 'email' in 'userslistarUsuariosAdditionalFields' and provide the 'cursor' from the previous node's output.

Example 3: Throttle requests by splitting a large input into batches of 50 items with a 1-second delay.

Configure 'requestOptions.batching.batchSize' to 50 and 'requestOptions.batching.batchInterval' to 1000.

Links

Discussion