Sharetribe icon

Sharetribe

Allows interaction with the Sharetribe Integration API

Transaction → Get Many

AI-generated

Summary

Fetch multiple transactions with optional filtering, pagination, and field selection.

Inputs

  • returnAll — Whether to return all results or only up to a given limit.
  • countOnly — Whether to return only the count of matching transactions.
  • limit — Maximum number of results to return when not using returnAll.
  • simplify — Whether to return a simplified version of the response.
  • transactionFields — Select which top‑level transaction fields to include in the response.
  • listingFields — Select which listing author fields to include when listing data is requested.
  • userFields — Select which customer or provider fields to include.
  • filterOptions — Various filters such as booking start time, creation dates, customer ID, etc.
  • protectedData — Filters for protected data fields.
  • processNames — Filter by transaction process name.
  • providerId — Filter by provider user ID.
  • states — Filter by transaction state.
  • sort — Sorting rules for the results.

Output shape

A list of transaction objects (or a count if countOnly is true).

When countOnly is true the response body contains only a count; otherwise it contains the selected transaction records. Fields can be limited via transactionFields, listingFields, and userFields; pagination is controlled by limit and returnAll.

Examples

Example 1: Retrieve the 5 most recent transactions with booking and customer details.

limit=5, simplify=true, transactionFields=booking,createdAt,customer

Example 2: Count all matching transactions without returning records.

countOnly=true, simplify=true

Example 3: Fetch all transactions with full detail set.

returnAll=true, simplify=false

Links

Discussion