RUAL Documentation

GET /blueprints/{guid}

Get blueprint by GUID or short_id with Redis caching and permission checks

Get blueprint by GUID or short_id with Redis caching and permission checks
Key Type Example Description
guid required string
"example-string"
Blueprint GUID or short_id
Key Type Example Description
production optional boolean
true
Get from production blueprints instead of development
Key Type Example Description
authorization required string
"Bearer access_token"
Access token
{ "_meta": { "guid": "example-string", "entity": 42, "created": 42, "modified": 42, "updated": 42 }, "name": "User Registration Workflow", "description": "Automates user registration with email verification and profile setup", "short_id": "TpQ8K3mN9xVz", "category": "authentication", "tags": [ "user-management", "automation", "email" ], "status": "draft", "version": "1.2.3", "is_published": false, "created_by_user_guid": "example-string", "last_modified_by_user_guid": "example-string" }
{ "error": "INSUFFICIENT_PERMISSIONS" }
Status Error Code Description
401 INSUFFICIENT_PERMISSIONS Insufficient permissions or authentication required
404 ERROR Blueprint not found
Permission Description
Bearer token Access token required via Authorization header, x-authtoken, x-token, query param, or cookie
blueprints_view Required scope: blueprints_view

Back to Blueprints Return to the Blueprints category to view other endpoints All API Categories Browse all available API categories