Trimble Foundation API

APIs related to Foundation

GitHub OpenAPI

Operations 3

GET /foundation/versions An unauthenticated API discovery endpoint #
GET /foundation/1.0/auth An unauthenticated OAUTH discovery endpoint #
GET /foundation/1.0/current-user Get the current user information #

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-foundation-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-foundation-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: Foundation
  description: APIs related to Foundation
paths:
  /foundation/versions:
    get:
      summary: An unauthenticated API discovery endpoint
      tags:
      - Foundation
      description: Returns a list of all supported APIs and their versions on this server.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VersionsResponse'
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorResponse'
      operationId: getFoundationVersions
      x-operation-id-source: derived
  /foundation/1.0/auth:
    get:
      summary: An unauthenticated OAUTH discovery endpoint
      tags:
      - Foundation
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AuthenticationInfoResponse'
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorResponse'
      operationId: getFoundation10Auth
      x-operation-id-source: derived
  /foundation/1.0/current-user:
    get:
      summary: Get the current user information
      tags:
      - Foundation
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/UserResponse'
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorResponse'
      operationId: getFoundation10CurrentUser
      x-operation-id-source: derived
components:
  schemas:
    AuthenticationInfoResponse:
      type: object
      required:
      - supported_oauth2_flows
      properties:
        oauth2_auth_url:
          type: string
          description: URL to authorization page (used for Authorization Code Grant and Implicit Grant OAuth2 flows)
          example: https://example.com/foundation/oauth2/auth
        oauth2_token_url:
          type: string
          description: URL for token requests
          example: https://example.com/foundation/oauth2/token
          format: uri
        http_basic_supported:
          type: boolean
          description: Indicates if Http Basic Authentication is supported
          example: false
        supported_oauth2_flows:
          type: array
          description: Indicates supported OAuth2 flows
          items:
            type: string
            enum:
            - authorization_code_grant
            - implicit_grant
            - resource_owner_password_credentials_grant
    Version:
      type: object
      required:
      - api_id
      - version_id
      properties:
        version_id:
          type: string
          description: The version number
          example: '3.0'
        api_id:
          type: string
          description: The API name
          enum:
          - bcf
          - foundation
          example: bcf
        detailed_version:
          type: string
          description: The URL of the API specification on Github
          example: https://github.com/buildingSMART/BCF-API/tree/release
        api_base_url:
          type: string
          description: An optional, fully qualified URL, to allow servers to relocate the API
          example: https://server.base.url/somepath/bcf/3.0
          format: uri
    UserResponse:
      type: object
      required:
      - id
      properties:
        id:
          type: string
          description: A unique identifier for the user on the server
          example: Architect@example.com
        name:
          type: string
          description: The user's full name
          example: John Doe
    VersionsResponse:
      type: object
      properties:
        versions:
          type: array
          items:
            $ref: '#/components/schemas/Version'
    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
  securitySchemes:
    Bearer:
      type: http
      description: The Trimble ID access token.
      scheme: bearer
      bearerFormat: JWT