Actions28
- Asset Actions
- Availability Exception Actions
- Event Actions
- Image Actions
- Listing Actions
- Marketplace Actions
- Stock Actions
- Transaction Actions
- User Actions
Listing → Get Many
AI-generatedSummary
Fetch multiple Sharetribe listings with optional filters, pagination, field selection, and sorting.
Inputs
- returnAll — Whether to return all results or only up to the limit.
- countOnly — Whether to return only the count of matching listings.
- limit — Maximum number of results to return (required when not using returnAll).
- simplify — Whether to return a simplified version of the response.
- listingFields — Fields to return for each listing; can be selected from a predefined list or specified via expression.
- authorFields — Fields to return for the listing author; optional when simplify is false and author is included in listingFields.
- filterOptions — Various filters such as availability, category, creation date, keywords, etc.
- bounds — Geographic bounding box filter to restrict results to a specific area.
- category — Category filter to restrict listings by hierarchical category levels.
- createdAtStartTime — Only include listings created on or after this UTC datetime.
- createdAtEndTime — Only include listings created before this UTC datetime.
- keywords — Search keywords for title, description, or public data; results sorted by relevance.
- ids — Comma‑separated list of listing IDs to include (max 100).
- metadata — Filter by metadata fields using condition and value options.
- origin — Coordinates for distance‑based search; results are sorted by distance.
- price — Price filter with types like exact, maximum, minimum, or range.
- states — Listing state filter (draft, published, etc.).
- stock — Stock filter to restrict listings by minimum stock quantity or mode.
- listingType — Filter by listing type (e.g., asset, service).
- sort — Sorting rules defining up to three sort criteria.
Output shape
array of listing resources
The response may be limited by the limit parameter, can be paginated, and optionally returns only a count when countOnly is true. Optional fields are included based on simplify and selected listingFields/authorFields. When origin is used, results are automatically sorted by distance and custom sort options are disabled.
Examples
Example 1: Retrieve the first 20 published listings with minimal fields.
limit=20, simplify=true, states=["published"], listingFields=["title","price"]
Example 2: Count all listings authored by user 12345.
countOnly=true, filterOptions[authorId]=12345
Example 3: Get listings within a bounding box, sorted by relevance.
bounds[Northeast]=37.8,-122.4,bounds[Southwest]=37.7,-122.5,keywords=community