Skip to content
AstroWay/api v2.254.12 · docs
all systems operational

Get White-label Config

GET
/whitelabel/config
request.sh
curl -X GET https://api.astroway.info/v1/whitelabel/config \
-H "X-Api-Key: aw_live_..." \
-H "Content-Type: application/json"

Read the authenticated user’s branding overrides (logo, colour palette, font, footer text, custom domain). On first access, defaults are seeded.

fields
string

Comma-separated dotted paths, relative to data, to keep in the response. A path is applied to every element of an array, so planets.name means the name of each planet. Paths that match nothing come back in _fields_unmatched; a list where nothing matches at all is a 400, because an empty object would be a confident wrong answer.

Example
planets.name,planets.longitude
precision
integer
<= 15

Round every non-integer number in the response to this many decimal places. Integers are left alone, because an id is not a measurement. Ecliptic longitudes ship with fourteen decimals by default; 2 is about a tenth of an arcminute.

Example
4

Successful calculation

Media type application/json
object
ok
boolean
data
object
primary_color
string
nullable
secondary_color
string
nullable
font_family
string
nullable
footer_text
nullable
custom_domain
nullable
domain_verified
boolean
nullable
domain_last_checked_at
nullable
logo_storage_key
nullable
updated_at
string
nullable
Example
{
"ok": true,
"data": {
"primary_color": "#d4a84c",
"secondary_color": "#7e6bff",
"font_family": "Inter",
"footer_text": null,
"custom_domain": null,
"domain_verified": false,
"domain_last_checked_at": null,
"logo_storage_key": null,
"updated_at": "2026-05-08T07:00:00Z"
}
}

Validation error

Media type application/json
Example
{
"ok": false,
"error": {
"code": "INVALID_INPUT",
"message": "Validation failed: date: Date must be YYYY-MM-DD",
"details": [
{
"path": "date",
"message": "Date must be YYYY-MM-DD"
}
]
}
}

Missing or invalid API key

Media type application/json
Example
{
"ok": false,
"error": {
"code": "INVALID_API_KEY",
"message": "Invalid API key"
}
}
Was this helpful?