Brand
Macros
List Macros

List Macros

GET endpoint for /brand/macros/list-macros in brand category

Overview

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

Parameters

offset (query)

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

limit (query)

  • Type: string
  • Required: Yes
  • 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

{
  "type": "object",
  "properties": {
    "macros": {
      "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": [
    "macros",
    "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"
      }
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "details"
  ]
}

401

Unauthorized

404

Not Found

500

Internal Server Error

Example Usage

curl -X GET \
  http://localhost:9000/brand/macros/list-macros \
  -H "Content-Type: application/json" \

Interactive Testing

You can test this endpoint interactively in the Swagger UI (opens in a new tab).

Get Recent ActivityList User Macros