Trimble Projects (BCF 2.1) API

APIs related to Projects

GitHub OpenAPI

Operations 5

GET /bcf/2.1/projects GetProjects #
GET /bcf/2.1/projects/{projectId} GetProject #
GET /bcf/2.1/projects/{projectId}/extensions GetExtensions #
PUT /bcf/2.1/projects/{projectId}/extensions UpdateProjectExtensions #
GET /bcf/2.1/projects/{projectId}/defaultextensions GetDefaultExtensions #

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-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-projects-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: Projects (BCF 2.1)
  description: APIs related to Projects
paths:
  /bcf/2.1/projects:
    get:
      tags:
      - Projects (BCF 2.1)
      summary: GetProjects
      description: Retrieve a collection of projects where the currently logged on user has access to.
      operationId: ListAllProjects
      responses:
        '200':
          description: The list of projects.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/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'
  /bcf/2.1/projects/{projectId}:
    get:
      tags:
      - Projects (BCF 2.1)
      summary: GetProject
      description: Retrieve a specific project
      operationId: ListProjectByProjectId
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The requested project.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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'
  /bcf/2.1/projects/{projectId}/extensions:
    get:
      tags:
      - Projects (BCF 2.1)
      summary: GetExtensions
      description: 'Retrieves the currently valid Project Extensions.


        Default values will be created if no other values exist yet.'
      operationId: ListProjectExtensions
      parameters:
      - name: projectId
        in: path
        description: The id of the Trimble Connect Project
        required: true
        schema:
          type: string
      - name: includeUsers
        in: query
        description: Query parameter to include users, default true. Set to false for improved performance.
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: The currently valid Project Extensions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtensionsDto'
        '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'
    put:
      tags:
      - Projects (BCF 2.1)
      summary: UpdateProjectExtensions
      description: 'Updates the Project Extensions.


        Sample request:


        PUT projects/{projectId}/extensions

        {

        "topic_type": ["Information", "Error"],

        "topic_status": ["Open", "Closed", "ReOpened"],

        "topic_label": ["Architecture", "Structural", "MEP"],

        "priority": ["Low", "Medium", "High"],

        "stage": ["Preliminary Planning End", "Construction Start", "Construction End"]

        }'
      operationId: UpdateProjectExtensions
      parameters:
      - name: projectId
        in: path
        description: The id of the Trimble Connect Project
        required: true
        schema:
          type: string
      requestBody:
        description: The Extensions to be updated.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateExtensionsDto'
          text/json:
            schema:
              $ref: '#/components/schemas/UpdateExtensionsDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UpdateExtensionsDto'
      responses:
        '200':
          description: The updated Project Extensions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtensionsDto'
        '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}/defaultextensions:
    get:
      tags:
      - Projects (BCF 2.1)
      summary: GetDefaultExtensions
      description: The default extension values (without project members).
      operationId: ListDefaultExtensions
      parameters:
      - name: projectId
        in: path
        description: The id of the Trimble Connect Project
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The default extension values.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtensionsDto'
        '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'
components:
  schemas:
    UpdateExtensionsDto:
      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
      additionalProperties: false
    ExtensionsDto:
      type: object
      required:
      - topic_type
      - topic_status
      - topic_label
      - snippet_type
      - priority
      - user_id_type
      - stage
      properties:
        version:
          type:
          - integer
          - 'null'
          format: int32
        snippet_type:
          type: array
          items:
            type: string
        user_id_type:
          type: array
          items:
            type: string
        project_actions:
          type:
          - array
          - 'null'
          items:
            type: string
        topic_actions:
          type:
          - array
          - 'null'
          items:
            type: string
        comment_actions:
          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
          items:
            type: string
          readOnly: true
        topic_status:
          type: array
          items:
            type: string
          readOnly: true
        topic_label:
          type: array
          items:
            type: string
          readOnly: true
        priority:
          type: array
          items:
            type: string
          readOnly: true
        stage:
          type: array
          items:
            type: string
          readOnly: true
      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.
    Project:
      type: object
      required:
      - project_id
      - name
      properties:
        name:
          type: string
        project_id:
          type: string
      additionalProperties: false
    ExtensionTypeFull:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        color:
          type:
          - string
          - 'null'
        icon:
          type:
          - string
          - 'null'
        visible:
          type: boolean
        isdefault:
          type: boolean
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: http
      description: The Trimble ID access token.
      scheme: bearer
      bearerFormat: JWT