StreamBIM icon

StreamBIM

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

User → Get Many Project Users

AI-generated

Summary

Retrieve multiple users associated with a specified StreamBIM project, optionally filtered by project groups or user attributes, with support for pagination and sorting.

Inputs

  • Project Name or ID (required) — Select the project from your StreamBIM account to list its users, either by choosing from the loaded options or specifying an ID or name via an expression.
  • List Pagination — Choose 'Single Page' for a single paginated request or 'All Pages' to automatically fetch all pages up to a maximum limit.
  • Page Size — Number of user records to fetch per request (up to 1000).
  • Skip — Number of records to skip for single page pagination.
  • Max Pages — Maximum number of pages to fetch when retrieving all pages to prevent excessive looping.
  • Filter Users by Group Names or IDs — Filter users by membership in specified project groups, selectable or via expression; if left empty, all project users are returned.
  • Filters — Typed filters to narrow user results by user email substring or name substring.
  • Sort — Define sorting order by user fields using JSON:API syntax (e.g., 'name' ascending or '-created-at' descending).
  • Advanced — Use Raw JSON Query Parameters — Toggle to bypass standard filters and provide a raw JSON object as query parameters for advanced filtering.
  • Query Parameters (Raw JSON) — A raw JSON object defining query parameters sent directly to the API when the advanced toggle is enabled.
  • Return All — Whether to return all matching users or up to a specified limit.
  • Limit — Maximum number of users to return when return all is disabled.

Output shape

a list of user records associated with the specified project

Supports pagination via single page or all pages modes with safety caps; filtering is applied through query parameters based on groups, typed filters, or raw JSON input. Returned data includes user objects as provided by the StreamBIM API.

Links

Discussion