---
title: "Start gtm workspace link"
method: POST
path: "/api/gtm-connections/start-link"
tags: ["gtm_connections"]
---

# Start gtm workspace link

`POST /api/gtm-connections/start-link`

## Request

- Base URL: `https://beta.getsales.io/id/v1`
- URL: `https://beta.getsales.io/id/v1/api/gtm-connections/start-link`
- Auth: HTTP bearer and API key in header `Team-SID`

Start connecting the person's own gtm-api workspace: answers the consent URL to open and the state the browser brings back (valid 15 minutes). Nothing is written until complete_gtm_connection_link. The managed workspace needs no link: it exists on demand. 501 while the gtm client is unregistered on this plane.

Contract:
- MCP tool `start_gtm_connection_link`, registry package `mcp.id/gtm_connections`, mount `id.identity`.
- Operation `action`, response envelope `action`.
- Flags: none.

## Response `200`

`action` success envelope.

- StartGtmConnectionLinkResponse
  - `success` true, required
  - `operation` 'action', required
  - `action` string, required: kebab-case verb; matches the route segment.
  - `item` unknown, required
  - `result` object, required
    - `authorize_url` string, required: The gtm-api consent screen to open in a browser.
    - `state` string, required: Hand it back verbatim to complete_gtm_connection_link.
    - `expires_in` integer, required: Seconds the state stays valid.
  - `meta` object, required
    - `trace_id` string, required: UUID v7; same 128-bit value as the X-Trace-Id header.
    - `span_id` string, required: 16 hex chars, root span of this request.
    - `timestamp` string, required: ISO 8601 UTC (Y-m-dTH:i:sZ), response time.
    - `duration_ms` integer, required: Server-side wall clock.
    - `team_sid` string, nullable: The team this call ran in (the token team, or the team_sid override). Null when unauthenticated; absent from pre-2026-08-20 backends.
    - `actor_type` string, nullable: user | agent | api_key | system. Null when unauthenticated; absent from pre-2026-08-20 backends.

## Other responses

- `4XX`: MCP error envelope. `error.code` is one of validation_failed, nothing_to_update, not_found, relation_not_found, invalid_transition, limit_exceeded, payment_required, duplicate_rejected, conflict, delete_blocked, unauthorized, forbidden, rate_limited, not_implemented.
- `5XX`: MCP error envelope with `error.code` internal_error or service_unavailable.

---

[API](https://skmtc.dev/getsales/apis/getsales-public-contract-gs-service-id.md) - [All operations](https://skmtc.dev/getsales/apis/getsales-public-contract-gs-service-id/llms.txt) - [OpenAPI document](https://skmtc.dev/getsales/apis/getsales-public-contract-gs-service-id/revisions/95e48541fe85?raw)