PipeRun API icon

PipeRun API

Interact with the PipeRun CRM API.

Actions220

Regions → Listar Regioes

AI-generated

Summary

Lists PipeRun regions and returns the API response. Optionally filter results, control pagination, or add custom query parameters; request options can tune batching, proxy, timeout, and SSL certificate handling.

Inputs

  • Show — Number of items to request per result page.
  • Cursor — Cursor hash for the next page.
  • Region Id — Filter by region ID.
  • Name — Filter by region name.
  • Cep To — Filter by the region's starting CEP.
  • Cep From — Filter by the region's ending CEP.
  • Balance — Filter by opportunity balance for the region.
  • Created At Start — Filter for regions created from this date and time.
  • Created At End — Filter for regions created up to this date and time.
  • Updated At Start — Filter for regions updated from this date and time.
  • Updated At End — Filter for regions updated up to this date and time.
  • Custom Query Parameters — Add query parameters as key/value pairs.
  • Custom Query (JSON) — Provide a JSON object of query parameters to merge into the request URL.
  • Request Options — Configure request batching, proxy, timeout, and whether to accept responses with invalid SSL certificates.

Output shape

A single API response containing the matching regions.

The source delegates the GET request and response shaping to the generated OpenAPI operation; it does not define pagination or a more specific response envelope here. Credential token is sent in the request header.

Links

Discussion