The Brand API reads and changes the brand pages of a workspace, one request at a time. It is part of the Tarkle API at https://tarkle.com/api/v1. Start with the API overview for tokens, workspace keys and rate limits.
What you can do
- List brands. Name, summary, access, links, newest first, 25 at a time. Page with
limitandcursor. - Read one brand. Text, facts, social links, colors, fonts, access, tracking IDs, SEO fields, team and press.
- Get its files. Logos, icon, banner and collection files, each with a short-lived download link.
- Get
brand.md. The brand as one Markdown document, the form AI assistants read best. - Read page views, downloads and requests. For 30 days (default), 90 days or all time.
- Update a brand. Text, links, primary color, access, download approval, draft state and tracking IDs. See Update a brand.
- Handle access requests. List the people who asked to download or view a brand, then approve or reject each one. See Access requests.
Which brands a token reaches
A token belongs to a person and works for every workspace that person can use. You name the workspace on each call with X-Workspace-Key. Inside it, the brand endpoints need the token’s creator to be an owner or admin of that workspace, and the token needs the scope for the call:
| Scope | Allows |
|---|---|
brands:read |
Read brands, their assets, brand.md and analytics |
brands:write |
Update a brand’s text, links, access and settings |
brands:requests |
List download and view requests and approve or reject them |
A token with no scopes can do nothing. A brand in another workspace answers 404 not_found, the same as a brand that does not exist.
The API is for servers. It has no CORS support, so a token in browser code is a leaked token.
What it cannot do yet
- Create or delete brands.
- Upload logos, banners or collection files.
- Set a password or domains.
accessaccepts onlypublicorrestricted; making a brand public removes its password and needsconfirm_public: true. - Change a brand’s slug, secondary color, additional colors, fonts, team members or press.
- Send webhooks for brand events.
Machine-readable description
GET https://tarkle.com/api/v1/openapi.json is an OpenAPI 3.1 file with typed schemas for every brand call. It needs no token.