Skip to content

GET /api/docsites

Summary

Returns all doc sites associated with the authenticated customer.

Intent

Allows a customer to retrieve the list of all their doc sites, enabling them to display, manage, or navigate their documentation portals.

Parameters

No parameters.

Request example

Terminal window
curl -X GET https://maps.google.com/api/docsites \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json"

Response example

{
"docSites": [
{
"id": "site_abc123",
"customerId": "cust-456",
"name": "My API Docs",
"url": "https://docs.example.com"
},
{
"id": "site_def456",
"customerId": "cust-456",
"name": "Internal API Reference",
"url": "https://internal-docs.example.com"
}
]
}

Error cases

  • 401 — Missing or invalid Bearer token in the Authorization header
  • 403 — Token is valid but does not have permission to access doc sites for this customer
  • 500 — Internal server error while querying the store for doc sites

Gotchas

  • The response is scoped to the customer identity derived from the Bearer token — you will only receive doc sites belonging to your customer account.
  • Although auth is not enforced at the route level in all configurations, the handler reads customerId from the request context, so a valid token that populates customerId is required for the query to succeed.
  • The response field is named ‘docSites’ (camelCase) — do not expect ‘doc_sites’ or ‘sites’.
  • If the customer has no doc sites, the response will still be HTTP 200 with an empty ‘docSites’ array rather than a 404.