Sharetribe icon

Sharetribe

Allows interaction with the Sharetribe Integration API

User → Get Many

AI-generated

Summary

Fetch users with optional filtering, limiting, 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 users
  • limit — Maximum number of results to return
  • simplify — Whether to return a simplified version of the response
  • userFields — Choose fields to return from the list or specify IDs using an expression
  • filterOptions — Add filters for querying users
  • privateData — Add private data filters
  • protectedData — Add protected data filters
  • publicData — Add public data filters
  • sort — Add sort rules for the query

Output shape

a list of user objects (or a count if countOnly is true)

Pagination may be applied; fields can be limited via userFields; optional filters and sorting are supported.

Examples

Example 1: Retrieve the first 10 users with email and state fields

returnAll false, limit 10, userFields ['email','state'], simplify true

Example 2: Count total users matching a filter

countOnly true, filterOptions { createdAtStart: '2023-01-01' }

Example 3: Get all users sorted by createdAt descending

returnAll true, sort [{field:'createdAt',direction:'DESC'}]

Links

Discussion