Trimble Documents (BCF 3.0) API

APIs related to Documents

GitHub OpenAPI

Operations 3

GET /bcf/3.0/projects/{project_id}/documents Get Documents #
POST /bcf/3.0/projects/{project_id}/documents Create Document #
GET /bcf/3.0/projects/{project_id}/documents/{document_id} Get Document #

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-documents-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-documents-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: Documents (BCF 3.0)
  description: APIs related to Documents
paths:
  /bcf/3.0/projects/{project_id}/documents:
    parameters:
    - $ref: '#/components/parameters/project_id'
    get:
      summary: Get Documents
      description: Retrieve a collection of all documents uploaded to a project.
      tags:
      - Documents (BCF 3.0)
      responses:
        '200':
          description: OK
          headers:
            odata.nextLink:
              schema:
                type: string
              description: The odata nextLink.
              example: /bcf/3.0/projects/1/topics/2/documents?skiptoken=q1byyUxySU3z
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/document_GET'
              example:
              - guid: 472ab37a-6122-448e-86fc-86503183b520
                filename: LegalRequirements.pdf
              - guid: 6cbfe31d-95c3-4f4d-92a6-420c23698721
                filename: DesignParameters.pdf
        '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

            - `topic_id` in path parameter not found

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
      operationId: getBcf30ProjectsByProjectIdDocuments
      x-operation-id-source: derived
    post:
      summary: Create Document
      description: 'Upload a document (binary file) to a project. This operation is only possible when the server returns the createDocument

        flag in the Project authorization, see section 4.1.5'
      tags:
      - Documents (BCF 3.0)
      requestBody:
        required: true
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/document_GET'
              example:
                guid: 472ab37a-6122-448e-86fc-86503183b520
                filename: Official_Building_Permission.pdf
        '400':
          description: 'Bad Request.

            Possible reasons include:

            - Empty request body

            - 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

            - `topic_id` in path parameter not found

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
        '409':
          description: 'Conflict - The resource could not be created because the specified GUID already exists in the target system.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
      operationId: postBcf30ProjectsByProjectIdDocuments
      x-operation-id-source: derived
  /bcf/3.0/projects/{project_id}/documents/{document_id}:
    parameters:
    - $ref: '#/components/parameters/project_id'
    - $ref: '#/components/parameters/document_id'
    get:
      summary: Get Document
      description: Retrieves a document as binary file.
      tags:
      - Documents (BCF 3.0)
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '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

            - `topic_id` in path parameter not found

            - `document_id` in path parameter not found

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
      operationId: getBcf30ProjectsByProjectIdDocumentsByDocumentId
      x-operation-id-source: derived
components:
  schemas:
    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
    document_GET:
      type: object
      required:
      - guid
      - filename
      properties:
        guid:
          type: string
        filename:
          type: string
  parameters:
    project_id:
      in: path
      name: project_id
      description: The id of the Trimble Connect Project
      schema:
        type: string
      required: true
    document_id:
      in: path
      name: document_id
      schema:
        type: string
      required: true
  securitySchemes:
    Bearer:
      type: http
      description: The Trimble ID access token.
      scheme: bearer
      bearerFormat: JWT