RUAL Documentation

GET /blueprintfields/{guid}

Get a specific blueprint field by its GUID

Get a specific blueprint field by its GUID
Key Type Example Description
guid required string
"example-string"
Blueprint field GUID
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_email", "type": "string", "description": "User's email address", "blueprint_guid": "example-string", "required": false, "default_value": "example-value", "validation_rules": { "min_length": 5, "max_length": 100, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$" }, "metadata": { "ui_component": "text-input", "placeholder": "Enter your email" } }
{ "error": "INVALID_ACCESS_TOKEN", "code": 401 }
Status Error Code Description
401 INVALID_ACCESS_TOKEN Authentication required or invalid token
404 ERROR Blueprint field not found
Permission Description
Bearer token Access token required via Authorization header, x-authtoken, x-token, query param, or cookie
blueprintfields_view Required scope: blueprintfields_view

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