Skip to main content
GET
/
clients
/
hierarchies
/
{hierarchyId}
Retrieve a client hierarchy
curl --request GET \
  --url https://api.gospott.com/clients/hierarchies/{hierarchyId} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "client": {
    "id": "<string>"
  },
  "children": [
    {
      "client": {
        "id": "<string>"
      },
      "children": "<array>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.spott.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.

Path Parameters

​
hierarchyId
string
required

Response

Successfully retrieved client hierarchy

​
id
string
required
Minimum string length: 1
​
client
object
required
​
children
object[]
required