StreamBIM icon

StreamBIM

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

Workflow → Get Many

AI-generated

Summary

Retrieve multiple workflows from a specified StreamBIM project, supporting both single-page and multi-page pagination with customizable filters and query parameters.

Inputs

  • Project Name or ID (required) — Select or specify the StreamBIM project to fetch workflows from, resolved based on the credential's region.
  • List Pagination (required) — Choose between fetching a single page or all pages of results.
  • Page Size — Number of workflow records per API request (for pagination).
  • Skip — Offset to skip records in a single page request.
  • Max Pages — Maximum number of pages to retrieve in multi-page mode; acts as a safety cap.
  • Advanced — Use Raw JSON Query — Enable to bypass UI filters and provide raw JSON query parameters for more precise control.
  • Filters — Filter workflows by accessibility, creatability, system inclusion, and workflow type when not using raw JSON query.
  • Query Parameters — Raw JSON-formatted query parameters applied to the request when raw query mode is enabled.
  • Return All — Return all workflows matching the criteria, overriding the limit.
  • Limit — Maximum number of workflows to return when not returning all.

Output shape

a list of workflow records matching the specified criteria and pagination settings

Pagination behavior depends on the selected pagination mode: in single page mode, results are limited and offset by 'Page Size' and 'Skip'; in all pages mode, multiple requests are issued up to 'Max Pages' or until fewer than a full page of results is returned. Filters apply either via UI controls or raw JSON query parameters but not both simultaneously. Returned workflows reflect StreamBIM API responses with fields per the standard workflow resource schema.

Examples

Example 1: Fetch up to 100 workflows from project 'Acme Project', including only those accessible and suitable for topic creation

Project Name or ID set to 'Acme Project', List Pagination set to 'Single Page', Page Size to 100, Filters with Accessible true, For Creation true, Include System false, Workflow Type 'Workflow' (default UI filters).

Example 2: Retrieve all available workflows across multiple pages from a project using custom raw JSON query

Project Name or ID specified, List Pagination set to 'All Pages', Raw JSON Query enabled with customized filter parameters, Return All enabled for complete retrieval.

Links

Discussion