For AI agents: a machine-readable documentation index for this API is available at /llms.txt. Every page is also available as Markdown: append ".md" to the URL or send an "Accept: text/markdown" request header.

Check a brand's domain

Returns the brand's custom domain and how far its setup is: status (ownership_verification_required, dns_configuration_required, certificate_pending or active) and the DNS records to add, with the same dns_provider, dns_zone and dns_guide as setBrandDomain. It re-checks with the hosting provider first and stores what it finds, like opening the domain in the app; provider_unavailable is true when the provider could not be reached and the stored values are returned. 404 when the brand has no domain. Needs brands:domains.

Do this with AI

I want to check a brand's domain. Use the Tarkle API. Read the reference for this operation and follow it exactly: https://project-03b42162.restlessdocs.com/endpoint/getbranddomain.md Authenticate with your API key as a Bearer token in the Authorization header. Then make the request for me and tell me what came back.

Paste this into Claude, Cursor, or any AI assistant and it will do it for you.