Call the REST API

Fetch rules, check drafts and add rules from your own code.

The REST API lives at /api/v1. Send JSON with your key in the Authorization header.

  • GET /api/v1/brands: the brands in your workspace.
  • GET /api/v1/brands/{slug}: the whole brand system.
  • PATCH /api/v1/brands/{slug}: change one section.
  • POST /api/v1/brands/{slug}/rules: add a rule.
  • POST /api/v1/check: check copy, a design or colours.
  • POST /api/v1/ask: a short answer about the brand.