---
title: "Read the brand canon and its history"
method: GET
path: "/projects/{id}/canon"
tags: ["Projects"]
---

# Read the brand canon and its history

`GET /projects/{id}/canon`

## Request

- Base URL: `https://api.epovest.com/v1`
- URL: `https://api.epovest.com/v1/projects/{id}/canon`
- Auth: HTTP bearer

`canon` is the current wording and `canon_version` its number. `history` carries every
version, newest first, each with the fields it touched, before and after: read it to
RE-PROPAGATE a revision, since the logbook says which keys moved and when, and this says what
they moved from and to.

## Response `200`

The canon of the project and the history of its revisions.

- object
  - `project_id` string, uuid, required
  - `project` string, required
  - `canon` Canon, required: The brand identity sheet: the text every publication reuses as is, so all mentions tell the same entity. It lives in ONE language per project, its canonical language, and the facts are language-NEUTRAL and identical everywhere.
    - `one_liner` string, nullable, required
    - `short` string, nullable, required
    - `long` string, nullable, required
    - `category` string, nullable, required
    - `language` string, nullable, required: The canonical language, a short code like `en` or `pt-br`. Null when never declared.
    - `perks` string[], required: The ordered list of distinctive claims, written in the canonical language, meant to be hammered so the engines bring them up on their own: facts that hold and can be corroborated.
    - `website` string, nullable, required: The canonical address that identifies the entity, ONE URL only. A bare domain completes to https, and a trailing slash is dropped.
    - `legal_name` string, nullable, required: The registered name of the company that operates the brand, with its jurisdiction when it is stated: the name the AIs cross-read to anchor the entity.
    - `address` string, nullable, required
    - `phone` string, nullable, required
    - `whatsapp` string, nullable, required
    - `email` string, nullable, required
  - `canon_version` integer, nullable, required: The number of the current version, null when the canon was never posted.
  - `history` CanonVersion[], required
    - `version` integer, required
    - `author` string, nullable, required
    - `created_at` string, date-time, required
    - `initial` boolean, required: True on version 1, which has nothing before it.
    - `changes` object[], required: One entry per field that version touched, with the raw values: `perks` comes back as its ordered list and `language` as its short code. `before` is the wording the version replaced, which is the string to find on a page that still carries it.
      - `field` string, required
      - `before` unknown, required
      - `after` unknown, required

## Other responses

- `401`: `unauthenticated`: missing, unknown or revoked key.
- `403`: `insufficient_scope`: the credential may not do this, either because the key lacks the scope, or, on a one-click connection, because the person lacks the role the action needs (manager, or owner to start, pause and top up). On that path, read it as "this person may not do this" and tell them which role the action needs.
- `404`: `not_found`: unknown for this account.
- `429`: `rate_limited`: 120 requests per minute per credential, sliding window. Retry after `Retry-After` seconds.

---

[API](https://skmtc.dev/epovest/apis/epovest-api.md) · [All operations](https://skmtc.dev/epovest/apis/epovest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/epovest/apis/epovest-api/revisions/7a78ee27ecbb?raw)
