Trimble Topics (BCF 2.1) API

APIs related to Topics

GitHub OpenAPI

Operations 5

GET /bcf/2.1/projects/{projectId}/topics GetTopics #
POST /bcf/2.1/projects/{projectId}/topics CreateTopic #
GET /bcf/2.1/projects/{projectId}/topics/{topicId} GetTopic #
PUT /bcf/2.1/projects/{projectId}/topics/{topicId} UpdateTopic #
DELETE /bcf/2.1/projects/{projectId}/topics/{topicId} DeleteTopic #

Documentation

Specifications

Schemas & Data

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/trimble:trimble-topics-bcf-2-1-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

trimble-topics-bcf-2-1-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Trimble Connect Topics API with BCF 2.1 and 3.0…
  description: '# Overview

    A BCF 2.1 and BCF 3.0 compatible service.


    Documentation for this service is available on the Trimble Developer site.


    # Getting started

    **You must agree to the Terms of Service to use Connect services.**


    You need to complete the steps in the Getting started guide to be able to call the API.


    # Concepts

    Please see Common Concepts in the Connect Platform documentation.


    ## Paginated Responses (BCF 2.1)


    All endpoints that return collection of resources follow the same schema for query parameters and

    response structure to paginate the results.

    Pagination allows to limit the size of the large responses and aimed to improve the responsiveness and overall

    performance when fetching large result sets. The overall latency is improved

    by parallelization of data processing and transfer.


    The requests accept `top` and `skiptoken` query parameters.


    `skiptoken` is a token used for pagination, typically returned with the previous page, and should be used as-is without interpretation.

    If the `skiptoken` query parameter is not specified, the first page of the result set is returned.


    The `top` parameter informs the server on how many items client

    wants to receive in a single page. Server returns the requested number of items

    if they are available or less (for the last page in the result set).

    If `top` parameter is not specified then the server returns maximum page size by default.


    Additionally, the response header contains a `next` field, which is a URL that points to the next page of items.


    ## Paginated Responses (BCF 3.0)


    Pagination follows OData v4 standard.


    Service supports server-driven pagination in which it returns to the client the next page URL by providing `odata.nextLink` in the response header.


    ## Syncing Extensions


    In addition to BCF-API compatibility, the service provides Topics Syncing extensions that are useful in various cases,

    such as a temporary loss of internet connection.


    ## Limitations


    Currently, the following BCF-API standard features are not supported:

    - OData sorting and filtering data

    - Viewpoint Bitmaps

    - Topic BIM Snippets

    - OData pagination on the BCF 2.1 endpoints

    - Topics Events

    - Comments Events'
  version: v2
  contact:
    name: Trimble Connect Support
    url: https://connect.trimble.com
    email: connect-support@trimble.com
  license:
    name: Trimble Connect SDK Internal Use License
    url: https://developer.trimble.com/docs/connect/terms/SDK-IU-license-agreement
  termsOfService: https://developer.trimble.com/docs/connect/terms
servers:
- url: https://open11.connect.trimble.com
  description: Production North America
- url: https://open21.connect.trimble.com
  description: Production Europe
- url: https://open31.connect.trimble.com
  description: Production Asia-Pacific
- url: https://open32.connect.trimble.com
  description: Production Australia
- url: https://open11.stage.connect.trimble.com
  description: Staging North America
- url: https://open31.stage.connect.trimble.com
  description: Staging Asia-Pacific
security:
- Bearer: []
tags:
- name: Topics (BCF 2.1)
  description: APIs related to Topics
paths:
  /bcf/2.1/projects/{projectId}/topics:
    get:
      tags:
      - Topics (BCF 2.1)
      summary: GetTopics
      description: Retrieve a collection of topics related to the specified Trimble Connect Project (default sort order is "modified_date").
      operationId: ListAllTopics
      parameters:
      - name: projectId
        in: path
        description: The id of the Trimble Connect Project
        required: true
        schema:
          type: string
      - name: top
        in: query
        description: The maximum number of items to be returned on a single page
        schema:
          type: integer
          format: int32
          default: 500
          maximum: 500
      - name: skiptoken
        in: query
        description: The token used for pagination. Typically returned with the response in the previous page and should be used as-is without interpretation.
        schema:
          type: string
      responses:
        '200':
          description: An array of Topics for this Project.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TopicDto'
        '204':
          description: No Topics have been defined yet for this Project.
        '401':
          description: Authorization information is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: User has no permissions to execute this operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: The specified projectId was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
      - Topics (BCF 2.1)
      summary: CreateTopic
      description: 'Creates a new Topic for the specified Trimble Connect Project.


        Sample request:


        POST Projects/{projectId}/Topics

        {

        "title": "Clash between pipes",

        "topic_type": "Inspection",

        "description": "More details needed",

        "assigned_to": "Assignee_Name@trimble.com",

        "assigned_to_uuid": "c5a73cc9-b155-4556-8963-bc7dc13c6fd2",

        "topic_status": "Not Started",

        "reference_links": [ "https://www.google.com", "https://www.trimble.com" ],

        "labels": [ "Road", "Electrical" ]

        }'
      operationId: CreateNewTopic
      parameters:
      - name: projectId
        in: path
        description: The id of the Trimble Connect Project
        required: true
        schema:
          type: string
      - name: validation
        in: query
        description: "A flag to customize the validation behavior.\n \nUse 'add' to add new values from the new topic to the project extensions.\n \nUse 'replace' to replace the topic values not present in the project extensions with current default values from the project extensions. If there is no default value, no value will be set.\n \nUse 'strict' to validate the topic values against the current project extensions values (this is the default behavior). If the topic values are not found in the project extensions, it will result in a validation error."
        schema:
          type: string
          default: strict
      requestBody:
        description: The Topic to be created
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTopicDto'
          text/json:
            schema:
              $ref: '#/components/schemas/CreateTopicDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CreateTopicDto'
      responses:
        '201':
          description: The newly created Topic.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TopicDto'
        '400':
          description: Request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authorization information is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: User has no permissions to execute this operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: The specified projectId was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '415':
          description: Unsupported Media Type.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /bcf/2.1/projects/{projectId}/topics/{topicId}:
    get:
      tags:
      - Topics (BCF 2.1)
      summary: GetTopic
      description: Retrieve a specified Topic.
      operationId: ListTopicByTopicId
      parameters:
      - name: projectId
        in: path
        description: The id of the Trimble Connect Project
        required: true
        schema:
          type: string
      - name: topicId
        in: path
        description: The id of the Topic
        required: true
        schema:
          type: string
      - name: deleted
        in: query
        description: Set to true if the Topic has been deleted
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: The specified Topic.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TopicDto'
        '401':
          description: Authorization information is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: User has no permissions to execute this operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: The specified projectId/topicId was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      tags:
      - Topics (BCF 2.1)
      summary: UpdateTopic
      description: 'Updates a specified Topic.


        Sample request:


        PUT Projects/{projectId}/Topics/{topicId}

        {

        "title": "Clash between pipes",

        "topic_type": "Inspection",

        "description": "More details needed",

        "topic_status": "Not Started",

        "reference_links": [ "https://www.google.com", "https://www.trimble.com" ],

        "labels": [ "Road", "Electrical" ]

        }'
      operationId: UpdateTopicByTopicId
      parameters:
      - name: projectId
        in: path
        description: The id of the Trimble Connect Project
        required: true
        schema:
          type: string
      - name: topicId
        in: path
        description: The id of the Topic
        required: true
        schema:
          type: string
      - name: deleted
        in: query
        description: Set to true if the Topic to update is previously deleted and needs to be restored.
        schema:
          type: boolean
          default: false
      requestBody:
        description: The Topic to be updated.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTopicDto'
          text/json:
            schema:
              $ref: '#/components/schemas/UpdateTopicDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UpdateTopicDto'
      responses:
        '200':
          description: The updated Topic.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TopicDto'
        '400':
          description: Request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authorization information is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: User has no permissions to execute this operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: The specified projectId/topicId was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '415':
          description: Unsupported Media Type.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      tags:
      - Topics (BCF 2.1)
      summary: DeleteTopic
      description: Deletes the Topic
      operationId: DeleteTopicByTopicId
      parameters:
      - name: projectId
        in: path
        description: The id of the Trimble Connect Project
        required: true
        schema:
          type: string
      - name: topicId
        in: path
        description: The id of the Topic to be deleted.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The topic was deleted successfully.
        '401':
          description: Authorization information is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: User has no permissions to execute this operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: The specified projectId/topicId was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ViewpointInfoDto:
      type: object
      properties:
        guid:
          type:
          - string
          - 'null'
        view_id:
          type:
          - string
          - 'null'
        snapshot_url:
          type:
          - string
          - 'null'
        snapshot_thumb:
          type:
          - string
          - 'null'
      additionalProperties: false
    PointDto:
      type: object
      required:
      - x
      - y
      properties:
        x:
          type: number
          format: double
        y:
          type: number
          format: double
        z:
          type: number
          format: double
      additionalProperties: false
    UpdateTopicDto:
      type: object
      required:
      - title
      properties:
        topic_type:
          type:
          - string
          - 'null'
        topic_status:
          type:
          - string
          - 'null'
        reference_links:
          type:
          - array
          - 'null'
          items:
            type: string
        title:
          type: string
        priority:
          type:
          - string
          - 'null'
        index:
          type:
          - integer
          - 'null'
          format: int32
        labels:
          type:
          - array
          - 'null'
          items:
            type: string
        assigned_to:
          type:
          - string
          - 'null'
        assigned_to_uuid:
          type:
          - string
          - 'null'
        assignees:
          description: The `assignees` is a Connect-specific extension of the `assigned_to` property specified by the BCF standard, making it possible to have multiple assignees. Note that when both `assignees` and `assigned_to` are set in the request body, `assignees` will override `assigned_to`.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AssigneeDto'
        stage:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        due_date:
          type:
          - string
          - 'null'
          format: date-time
        marker:
          $ref: '#/components/schemas/MarkerDto'
        bim_snippet:
          $ref: '#/components/schemas/BimSnippetDto'
      additionalProperties: false
    AssigneeDto:
      type: object
      required:
      - id
      properties:
        id:
          type: string
          description: The Trimble Connect Id of the assignee.
        type:
          type:
          - string
          - 'null'
      additionalProperties: false
    RelatedTopicDto:
      type: object
      required:
      - related_topic_guid
      properties:
        related_topic_guid:
          type: string
      additionalProperties: false
    MarkerDto:
      type: object
      properties:
        model_point:
          $ref: '#/components/schemas/PointDto'
      additionalProperties: false
    BimSnippetDto:
      type: object
      required:
      - snippet_type
      - is_external
      - reference
      - reference_schema
      properties:
        snippet_type:
          type:
          - string
          - 'null'
        is_external:
          type:
          - boolean
          - 'null'
        reference:
          type:
          - string
          - 'null'
        reference_schema:
          type:
          - string
          - 'null'
      additionalProperties: false
    TopicDto:
      type: object
      required:
      - guid
      - title
      - creation_date
      - creation_author
      - creation_author_uuid
      properties:
        version:
          type:
          - integer
          - 'null'
          format: int32
          minimum: 0
        guid:
          type: string
        topic_type:
          type:
          - string
          - 'null'
        topic_status:
          type:
          - string
          - 'null'
        reference_links:
          type:
          - array
          - 'null'
          items:
            type: string
        title:
          type: string
        priority:
          type:
          - string
          - 'null'
        index:
          type:
          - integer
          - 'null'
          format: int32
        labels:
          type:
          - array
          - 'null'
          items:
            type: string
        creation_date:
          type: string
          format: date-time
        creation_author:
          type: string
        creation_author_uuid:
          type: string
        created_by_uuid:
          type:
          - string
          - 'null'
        modified_date:
          type: string
          format: date-time
        modified_author:
          type:
          - string
          - 'null'
        modified_author_uuid:
          type:
          - string
          - 'null'
        assigned_to:
          type:
          - string
          - 'null'
        assigned_to_uuid:
          type:
          - string
          - 'null'
        assignees:
          description: The `assignees` is a Connect-specific extension of the `assigned_to` property specified by the BCF standard, making it possible to have multiple assignees. Note that when both `assignees` and `assigned_to` are set in the request body, `assignees` will override `assigned_to`.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AssigneeDto'
        stage:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        due_date:
          type:
          - string
          - 'null'
          format: date-time
        marker:
          $ref: '#/components/schemas/MarkerDto'
        viewpoint:
          $ref: '#/components/schemas/ViewpointInfoDto'
        bim_snippet:
          $ref: '#/components/schemas/BimSnippetDto'
        related_topics:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RelatedTopicDto'
        files:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FileDto'
      additionalProperties: false
    FileDto:
      type: object
      properties:
        ifc_project:
          type:
          - string
          - 'null'
        ifc_spatial_structure_element:
          type:
          - string
          - 'null'
        file_name:
          type:
          - string
          - 'null'
        date:
          type:
          - string
          - 'null'
        reference:
          type:
          - string
          - 'null'
      additionalProperties: false
    ErrorResponse:
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: string
          minLength: 1
          description: The textual error code.
        message:
          type: string
          description: The error message.
      additionalProperties: false
      description: The error response body. Defines a standard for reporting errors to the client.
    CreateTopicDto:
      type: object
      required:
      - title
      properties:
        guid:
          type:
          - string
          - 'null'
        title:
          type: string
        description:
          type:
          - string
          - 'null'
        topic_type:
          type:
          - string
          - 'null'
        topic_status:
          type:
          - string
          - 'null'
        priority:
          type:
          - string
          - 'null'
        labels:
          type:
          - array
          - 'null'
          items:
            type: string
        assigned_to:
          type:
          - string
          - 'null'
        assigned_to_uuid:
          type:
          - string
          - 'null'
        assignees:
          description: The `assignees` is a Connect-specific extension of the `assigned_to` property specified by the BCF standard, making it possible to have multiple assignees. Note that when both `assignees` and `assigned_to` are set in the request body, `assignees` will override `assigned_to`.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AssigneeDto'
        reference_links:
          type:
          - array
          - 'null'
          items:
            type: string
        index:
          type:
          - integer
          - 'null'
          format: int32
        stage:
          type:
          - string
          - 'null'
        creation_date:
          type:
          - string
          - 'null'
          format: date-time
        creation_author:
          type:
          - string
          - 'null'
        creation_author_uuid:
          type:
          - string
          - 'null'
        due_date:
          type:
          - string
          - 'null'
          format: date-time
        marker:
          $ref: '#/components/schemas/MarkerDto'
        bim_snippet:
          $ref: '#/components/schemas/BimSnippetDto'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: http
      description: The Trimble ID access token.
      scheme: bearer
      bearerFormat: JWT