Voog Platform API

The Voog Platform API selects an account by UUID instead of the site's domain. It remains available when the site's domain has expired, redirects elsewhere, or is no longer configured in DNS.

The production base URL is https://platform-api.voog.com/v1/accounts/:account_uuid.

Account UUID and API token

Find your site's account UUID in the Voog admin interface under "Site settings", in the "Account ID" field. Use this value as :account_uuid in Platform API URLs.

Generate a personal API token under "Account" -> "My profile", as described in the API authentication section.

Base URL and authentication

Replace /admin/api in a supported site-host API path with /v1/accounts/:account_uuid and use platform-api.voog.com as the host:

GET https://platform-api.voog.com/v1/accounts/6f0f7c1e-6a9f-4f3b-9a51-2f4d7c0e8b11/pages
Authorization: Bearer <token>

Every request requires a personal or scoped token belonging to that account. Cookies, CMS sessions and the api_token request parameter do not authenticate Platform API requests. Endpoints that allow anonymous requests on site hosts still require a token on the Platform API. Existing token scopes and subscription restrictions continue to apply.

Platform API responses include Cache-Control: no-store. Missing tokens return 401 Unauthorized with WWW-Authenticate: Bearer realm="Voog API". An unknown, deleted or malformed account UUID returns 404 Not Found with error_code: account_not_found.

Public URLs and domain context

API navigation links use the Platform API host and account prefix. Public site links use the primary usable domain, or a domain selected with Voog-Domain:

Voog-Domain: www.example.org

The domain must belong to the account, be active or disabled, and not be a permanent redirect. An invalid header returns 422 Unprocessable Entity with error_code: invalid_domain_context. Without a usable domain, public site URLs are null; ordinary CMS reads and writes still work. Omit the header when managing an account that has no usable domain.