Trimble Projects (BCF 3.0) API

APIs related to Projects

GitHub OpenAPI

Operations 5

GET /bcf/3.0/projects Get Projects #
GET /bcf/3.0/projects/{project_id} Get Project #
GET /bcf/3.0/projects/{project_id}/extensions Get Project Extensions #
PUT /bcf/3.0/projects/{project_id}/extensions [TC EXTENSION] Update Project Extensions #
GET /bcf/3.0/projects/{project_id}/defaultextensions [TC EXTENSION] Get Default Extensions #

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-projects-bcf-3-0-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-projects-bcf-3-0-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: Projects (BCF 3.0)
  description: APIs related to Projects
paths:
  /bcf/3.0/projects:
    get:
      description: Retrieve a collection of projects where the currently logged on user has access to.
      summary: Get Projects
      tags:
      - Projects (BCF 3.0)
      responses:
        '200':
          description: OK
          headers:
            odata.nextLink:
              schema:
                type: string
              description: The odata nextLink.
              example: /bcf/3.0/projects?skiptoken=q1byyUxySU3z
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/projects'
              example:
              - project_id: F445F4F2-4D02-4B2A-B612-5E456BEF9137
                name: Example project 1
                authorization:
                  project_actions:
                  - createTopic
                  - createDocument
              - project_id: A233FBB2-3A3B-EFF4-C123-DE22ABC8414
                name: Example project 2
                authorization:
                  project_actions: []
        '401':
          description: Authorization information is missing, invalid or expired.
          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'
      operationId: getBcf30Projects
      x-operation-id-source: derived
  /bcf/3.0/projects/{project_id}:
    parameters:
    - $ref: '#/components/parameters/project_id'
    get:
      summary: Get Project
      description: Retrieve a specific project.
      tags:
      - Projects (BCF 3.0)
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/project_GET'
              example:
                project_id: B724AAC3-5B2A-234A-D143-AE33CC18414
                name: Example project 3
                authorization:
                  project_actions:
                  - update
        '400':
          description: 'Bad Request.

            Possible reasons include:

            - Path parameters passed in a format that is not supported

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
        '401':
          description: Authorization information is missing, invalid or expired.
          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: 'Not Found - The requested resource could not be found.

            Possible reasons include:

            - `project_id` in path parameter not found

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
      operationId: getBcf30ProjectsByProjectId
      x-operation-id-source: derived
  /bcf/3.0/projects/{project_id}/extensions:
    parameters:
    - $ref: '#/components/parameters/project_id'
    get:
      summary: Get Project Extensions
      description: 'Retrieve a specific projects extensions. Project extensions are used to define possible values that can be used in topics and comments, for example topic labels and priorities.

        They may change during the course of a project. The most recent extensions state which values are valid at a given moment for newly created topics and comments.'
      tags:
      - Projects (BCF 3.0)
      responses:
        '200':
          description: 'The response format varies based on the `Accept` header value in the request.


            | Accept Header Value                              | Response Format                      |

            |--------------------------------------------------|--------------------------------------|

            | Not provided or `application/json`               | Pure BCF 3.0 representation          |

            | `application/vnd.trimble.connect.app+json`       | Connect representation               |

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/extensions_GET'
              example:
                topic_type:
                - Information
                - Error
                topic_status:
                - Open
                - Closed
                - ReOpened
                topic_label:
                - Architecture
                - Structural
                - MEP
                snippet_type:
                - .ifc
                - .csv
                priority:
                - Low
                - Medium
                - High
                users:
                - Architect@example.com
                - BIM-Manager@example.com
                - bob_heater@example.com
                stage:
                - Preliminary Planning End
                - Construction Start
                - Construction End
                project_actions:
                - update
                - createTopic
                - createDocument
                topic_actions:
                - update
                - updateBimSnippet
                - updateRelatedTopics
                - updateDocumentReferences
                - updateFiles
                - createComment
                - createViewpoint
                comment_actions:
                - update
            application/vnd.trimble.connect.app+json:
              schema:
                $ref: '#/components/schemas/extensions_GET_Connect'
              example:
                topic_type:
                - Information
                - Error
                topic_status:
                - Open
                - Closed
                - ReOpened
                topic_label:
                - Architecture
                - Structural
                - MEP
                snippet_type:
                - .ifc
                - .csv
                priority:
                - Low
                - Medium
                - High
                users:
                - Architect@example.com
                - BIM-Manager@example.com
                - bob_heater@example.com
                stage:
                - Preliminary Planning End
                - Construction Start
                - Construction End
                topic_server_assigned_id_prefix: ABCD
                project_actions:
                - update
                - createTopic
                - createDocument
                topic_actions:
                - update
                - updateBimSnippet
                - updateRelatedTopics
                - updateDocumentReferences
                - updateFiles
                - createComment
                - createViewpoint
                comment_actions:
                - update
                topic_type_full:
                - name: Comment
                  color: '#005F9E'
                  icon: data:image/svg+xml;base64,XXXXXXXX
                  visible: true
                  isdefault: false
                - name: Issue
                  color: '#C81922'
                  icon: data:image/svg+xml;base64,XXXXXXXX
                  visible: true
                  isdefault: false
                topic_status_full:
                - name: New
                  color: '#3684d1'
                  icon: tc-icon-circle
                  visible: true
                  isdefault: true
                - name: In Progress
                  color: '#fcc603'
                  icon: tc-icon-circle
                  visible: true
                  isdefault: false
                - name: Closed
                  color: '#36b7d1'
                  icon: tc-icon-circle
                  visible: true
                  isdefault: false
                topic_label_full:
                - name: PostmanLabel
                  color: '#005F9E'
                  visible: true
                  isdefault: false
                priority_full:
                - name: Low
                  color: '#72A544'
                  icon: tc-icon-bookmark
                  visible: true
                  isdefault: false
                - name: Medium
                  color: '#72A510'
                  icon: tc-icon-bookmark
                  visible: true
                  isdefault: false
                - name: High
                  color: '#FFBE00'
                  icon: tc-icon-bookmark
                  visible: true
                  isdefault: false
        '400':
          description: 'Bad Request.

            Possible reasons include:

            - Path parameters passed in a format that is not supported

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
        '401':
          description: Authorization information is missing, invalid or expired.
          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: 'Not Found - The requested resource could not be found.

            Possible reasons include:

            - `project_id` in path parameter not found

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
      operationId: getBcf30ProjectsByProjectIdExtensions
      x-operation-id-source: derived
    put:
      summary: '[TC EXTENSION] Update Project Extensions'
      description: '**`This API is an extension for Trimble Connect and is not part of the BCF standard.`**


        Update the extensions of a specific project.

        The extensions are used to define possible values that can be used in topics, for example topic labels and priorities.'
      tags:
      - Projects (BCF 3.0)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/extensions_PUT_Connect'
            example:
              priority_full:
              - name: Medium
                color: '#72A510'
                icon: tc-icon-bookmark
                visible: true
                isdefault: false
              topic_server_assigned_id_prefix: ABCD
      responses:
        '200':
          description: The updated Project Extensions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/extensions_GET_Connect'
              example:
                topic_type:
                - Information
                - Error
                topic_status:
                - Open
                - Closed
                - ReOpened
                topic_label:
                - Architecture
                - Structural
                - MEP
                snippet_type:
                - .ifc
                - .csv
                priority:
                - Low
                - Medium
                - High
                users:
                - Architect@example.com
                - BIM-Manager@example.com
                - bob_heater@example.com
                stage:
                - Preliminary Planning End
                - Construction Start
                - Construction End
                topic_server_assigned_id_prefix: ABCD
                project_actions:
                - update
                - createTopic
                - createDocument
                topic_actions:
                - update
                - updateBimSnippet
                - updateRelatedTopics
                - updateDocumentReferences
                - updateFiles
                - createComment
                - createViewpoint
                comment_actions:
                - update
                topic_type_full:
                - name: Comment
                  color: '#005F9E'
                  icon: data:image/svg+xml;base64,XXXXXXXX
                  visible: true
                  isdefault: false
                - name: Issue
                  color: '#C81922'
                  icon: data:image/svg+xml;base64,XXXXXXXX
                  visible: true
                  isdefault: false
                topic_status_full:
                - name: New
                  color: '#3684d1'
                  icon: tc-icon-circle
                  visible: true
                  isdefault: true
                - name: In Progress
                  color: '#fcc603'
                  icon: tc-icon-circle
                  visible: true
                  isdefault: false
                - name: Closed
                  color: '#36b7d1'
                  icon: tc-icon-circle
                  visible: true
                  isdefault: false
                topic_label_full:
                - name: PostmanLabel
                  color: '#005F9E'
                  visible: true
                  isdefault: false
                priority_full:
                - name: Low
                  color: '#72A544'
                  icon: tc-icon-bookmark
                  visible: true
                  isdefault: false
                - name: Medium
                  color: '#72A510'
                  icon: tc-icon-bookmark
                  visible: true
                  isdefault: false
                - name: High
                  color: '#FFBE00'
                  icon: tc-icon-bookmark
                  visible: true
                  isdefault: false
        '401':
          description: Authorization information is missing, invalid or expired.
          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: 'Not Found - The requested resource could not be found.

            Possible reasons include:

            - `project_id` in path parameter not found

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
      operationId: putBcf30ProjectsByProjectIdExtensions
      x-operation-id-source: derived
  /bcf/3.0/projects/{project_id}/defaultextensions:
    parameters:
    - $ref: '#/components/parameters/project_id'
    get:
      summary: '[TC EXTENSION] Get Default Extensions'
      description: '**`This API is an extension for Trimble Connect and is not part of the BCF standard.`**


        Gets the default extension values (without project members).'
      tags:
      - Projects (BCF 3.0)
      responses:
        '200':
          description: The default project extension values.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/extensions_GET_Connect'
              example:
                topic_type:
                - Information
                - Error
                topic_status:
                - Open
                - Closed
                - ReOpened
                topic_label:
                - Architecture
                - Structural
                - MEP
                snippet_type:
                - .ifc
                - .csv
                priority:
                - Low
                - Medium
                - High
                users:
                - Architect@example.com
                - BIM-Manager@example.com
                - bob_heater@example.com
                stage:
                - Preliminary Planning End
                - Construction Start
                - Construction End
                project_actions:
                - update
                - createTopic
                - createDocument
                topic_actions:
                - update
                - updateBimSnippet
                - updateRelatedTopics
                - updateDocumentReferences
                - updateFiles
                - createComment
                - createViewpoint
                comment_actions:
                - update
                topic_type_full:
                - name: Comment
                  color: '#005F9E'
                  icon: data:image/svg+xml;base64,XXXXXXXX
                  visible: true
                  isdefault: false
                - name: Issue
                  color: '#C81922'
                  icon: data:image/svg+xml;base64,XXXXXXXX
                  visible: true
                  isdefault: false
                topic_status_full:
                - name: New
                  color: '#3684d1'
                  icon: tc-icon-circle
                  visible: true
                  isdefault: true
                - name: In Progress
                  color: '#fcc603'
                  icon: tc-icon-circle
                  visible: true
                  isdefault: false
                - name: Closed
                  color: '#36b7d1'
                  icon: tc-icon-circle
                  visible: true
                  isdefault: false
                topic_label_full:
                - name: PostmanLabel
                  color: '#005F9E'
                  visible: true
                  isdefault: false
                priority_full:
                - name: Low
                  color: '#72A544'
                  icon: tc-icon-bookmark
                  visible: true
                  isdefault: false
                - name: High
                  color: '#FFBE00'
                  icon: tc-icon-bookmark
                  visible: true
                  isdefault: false
        '401':
          description: Authorization information is missing, invalid or expired.
          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: 'Not Found - The requested resource could not be found.

            Possible reasons include:

            - `project_id` in path parameter not found

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
      operationId: getBcf30ProjectsByProjectIdDefaultextensions
      x-operation-id-source: derived
components:
  schemas:
    extensions_PUT_Connect:
      type:
      - object
      - 'null'
      properties:
        snippet_type:
          type:
          - array
          - 'null'
          items:
            type: string
        topic_type_full:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/extensionTypeFull'
        topic_status_full:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/extensionTypeFull'
        topic_label_full:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/extensionTypeFull'
        priority_full:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/extensionTypeFull'
        stage_full:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/extensionTypeFull'
        topic_type:
          type:
          - array
          - 'null'
          items:
            type: string
        topic_status:
          type:
          - array
          - 'null'
          items:
            type: string
        topic_label:
          type:
          - array
          - 'null'
          items:
            type: string
        priority:
          type:
          - array
          - 'null'
          items:
            type: string
        stage:
          type:
          - array
          - 'null'
          items:
            type: string
        topic_server_assigned_id_prefix:
          type:
          - string
          - 'null'
      additionalProperties: false
    topic_actions:
      type: array
      items:
        type: string
        enum:
        - update
        - updateBimSnippet
        - updateRelatedTopics
        - updateDocumentReferences
        - updateFiles
        - createComment
        - createViewpoint
        - delete
    comment_actions:
      type: array
      items:
        type: string
        enum:
        - update
        - delete
    project_actions:
      type: array
      items:
        type: string
        enum:
        - update
        - createTopic
        - createDocument
    projects:
      type: array
      items:
        $ref: '#/components/schemas/project_GET'
    extensionTypeFull:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        color:
          type:
          - string
          - 'null'
        icon:
          type:
          - string
          - 'null'
        visible:
          type: boolean
        isdefault:
          type: boolean
      additionalProperties: false
    project_GET:
      type: object
      description: Schema for single project GET, BCF REST API.
      required:
      - project_id
      - name
      properties:
        project_id:
          type: string
        name:
          type: string
        authorization:
          type: object
          properties:
            project_actions:
              $ref: '#/components/schemas/project_actions'
    extensions_GET_Connect:
      type: object
      required:
      - topic_type
      - topic_status
      - topic_label
      - snippet_type
      - priority
      - users
      - stage
      properties:
        topic_type:
          type:
          - array
          - 'null'
          items:
            type:
            - string
            - 'null'
        topic_status:
          type:
          - array
          - 'null'
          items:
            type:
            - string
            - 'null'
        topic_label:
          type:
          - array
          - 'null'
          items:
            type:
            - string
            - 'null'
        snippet_type:
          type:
          - array
          - 'null'
          items:
            type:
            - string
            - 'null'
        priority:
          type:
          - array
          - 'null'
          items:
            type:
            - string
            - 'null'
        users:
          type:
          - array
          - 'null'
          items:
            type:
            - string
            - 'null'
        stage:
          type:
          - array
          - 'null'
          items:
            type:
            - string
            - 'null'
        topic_type_full:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/extensionTypeFull'
        topic_status_full:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/extensionTypeFull'
        topic_label_full:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/extensionTypeFull'
        priority_full:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/extensionTypeFull'
        stage_full:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/extensionTypeFull'
        topic_server_assigned_id_prefix:
          type:
          - string
          - 'null'
        project_actions:
          $ref: '#/components/schemas/project_actions'
        topic_actions:
          $ref: '#/components/schemas/topic_actions'
        comment_actions:
          $ref: '#/components/schemas/comment_actions'
    errorResponse:
      type: object
      description: Schema for error response, BCF REST API.
      required:
      - message
      properties:
        code:
          type: string
          description: Error code
        message:
          type: string
          description: Error message
    extensions_GET:
      type: object
      required:
      - topic_type
      - topic_status
      - topic_label
      - snippet_type
      - priority
      - users
      - stage
      properties:
        topic_type:
          type:
          - array
          - 'null'
          items:
            type:
            - string
            - 'null'
        topic_status:
          type:
          - array
          - 'null'
          items:
            type:
            - string
            - 'null'
        topic_label:
          type:
          - array
          - 'null'
          items:
            type:
            - string
            - 'null'
        snippet_type:
          type:
          - array
          - 'null'
          items:
            type:
            - string
            - 'null'
        priority:
          type:
          - array
          - 'null'
          items:
            type:
            - string
            - 'null'
        users:
          type:
          - array
          - 'null'
          items:
            type:
            - string
            - 'null'
        stage:
          type:
          - array
          - 'null'
          items:
            type:
            - string
            - 'null'
        project_actions:
          $ref: '#/components/schemas/project_actions'
        topic_actions:
          $ref: '#/components/schemas/topic_actions'
        comment_actions:
          $ref: '#/components/schemas/comment_actions'
  parameters:
    project_id:
      in: path
      name: project_id
      description: The id of the Trimble Connect Project
      schema:
        type: string
      required: true
  securitySchemes:
    Bearer:
      type: http
      description: The Trimble ID access token.
      scheme: bearer
      bearerFormat: JWT