API ReferenceapiplatformGET /v1/admin/brands/{id}

GET /v1/admin/brands/\{id\}

Service: platform · operationId: (none)

Get a single brand by ID (admin only)

Required scopes

(no scope declared — review service config)

Path parameters

  • id (string) required

Responses

200 Brand detail

{
  "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"
  ]
}

403 Forbidden — missing platform:admin scope

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

404 Brand not found

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

Example

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