Get Aggregate

Retrieve the details of a specific sub-tenant (aggregate) by its ID.

---

Endpoint

GET /api/v3/aggregates/{id}

---

Path Parameters

Parameter	Type	Description
id	string	Aggregate's tenant ID

Query Parameters

Parameter	Type	Description
include	string	Comma-separated list of extra fields: api_key

---

Response

Success Response (200 OK)

{
  "data": {
    "id": 42,
    "slug": "my-bookstore",
    "name": "My Bookstore",
    "final_domain": "mybookstore.publica.la",
    "lang": "en",
    "timezone": "America/New_York",
    "support_email": "[email protected]",
    "primary_color": "#336699",
    "secondary_color": "#FF6600",
    "logo_url": "https://example.com/logo.png",
    "icon_url": "https://example.com/icon.png",
    "disable_selling": false,
    "landing_enabled": true,
    "external_auth": {
      "enabled": true,
      "issuer": "my-platform",
      "redirect_url": "https://my-platform.com/auth-error",
      "login_url": null,
      "logout_url": null,
      "home_url": null,
      "account_url": null
    },
    "created_at": "2026-03-24T15:30:00+00:00"
  }
}

Auth token key is write-only

The external_auth object reports the configured auth token (SSO) fields and an enabled flag, but never the key. Configure the key through create or update.

---

Examples

Get by ID

curl -X GET "https://yourstore.publica.la/api/v3/aggregates/42" \
  -H "X-User-Token: your-api-token" \
  -H "Accept: application/json"

Get with API Key

curl -X GET "https://yourstore.publica.la/api/v3/aggregates/42?include=api_key" \
  -H "X-User-Token: your-api-token" \
  -H "Accept: application/json"

---

Error Handling

Not Found (404)

Returned when the aggregate does not exist or does not belong to your store:

{
  "message": "Not found."
}

Tenant Isolation

You can only retrieve aggregates that belong to your store. Attempting to access another aggregator's tenant returns a 404, not a 403, to avoid leaking information about other tenants.

Authentication Errors (401)

{
  "message": "Unauthenticated."
}

Authorization Errors (403)

{
  "message": "Tenant does not have aggregation capabilities."
}

---

See Also

• List Aggregates - List all aggregates
• Update Aggregate - Modify configuration
• Overview - API overview