Get Macro
GET endpoint for /brand/macros/get-macro in brand category
Overview
- Method: GET
- Path:
/brand/macros/get-macro - Tags: brand
Parameters
No parameters required.
Request Body
No request body required.
Responses
200
Successful response
Content Type: application/json
{
"type": "object",
"properties": {
"macro": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"visibility": {
"type": "string"
},
"order": {
"type": "number"
},
"data": {
"type": "object",
"additionalProperties": true
},
"maxRuns": {
"type": "number"
},
"label": {
"type": "string"
},
"style": {
"type": "string"
},
"requiredRole": {
"type": "string"
},
"requiresMacroId": {
"type": "string"
},
"onCompleteId": {
"type": "string"
},
"previewMessage": {
"type": "string"
},
"runStats": {
"type": "number"
},
"successful_runs": {
"type": "number"
},
"failed_runs": {
"type": "number"
},
"skipped_runs": {
"type": "number"
},
"last_run": {
"type": "string",
"format": "date-time"
},
"success_rate": {
"type": "number"
}
},
"required": [
"macro",
"name",
"visibility",
"order",
"data",
"runStats",
"successful_runs",
"failed_runs",
"skipped_runs",
"success_rate"
]
}400
Bad Request
Content Type: application/json
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"details": {
"type": "array",
"items": {
"type": "object"
}
}
},
"required": [
"error",
"details"
]
}401
Unauthorized
404
Not Found
500
Internal Server Error
Example Usage
curl -X GET \
http://localhost:9000/brand/macros/get-macro \
-H "Content-Type: application/json" \
Interactive Testing
You can test this endpoint interactively in the Swagger UI (opens in a new tab).