Brand
Macros
Get Macro

Get Macro

Fetch a macro with enhanced data and active version conditions.

Overview

  • Method: GET
  • Path: /brand/macros/get-macro/<id>
  • Tags: brand

Parameters

id (path)

  • Type: string
  • Required: Yes
  • Description: id parameter

Request Body

No request body required.

Responses

200

Successful response

Content Type: application/json

{
  "macro": "string",
  "name": "string",
  "type": "string",
  "visibility": "string",
  "order": 123,
  "data": {
    "key": {}
  },
  "maxRuns": 123,
  "label": "string",
  "style": "string",
  "requiredRole": "string",
  "requiresMacroId": "string",
  "onCompleteId": "string",
  "previewMessage": "string",
  "runStats": 123,
  "successful_runs": 123,
  "failed_runs": 123,
  "skipped_runs": 123,
  "last_run": "2024-01-01T00:00:00.000Z",
  "success_rate": 123
}

400

Bad Request

Content Type: application/json

{
  "error": "string",
  "details": [
    {}
  ]
}

401

Unauthorized

404

Not Found

500

Internal Server Error

Example Usage

curl -X GET \
  https://api.pillexa.com/brand/macros/get-macro/<id> \
  -H "Content-Type: application/json" \
Archive MacroGet Macros For State