Skip to main content

​
Endpoint

GET /domains/{domain_id}
Returns a single Domain object.

​
Path parameters

​
domain_id
string
required
ObjectId string of the domain. Returns 400 if the value is not a valid ObjectId format.

​
Response

​
id
string
required
ObjectId string uniquely identifying the domain.
​
name
string
required
Display name of the domain.
​
color
string
required
CSS color associated with the domain (e.g., "#3B82F6" or "blue").
​
image
string
URL to the domain’s banner or representative image. Empty string if not set.
​
icon
string
URL to the domain’s icon image. Empty string if not set.
​
subdomains
string[]
required
Ordered list of subdomain names that belong to this domain.

​
Errors

StatusCondition
400domain_id is not a valid ObjectId format
404No domain with the given ID exists

​
Examples

curl --request GET \
  --url 'http://localhost:8080/domains/64a1f2b3c4d5e6f7a8b9c0a1'

​
Sample response

200
{
  "id": "64a1f2b3c4d5e6f7a8b9c0a1",
  "name": "Tourism flows",
  "color": "#3B82F6",
  "image": "https://cdn.example.com/domains/tourism-flows.jpg",
  "icon": "https://cdn.example.com/icons/tourism-flows.svg",
  "subdomains": ["Visitor volume", "Visitor spending", "Visitor origin"]
}

Build docs developers (and LLMs) love

Get started for freeTalk to us