Apps API · Blueprints
Blueprints: 5 endpoints
GET /api/v1/blueprints/{blueprint_id}
Get blueprint
Scope: work:blueprint:read · Called with: appToken · operationId: get-blueprint
Required app scope: work:blueprint:read.
Returns a blueprint by ID. Response wrapped in standard envelope.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
blueprint_id |
path | string (uuid) | yes | Blueprint UUID |
include_steps |
query | boolean | Whether to include steps |
Responses
200OK —application/json·DataResponseBlueprintItemBodydefaultError —application/problem+json·D8Error
PUT /api/v1/blueprints/{blueprint_id}/steps
Set blueprint steps
Scope: work:blueprint:write · Called with: appToken · operationId: set-blueprint-steps
Required app scope: work:blueprint:write.
Replaces all blueprint steps. Response wrapped in standard envelope.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
blueprint_id |
path | string (uuid) | yes | Blueprint UUID |
Request body
application/json · SetStepsRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
steps |
array of StepInput |
yes | Replacement blueprint steps |
Responses
200OK —application/json·DataResponseBlueprintItemBodydefaultError —application/problem+json·D8Error
POST /api/v1/blueprints/{blueprint_id}/submit-for-approval
Submit blueprint for approval
Scope: work:blueprint:write · Called with: appToken · operationId: submit-blueprint-for-approval
Required app scope: work:blueprint:write.
Submits the blueprint for approval. Kept for compatibility; generic approvals use /api/v1/approvals.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
blueprint_id |
path | string (uuid) | yes | Blueprint UUID |
Responses
200OK —application/json·DataResponseBlueprintItemBodydefaultError —application/problem+json·D8Error
GET /api/v1/issues/{issue_id}/blueprints
List blueprint versions
Scope: work:blueprint:read · Called with: appToken · operationId: list-blueprint-versions
Required app scope: work:blueprint:read.
Returns blueprint versions for an issue. Response wrapped in standard envelope.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
issue_id |
path | string (uuid) | yes | Issue UUID |
page |
query | integer (int32) | Page number (default: 1) | |
page_size |
query | integer (int32) | Items per page (default: 20, max: 100) | |
order_by |
query | string | Sort expression, e.g. created_at:desc |
Responses
200OK —application/json·PageListResponseBlueprintItemBodydefaultError —application/problem+json·D8Error
POST /api/v1/issues/{issue_id}/blueprints
Create blueprint
Scope: work:blueprint:write · Called with: appToken · operationId: create-blueprint
Required app scope: work:blueprint:write.
Creates a blueprint for an issue. Response wrapped in standard envelope.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
issue_id |
path | string (uuid) | yes | Issue UUID |
Request body
application/json · CreateBlueprintRequestBody
| Field | Type | Required | Description |
|---|---|---|---|
estimated_budget |
object | Estimated budget JSON object | |
notes |
string | Blueprint notes | |
steps |
array of StepInput |
yes | Blueprint steps |
Responses
200OK —application/json·DataResponseBlueprintItemBodydefaultError —application/problem+json·D8Error
