StreamBIM icon

StreamBIM

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

Topic → Get Many

AI-generated

Summary

Retrieve multiple topics from a specified StreamBIM project with optional filtering, sorting, and pagination controls.

Inputs

  • Project Name or ID (required) — Select or specify the StreamBIM project from which to retrieve topics using the project dropdown (loaded via the credential region) or by an expression with the project ID.
  • Use Raw JSON Query — Enable to bypass the UI filters builder and provide a raw JSON query object with custom filtering parameters for advanced use cases.
  • Filters — Configure filtering criteria for topics using UI fields including topic channel (any, public, workflows), workflow association, status, building, assigned user, labels as comma-separated IDs, deletion status, and sorting order using JSON:API sort strings.
  • Query Parameters (Raw) — When raw query mode is enabled, input raw JSON query parameters controlling filtering and pagination; pagination parameters in this JSON are ignored in favor of 'Return All' and 'Limit' options.
  • Return All — Choose whether to return all matching topics or limit the results.
  • Limit — Set the maximum number of topics to return if not returning all; valid range is 1 to 1000.

Output shape

a list of topic objects

Supports pagination controlled by 'Return All' and 'Limit' inputs. Filtering supports either the UI-based filter fields or direct raw JSON query input depending on the 'Use Raw JSON Query' toggle. Returned data conforms to StreamBIM's JSON:API topic representation.

Examples

Example 1: Fetch up to 50 topics from project 'ABC' filtered to public channel with status 'Open' and sorted by title ascending.

Set Project to 'ABC', Use Raw JSON Query to false, configure Filters with Channel = Public, Status to 'Open', Sort = 'title', Return All = false, Limit = 50.

Example 2: Retrieve all workflow-related topics for a specific project ID using a raw JSON query.

Set Project by expression for ID, enable Use Raw JSON Query, enter raw JSON with filter criteria for 'channel'='workflows', set Return All to true.

Links

Discussion