Brand API overviewBeta
What the Tarkle Brand API does, what a token can reach, and what is not available yet in the beta.
Beta. The Brand API is in beta. Fields can still be added to version 1, and any breaking change will ship as a new version (/api/v2) rather than change v1.
What it is
The Brand API lets your own code work with the brand pages in your workspace. It is a JSON API served from the same address as your Tarkle workspace, under /api/v1.
What you can do
List your brands and read one brand in full: text, facts, social links, colors, fonts, access settings, tracking IDs, team and press.
Get a brand's logos, icon, banner and collection files as short-lived download links.
Get a brand's
brand.md, the same markdown file that is included in the brand kit download.Read page views, downloads and requests for a brand.
Update a brand's text, links, primary color, access, download approval, draft state and tracking IDs.
List the people who asked for access and approve or reject their requests.
What it cannot do yet
Create or delete brands.
Upload logos, banners or collection files.
Set or change a brand's password or domains. Setting access to public removes a password.
Send webhooks when something happens on a brand.
The machine-readable description
An OpenAPI 3.1 description of every endpoint is available at /api/v1/openapi.json. It needs no token, so you can import it into tools such as Postman or a code generator.
Next steps
Create a token and make a first call in Brand API quick start.
See every endpoint in Brand API endpoints.