StreamBIM icon

StreamBIM

StreamBIM API: projects, IFC files, IFC search, converter jobs, sync, users, workflows, topics, checklists, attachments, documents

User → Get Many Users (Global)

AI-generated

Summary

Retrieve multiple users globally from the StreamBIM platform with support for pagination, filtering, and sorting.

Inputs

  • List Pagination (required) — Choose between fetching a single page or all pages of user results; single page uses 'Page Size' and 'Skip', while all pages fetch repeatedly up to 'Max Pages' until fewer results than the page size are returned.
  • Page Size (required) — Number of user rows to fetch per request (page size), between 1 and 1000.
  • Skip — Number of user rows to skip for single page pagination (offset).
  • Max Pages — Maximum number of pages to fetch when using all pages pagination (safety cap).
  • Filters — Typed filters to filter users by email or name substring. Can be combined; mapped to query parameters.
  • Sort — JSON:API sorting string to sort results by a field (e.g., 'name') with optional descending order by prefixing with '-'.
  • Advanced — Use Raw JSON Query Parameters — Toggle to bypass typed filters and send raw JSON object as query parameters instead.
  • Query Parameters (Raw JSON) — Raw JSON object sent as query string when the advanced raw query toggle is enabled.
  • Return All — If true, return all matching users ignoring the 'Limit' property.
  • Limit — Maximum number of user results to return when 'Return All' is false.

Output shape

A list of user records matching the specified filters, pagination, and sorting criteria.

When 'List Pagination' is set to 'all', multiple requests are made until fewer results than the page size are returned or the 'Max Pages' limit is reached, aggregating all user data. If raw JSON query parameters are used, typed filters are ignored. Result count may be limited by 'Return All' and 'Limit' settings.

Links

Discussion