StreamBIMInstall

Summary

Retrieve multiple user groups associated with a specified StreamBIM project with optional filtering, sorting, and pagination controls.

Inputs

• Project Name or ID (required) — Select or specify the StreamBIM project to query groups from, loaded dynamically from your account credentials.
• List Pagination — Choose to fetch a single page of results or iterate through all pages until no more groups are available or a maximum page count is reached.
• Page Size — Defines the number of groups to return per API request (range 1 to 1000).
• Skip — Offset for retrieving a single page of results, specifying how many groups to skip.
• Max Pages — Maximum number of pages to request when fetching all pages, acting as a safety limit.
• Filters — Apply filters to the group list, such as filtering by group name substring.
• Sort — Specify the JSON:API sort string to order the groups by a field, prefix with '-' for descending order.
• Advanced — Use Raw JSON Query Parameters — Enable to bypass the standard filters and send a raw JSON object as query parameters for advanced querying.
• Query Parameters (Raw JSON) — The raw JSON object used as the query parameter when advanced mode is enabled.
• Return All — Choose whether to return all available groups or limit the results to a specified number.
• Limit — Maximum number of groups to return if not returning all.

Output shape

a list of group objects representing user groups in the specified project

The returned data respects pagination settings and filters applied. When 'Return All' is enabled, the node iterates through pages until all groups are fetched or the 'Max Pages' limit is reached. Filters and sorting are applied as query parameters. If advanced raw JSON query parameters mode is enabled, those parameters take precedence over the standard filters.

Examples

Example 1: Fetch a single page of 100 groups filtered to names containing 'admin', sorted by creation date descending, from project 'Project X'.

Set Project Name or ID to 'Project X'; set List Pagination to 'Single Page'; set Page Size to 100; add a filter of 'Name contains' with value 'admin'; set Sort to '-created-at'; set Return All to false with Limit 100.

Example 2: Fetch all groups from project ID '12345' without filters, returning all available groups up to 5000 pages.

Set Project Name or ID to '12345'; set List Pagination to 'All Pages'; set Max Pages to 5000; leave Filters empty; set Return All to true.

Links

• n8n community nodes installation guide