Documentation
Product GuideREST API ReferenceMCP Server for AI AgentsWebhooks & EventsIntegrations
READ

get_baseline

Fetches one baseline by id with the records it holds, each by family, key, title, the version pinned and whether it is still locked or was unlocked by a change request.

Read one baseline in full. Beside the baseline's own fields (its kind, status, version, the clocks of the freeze and the signature) the answer carries items: every record the baseline holds, with artefact_type and artefact_id, the reference and title as they read when added, the version and revision_id pinned by the freeze, frozen_at, locked, and, once a change request released it, unlocked_at and unlocked_by_change_request_id. Use it to know which records a change request must name before it can unlock them, and which are already free. A client guest's token reads a frozen baseline the same way and never a draft.

Requires ability

baseline:view

The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.

Runs the same actions as

GET/v1/baselines/{baseline}GET/v1/baselines/{baseline}/revisionsGET/v1/baselines/{baseline}/revisions/{revision}

The REST endpoint and this tool share one action, so validation, permissions and events are identical.

Annotations

Read-only

It reads and never changes anything.

Arguments

baseline_id*string

UUID of the baseline to fetch.

What it returns

{  "data": {    "id": "6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d",    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",    "name": "v1.0 scope",    "kind": "scope",    "description": "<p>Everything the client signed for the first release.</p>",    "status": "approved",    "frozen": true,    "locks_items": true,    "version": 1,    "approved_at": "2026-10-27T15:40:00+00:00",    "approved_revision_id": "0e1f2a3b-4c5d-4e6f-8a7b-9c0d1e2f3a4b",    "frozen_at": "2026-10-27T15:40:00+00:00",    "frozen_by": "3f8a1c2e-7b4d-4e5f-9a6b-1c2d3e4f5a6b",    "signed_off_at": null,    "items": [      {        "id": "b1c2d3e4-f5a6-4b7c-8d9e-0f1a2b3c4d5e",        "baseline_id": "6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d",        "artefact_type": "requirement",        "artefact_id": "a8b9c0d1-e2f3-4a4b-9c5d-6e7f8a9b0c13",        "reference": "CRM-FR-12",        "title": "Password reset by email",        "version": 2,        "revision_id": "1f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c",        "frozen_at": "2026-10-27T15:40:00+00:00",        "locked": false,        "unlocked_at": "2026-10-29T11:05:00+00:00",        "unlocked_by_change_request_id": "c7d8e9f0-a1b2-4c3d-8e4f-5a6b7c8d9e0f",        "position": 0      },      {        "id": "c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f",        "baseline_id": "6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d",        "artefact_type": "business-rule",        "artefact_id": "d4e5f6a7-b8c9-4d0e-8f1a-2b3c4d5e6f70",        "reference": "CRM-BR-7",        "title": "One voucher per order",        "version": 1,        "revision_id": "2a3b4c5d-6e7f-4a8b-9c0d-1e2f3a4b5c6d",        "frozen_at": "2026-10-27T15:40:00+00:00",        "locked": true,        "unlocked_at": null,        "unlocked_by_change_request_id": null,        "position": 1      }    ],    "position": 0,    "created_at": "2026-10-27T09:00:00+00:00",    "updated_at": "2026-10-29T11:05:00+00:00"  }}

How it fails

RESOURCE_NOT_FOUND

unknown baseline_id, a baseline outside the token's scope, or a draft read by a client guest's token.

TOKEN_MISSING_ABILITY

token lacks baseline:view.

Related

list_baselinesthe project's baselines.raise_change_requestthe way a locked record is unlocked.list_revisionsthe versions of the baseline itself, and of the records it pinned.Baselines APIthe same record over REST.

How is this guide?

Last updated on