List Macros

Retrieve a paginated list of macros with filtering and archival options.

Overview

• Method: GET
• Path: /brand/macros/list-macros
• Tags: brand

Parameters

offset (query)

• Type: integer
• Required: No
• Description: offset query parameter

limit (query)

• Type: integer
• Required: No
• Description: limit query parameter

filterType (query)

• Type: object
• Required: No
• Description: filterType query parameter

filterChannel (query)

• Type: object
• Required: No
• Description: filterChannel query parameter

status (query)

• Type: string
• Required: No
• Description: status query parameter

q (query)

• Type: string
• Required: No
• Description: q query parameter

showArchived (query)

• Type: string
• Required: Yes
• Description: showArchived query parameter

archivedBy (query)

• Type: string
• Required: No
• Description: archivedBy query parameter

Request Body

No request body required.

Responses

200

Successful response

Content Type: application/json

{
  "macros": "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": [
    {}
  ],
  "message": "string"
}

401

Unauthorized

404

Not Found

500

Internal Server Error

Example Usage

curl -X GET \
  https://api.pillexa.com/brand/macros/list-macros \
  -H "Content-Type: application/json" \