# Guidelines

> The Guidelines operations of the Hub REST API (2 operations).

URL: https://docs.synap.live/docs/reference/hub-api/guidelines · Generated from Synap-core/backend@c31e261ab (main)

Paths are relative to `/api/hub` on a pod.

## GET /guidelines

Standing guidelines for a kind of blocked work

Returns the approved guidelines scoped to one `workKind` (a BLOCKED_REASONS token) in the caller's lens. Call it BEFORE handing a slot to the human: a guideline may say how to proceed without one. Informational only — it never changes governance and never retires a slot.

Parameters:

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `workKind` | query | "credential" \| "permission" \| "capability" \| "policy" \| "decision" \| "physical" |  |  |
| `sourceKind` | query | string |  |  |
| `entityKind` | query | string |  |  |
| `workspaceId` | query | string |  |  |

Responses:

- `200`: Matching guidelines (possibly none). A workKind-only call returns `{workKind, guidelines:[{id,text}]}`; a data-type call returns `{guidelines:[{id,version,text,scopeKind,scopeRef}]}` for the requested rungs only.
- `400`: Bad request
- `403`: Forbidden
- `500`: Internal error

## GET /guidelines/{id}/history

Version history of one guideline

Every version of the guideline, newest first, revoked versions included. Visible to the owner of a pod-wide guideline, or to a member of the guideline's workspace.

Parameters:

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `id` | path | string | yes |  |

Responses:

- `200`: Versions, newest first
- `403`: Forbidden
- `404`: Not found
- `500`: Internal error