Trimble Issue Links API

The Issue Links API from Trimble — 5 operation(s) for issue links.

GitHub OpenAPI

Operations 8

GET /context/{contextId}/issues/{issueId}/links/{linkId} Get a specific link by ID for a specified context and issue #
PUT /context/{contextId}/issues/{issueId}/links/bulk Bulk update links by resource type for a specified context and issue #
GET /context/{contextId}/issues/links/snapshot List all link objects for a context #
GET /context/{contextId}/issues/links/changes List recently changed links in a context #

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-issue-links-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-issue-links-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Issue Management Service Issue Links API
  description: '# Issue Management Service (IMS)


    REST API for creating, reading, updating, and deleting issues attached to a Trimble Connect context (project or file). Issues support rich access-control, capability discovery via `_actions`, and sync primitives (snapshot / changes feed).


    ## Context Types


    Every request targets a **context** identified by a TRN string passed as `{contextId}`. Two context types are supported and they have different ACL behaviours:


    | Context type | TRN pattern | ACL model |

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

    | **Project** | `trn:2:tc:{region}:projects:{projectId}` | Full viewer model — ADMIN, creator, assignee, and explicit ACL holders. Plain project members without an explicit ACL grant have no automatic access. |

    | **File** | `trn:2:tc:{region}:projects:{projectId}:files:{fileId}` | Open access — any user who can access the file receives all issue actions **except** `issue:UpdatePermissions`. The `/permissions` endpoints return `404` for file contexts. |


    ## Capability Discovery — `_actions`


    All issue endpoints accept an optional `?fields=_actions` query parameter. When requested, the response includes a `_actions` array listing the wire-format action strings the authenticated caller is **currently authorised** to perform on that issue. Clients **must** check `_actions` before showing mutation controls rather than hard-coding role assumptions.


    Available action values:


    | Wire value | Meaning |

    |---|---|

    | `issue:Read` | View issue details |

    | `issue:Update` | Edit issue fields |

    | `issue:Delete` | Delete the issue |

    | `issue:AddLinks` | Create links on this issue |

    | `issue:DeleteLinks` | Remove links from this issue |

    | `issue:ReadLinks` | List links attached to this issue |

    | `issue:UpdatePermissions` | Call `PATCH /permissions` on this issue (project context only) |


    ## ACL Buckets


    Issue permissions are stored as ACL buckets. The API surface exposes **two** buckets only (`"full"` is internal and rejected on PATCH):


    | Bucket key | Actions granted | Notes |

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

    | `"edit"` | `issue:Read`, `issue:Update`, `issue:AddLinks`, `issue:DeleteLinks`, `issue:ReadLinks`, `issue:UpdatePermissions` | Does **not** include `issue:Delete` |

    | `"view"` | `issue:Read`, `issue:ReadLinks` | Read-only access |


    The inherited ACL floor is: **creator → edit**, **assignees → edit**. Effective access = `max(inherited floor, explicit grant)` — explicit ACL can only **elevate**, never reduce, an actor''s access.


    ## ACL Permission Model (Project Context)


    - Project ADMIN → all 7 actions

    - Issue creator → all 7 actions

    - Issue assignee → `edit` bucket (no `issue:Delete`)

    - `tc-groups:*` in `acl.view` → VIEW bucket for all project members

    - Actors with explicit `"edit"` ACL entry → `edit` bucket

    - Actors with explicit `"view"` ACL entry → `view` bucket

    - No match → **empty actions** (denied; endpoints return 403)

    - Effective = `max(inherited floor, explicit grant)` — cannot downgrade


    When a new project is created, `shareNewIssuesWithAllProjectMembers` defaults to `true`, causing `tc-groups:*` to be auto-added to the `view` bucket of every newly created issue. Disabling this flag makes issues **private by default** (visible only to ADMIN, creator, and assignees).


    ## Identity Formats


    ACL identity strings must match `^(users:|tc-groups:).+$`:


    | Format | Example | Meaning |

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

    | `users:{tiduuid}` | `users:abc123` | Specific Trimble Identity user |

    | `tc-groups:{groupId}` | `tc-groups:grp456` | Specific Connect project group |

    | `tc-groups:*` | `tc-groups:*` | All project members (wildcard) |


    A maximum of **100 identities** across all buckets combined is enforced on PATCH.'
  contact:
    name: Trimble Connect Platform Team
  version: v1
servers:
- url: https://app.connect.trimble.com/v1/issues
  description: Prod US1 (primary)
- url: https://app21.connect.trimble.com/v1/issues
  description: Prod EU1
- url: https://app22.connect.trimble.com/v1/issues
  description: Prod UK1
- url: https://app31.connect.trimble.com/v1/issues
  description: Prod AP1
- url: https://app32.connect.trimble.com/v1/issues
  description: Prod AP2
security:
- bearerAuth: []
tags:
- name: Issue Links
paths:
  /context/{contextId}/issues/{issueId}/links/{linkId}:
    get:
      tags:
      - Issue Links
      summary: Get a specific link by ID for a specified context and issue
      description: Retrieve a specific link by its ID for a specified context and issue
      operationId: getContextIssueLinkById
      parameters:
      - name: contextId
        in: path
        description: The unique identifier of the context in TRN format (trn:2:tc:{us|eu|eu-gb|ap|ap-au}:projects:{projectId} for project context or trn:2:tc:{us|eu|eu-gb|ap|ap-au}:projects:{projectId}:files:{fileId} for file context).
        required: true
        schema:
          type: string
      - name: issueId
        in: path
        description: The issue ID for which the issue link is to be retrieved
        required: true
        schema:
          type: string
      - name: linkId
        in: path
        description: The link ID to be retrieved
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Issue link retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssueLinksResponse'
    put:
      tags:
      - Issue Links
      summary: Update a specific link for a specified context and issue
      description: Update a specific link by its ID for a specified context and issue
      operationId: updateContextIssueLink
      parameters:
      - name: contextId
        in: path
        description: The unique identifier of the context in TRN format (trn:2:tc:{us|eu|eu-gb|ap|ap-au}:projects:{projectId} for project context or trn:2:tc:{us|eu|eu-gb|ap|ap-au}:projects:{projectId}:files:{fileId} for file context).
        required: true
        schema:
          type: string
      - name: issueId
        in: path
        description: The issue ID for which the issue link is to be updated
        required: true
        schema:
          type: string
      - name: linkId
        in: path
        description: The link ID to be updated
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IssueLinksUpdateRequest'
        required: true
      responses:
        '200':
          description: Issue link updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssueLinksResponse'
    delete:
      tags:
      - Issue Links
      summary: Delete the link for a specified context and issue
      operationId: deleteContextIssueLink
      parameters:
      - name: contextId
        in: path
        description: The unique identifier of the context in TRN format (trn:2:tc:{us|eu|eu-gb|ap|ap-au}:projects:{projectId} for project context or trn:2:tc:{us|eu|eu-gb|ap|ap-au}:projects:{projectId}:files:{fileId} for file context).
        required: true
        schema:
          type: string
      - name: issueId
        in: path
        description: The issue ID for which the issue links are to be deleted
        required: true
        schema:
          type: string
      - name: linkId
        in: path
        description: The link ID to be deleted
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
  /context/{contextId}/issues/{issueId}/links/bulk:
    put:
      tags:
      - Issue Links
      summary: Bulk update links by resource type for a specified context and issue
      description: Replace all links of a specific resource type for an issue. Existing links of the specified resource type will be deleted and replaced with the new links. Maximum of 500 links per resource type are allowed in a single request.
      operationId: bulkUpdateIssueLinksByResourceType
      parameters:
      - name: contextId
        in: path
        description: The unique identifier of the context in TRN format (trn:2:tc:{us|eu|eu-gb|ap|ap-au}:projects:{projectId} for project context or trn:2:tc:{us|eu|eu-gb|ap|ap-au}:projects:{projectId}:files:{fileId} for file context).
        required: true
        schema:
          type: string
      - name: issueId
        in: path
        description: The issue ID for which the issue links are to be bulk updated
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IssueLinksBulkUpdateRequest'
        required: true
      responses:
        '200':
          description: Issue links bulk updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssueLinksBulkUpdateResponse'
        '409':
          description: Conflict - Resource is locked by another bulk operation or concurrent modification detected. Retry the request after a short delay.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssueLinksBulkUpdateResponse'
        '500':
          description: Internal Server Error - Operation failed. If rollback also failed, manual intervention may be required. Check the error message for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssueLinksBulkUpdateResponse'
  /context/{contextId}/issues/{issueId}/links:
    get:
      tags:
      - Issue Links
      summary: List Issue Links
      description: Retrieve the list of links for a specified issue in a context
      operationId: getContextIssueLinks
      parameters:
      - name: contextId
        in: path
        description: The unique identifier of the context in TRN format (trn:2:tc:{us|eu|eu-gb|ap|ap-au}:projects:{projectId} for project context or trn:2:tc:{us|eu|eu-gb|ap|ap-au}:projects:{projectId}:files:{fileId} for file context).
        required: true
        schema:
          type: string
      - name: issueId
        in: path
        description: The issue ID for which the issue links are to be retrieved
        required: true
        schema:
          type: string
      - name: resourceType
        in: query
        description: The resourceType of the links to be retrieved
        required: false
        schema:
          type: string
      - name: pageSize
        in: query
        description: The page size for the paginated response
        required: false
        schema:
          type: integer
          format: int32
          default: 500
      - name: skipToken
        in: query
        description: Token for retrieving the next page of results. A cursor pointing to the last known change of the objects. `skipToken` format is implementation detail of the service and must not be used or modified by client. The client should only pass the skipToken as it is received in Response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Issue links retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedResponse'
    post:
      tags:
      - Issue Links
      summary: Create a new link within a specified context and issue
      description: Create a new link within a specified context and issue. Maximum of 500 links per resource type are allowed per issue.
      operationId: createIssueLink
      parameters:
      - name: contextId
        in: path
        description: The unique identifier of the context in TRN format (trn:2:tc:{us|eu|eu-gb|ap|ap-au}:projects:{projectId} for project context or trn:2:tc:{us|eu|eu-gb|ap|ap-au}:projects:{projectId}:files:{fileId} for file context).
        required: true
        schema:
          type: string
      - name: issueId
        in: path
        description: The issue ID for which the issue links are to be created
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IssueLinksRequest'
        required: true
      responses:
        '201':
          description: Issue link created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssueLinksResponse'
  /context/{contextId}/issues/links/snapshot:
    get:
      tags:
      - Issue Links
      summary: List all link objects for a context
      description: Retrieve all issues links in a context, ordered by updatedAt. Used for initial sync. Returns minimal information by default.Paginate using `links.next`. Issues may repeat if updated during sync.
      operationId: getLinkObjects
      parameters:
      - name: contextId
        in: path
        description: The unique identifier of the context in TRN format (trn:2:tc:{us|eu|eu-gb|ap|ap-au}:projects:{projectId} for project context or trn:2:tc:{us|eu|eu-gb|ap|ap-au}:projects:{projectId}:files:{fileId} for file context).
        required: true
        schema:
          type: string
      - name: includeDeleted
        in: query
        description: Whether to include soft-deleted links in the result. When set to true, both active and deleted links will be returned. When false (default), only active links are included.
        required: false
        schema:
          type: boolean
          default: false
      - name: pageSize
        in: query
        description: The maximum number of link objects to return in a single page. Valid range is 1-1000. Default is 1000 if not specified.
        required: false
        schema:
          type: integer
          format: int32
          default: 1000
      - name: skipToken
        in: query
        description: Token for retrieving the next page of results. A cursor pointing to the last known change of the objects. `skipToken` format is implementation detail of the service and must not be used or modified by client. The client should only pass the skipToken as it is received in Response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Issue link objects retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedResponseWithToken'
  /context/{contextId}/issues/links/changes:
    get:
      tags:
      - Issue Links
      summary: List recently changed links in a context
      description: Retrieve all links in a context that were created or updated since a given change token. This API should be used after calling the objects API to get incremental changes. You can include deleted links as well.
      operationId: getLinkChanges
      parameters:
      - name: contextId
        in: path
        description: The unique identifier of the context in TRN format (trn:2:tc:{us|eu|eu-gb|ap|ap-au}:projects:{projectId} for project context or trn:2:tc:{us|eu|eu-gb|ap|ap-au}:projects:{projectId}:files:{fileId} for file context).
        required: true
        schema:
          type: string
      - name: changeToken
        in: query
        description: A cursor pointing to the last known change of the objects. ChangeToken format is implementation detail of the service and must not be used or modified by client The client should only pass the changeToken as it is received in Snapshot. Response or previous changes fetch response
        required: true
        schema:
          type: string
      - name: includeDeleted
        in: query
        description: Whether to include soft-deleted links in the result. When set to true, both active and deleted links will be returned in the changes. When false (default), only active link changes are included.
        required: false
        schema:
          type: boolean
          default: false
      - name: pageSize
        in: query
        description: The maximum number of link changes to return in a single page. Valid range is 1-1000. Default is 1000 if not specified.
        required: false
        schema:
          type: integer
          format: int32
          default: 1000
      - name: skipToken
        in: query
        description: Token for retrieving the next page of results. A cursor pointing to the last known change of the objects. `skipToken` format is implementation detail of the service and must not be used or modified by client. The client should only pass the skipToken as it is received in Response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Issue link changes retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedResponseWithToken'
components:
  schemas:
    PageReference:
      type: object
      properties:
        href:
          type: string
    PagedResponseWithToken:
      type: object
      properties:
        items:
          type: array
          items: {}
        links:
          $ref: '#/components/schemas/PageLink'
        changeToken:
          type: string
    PageLink:
      type: object
      properties:
        first:
          $ref: '#/components/schemas/PageReference'
        self:
          $ref: '#/components/schemas/PageReference'
        next:
          $ref: '#/components/schemas/PageReference'
    IssueLinksBulkUpdateResponse:
      type: object
      properties:
        resourceType:
          type: string
          description: The resource type that was updated
        links:
          type: array
          description: List of created/updated links
          items:
            $ref: '#/components/schemas/IssueLinksResponse'
      required:
      - links
      - resourceType
    IssueLinksUpdateRequest:
      type: object
      properties:
        description:
          type: string
          description: Description of the issue link
          maxLength: 2048
        properties:
          type: object
          additionalProperties:
            type: string
          description: Additional properties for the link
        resourceId:
          type: string
          description: The ID of the resource that the issue is linked to. Either resourceId or resourceReference must be provided, but not both.
        resourceReference:
          type: string
          description: The reference of the resource that the issue is linked to. Either resourceId or resourceReference must be provided, but not both.
    IssueLinksRequest:
      type: object
      properties:
        id:
          type: string
          description: The link ID of the issue
        resourceType:
          type: string
          description: 'The type of the resource that the issue is linked to. Supported types: VIEW_3D, VIEW_2D, CLASH_ITEM, FILE, ISSUE. Maximum of 500 links per resource type are allowed per issue.'
          enum:
          - VIEW_3D
          - VIEW_2D
          - CLASH_ITEM
          - FILE
          - MODEL_3D
          - ISSUE
        resourceId:
          type: string
          description: The ID of the resource that the issue is linked to. Either resourceId or resourceReference must be provided, but not both.
        resourceReference:
          type: string
          description: The reference of the resource that the issue is linked to. Either resourceId or resourceReference must be provided, but not both.
        description:
          type: string
          maxLength: 2048
        properties:
          type: object
          additionalProperties:
            type: string
          description: Additional properties for the link
    PagedResponse:
      type: object
      properties:
        items:
          type: array
          items: {}
        links:
          $ref: '#/components/schemas/PageLink'
    IssueLinkRequest:
      type: object
      properties:
        resourceId:
          type: string
          description: The ID of the resource that the issue is linked to. Either resourceId or resourceReference must be provided, but not both.
        resourceReference:
          type: string
          description: The reference of the resource that the issue is linked to. Either resourceId or resourceReference must be provided, but not both.
        description:
          type: string
          maxLength: 2048
        properties:
          type: object
          additionalProperties:
            type: string
          description: Additional properties for the link
    IssueLinksBulkUpdateRequest:
      type: object
      properties:
        resourceType:
          type: string
          description: 'The type of the resource that the issue is linked to. Supported types: VIEW_3D, VIEW_2D, CLASH_ITEM, FILE, ISSUE, MODEL_3D. All links in the request must have the same resourceType.'
          enum:
          - VIEW_3D
          - VIEW_2D
          - CLASH_ITEM
          - FILE
          - MODEL_3D
          - ISSUE
        links:
          type: array
          description: List of link requests. All links must have the same resourceType as specified above. Existing links of this resourceType will be deleted and replaced with these new links. Maximum of 500 links per resource type are allowed.
          items:
            $ref: '#/components/schemas/IssueLinkRequest'
      required:
      - links
      - resourceType
    IssueLinksResponse:
      type: object
      properties:
        id:
          type: string
          description: The link ID of the issue
        resourceType:
          type: string
          description: The type of the resource that the issue is linked to
        resourceId:
          type: string
          description: The ID of the resource that the issue is linked to. Either resourceId or resourceReference must be provided, but not both.
        resourceReference:
          type: string
          description: The reference of the resource that the issue is linked to. Either resourceId or resourceReference must be provided, but not both.
        description:
          type: string
        properties:
          type: object
          additionalProperties:
            type: string
          description: Additional properties for the link
        createdBy:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedBy:
          type: string
        updatedAt:
          type: string
          format: date-time
        deleted:
          type: boolean
          description: Indicates if the issue link is deleted. Only included in snapshot and changes APIs.
      required:
      - createdAt
      - createdBy
      - id
      - resourceType
      - updatedAt
      - updatedBy
  securitySchemes:
    bearerAuth:
      type: http
      description: 'Trimble Identity JWT bearer token. Pass as ''Authorization: Bearer {token}''.'
      scheme: bearer
      bearerFormat: JWT