StreamBIM icon

StreamBIM

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

Checklist → Get Many

AI-generated

Summary

Retrieve multiple checklist items from a specified StreamBIM project, optionally filtering by draft status or using a raw JSON:API query, with support for pagination and limiting the number of returned results.

Inputs

  • Project Name or ID (required) — Select a project from your StreamBIM account by choosing from a list loaded via your credential's region setting, or provide a project ID via expression.
  • Advanced — Use Raw Query Object JSON — Enable to bypass the UI filters and send a raw JSON:API query object to customize the checklist retrieval more flexibly.
  • Filters — When raw query is disabled, filter checklists by draft status (e.g., include or exclude draft checklists).
  • Query Parameters (Raw JSON) — Specify raw JSON:API query parameters to filter and control checklist results; this is used only when raw query mode is enabled. Pagination keys like page[limit] or page[skip] here are ignored; use the node's Return All or Limit settings instead.
  • Return All — Toggle to return all checklist items matching the filters or limit the results returned.
  • Limit — Specify the maximum number of checklist items to return when Return All is disabled. Defaults to 50; maximum is 1000.

Output shape

a list of checklist items, each representing a checklist in the selected project

The output is paginated according to the Return All and Limit settings. Filters apply only when raw query mode is disabled; otherwise, the raw query JSON governs filtering. The Project Name or ID is required to scope the checklist retrieval to a specific project. Errors may occur if project access is not authorized or if the query parameters are invalid.

Examples

Example 1: Get all non-draft checklists from a project named 'Sample Project'

Set Project to 'Sample Project', disable raw JSON query, set Is Draft filter to false, enable Return All.

Links

Discussion