API ReferenceapiplatformGET /v1/admin/brands

GET /v1/admin/brands

Service: platform · operationId: (none)

List all brands (admin only)

Required scopes

(no scope declared — review service config)

Responses

200 Brand list

{
  "type": "object",
  "properties": {
    "brands": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "slug": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "inactive",
              "draft"
            ]
          },
          "compliance_regime": {
            "type": "string",
            "enum": [
              "none",
              "hipaa",
              "gdpr",
              "arl_5_7"
            ]
          },
          "config": {
            "type": "object",
            "additionalProperties": {}
          }
        },
        "required": [
          "id",
          "slug",
          "name",
          "status",
          "compliance_regime",
          "config"
        ]
      }
    }
  },
  "required": [
    "brands"
  ]
}

403 Forbidden — missing platform:admin scope

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

Example

curl -X GET https://platform.platform.loop.health/v1/admin/brands \
  -H "Authorization: Bearer $ACCESS_TOKEN"