ConsistlyAPI
Rules

Retrieve a brand rule

GET
/brand_rules/{id}

Authorization

ApiKey
AuthorizationBearer <token>

Bearer API key. Brand Governance endpoints require brand:read or brand:write (plus narrower writes for specific resources).

In: header

Path Parameters

id*string

Response Body

application/json

application/json

curl -X GET "https://example.com/brand_rules/brand_rule_abc..."
{  "id": "string",  "object": "brand_rule",  "organization": "string",  "name": "string",  "type": "string",  "severity": "low",  "active": true,  "auto_fixable": true,  "pattern": "string",  "replacement": "string",  "created": "2019-08-24T14:15:22Z",  "updated": "2019-08-24T14:15:22Z"}
{  "error": {}}

Replace the brand rule set PUT

Bulk-replace operation: the request body becomes the authoritative rule set for the caller’s organisation. Previously persisted rules absent from the body are deleted. Maximum 50 rules per request.

List brand colour palettes GET

Returns the colour palettes configured for the caller’s organisation, each with its constituent colours inlined. Gradient palettes are exposed separately at /brand_gradients in a later phase.