Accounts

This endpoint is available only through the Platform API. It has no site-host /admin/api equivalent. See the Platform API guide for the base URL and authentication.

Summary of account endpoints

GET /v1/accounts/:account_uuid - get data for a single account.

The account object

Read-only attributes

uuid - canonical account UUID.
title - first language's site title, falling back to the site's configured name.
primary_domain - primary domain in ASCII form, or null when not configured.
primary_domain_utf8 - primary domain in Unicode form, or null when not configured.
public_url - base URL selected by the domain context, or null without a usable domain. Does not include a trailing slash.

Get data for a single account

GET /v1/accounts/:account_uuid

Returns the account object. Scoped tokens require account:show. The Voog-Domain header affects public_url, not the primary domain fields.

Example response

Status: 200 OK

{
  "uuid": "6f0f7c1e-6a9f-4f3b-9a51-2f4d7c0e8b11",
  "title": "My site",
  "primary_domain": "helloworld.voog.co",
  "primary_domain_utf8": "helloworld.voog.co",
  "public_url": "https://helloworld.voog.co"
}