Metadata API
The Metadata API currently provides the same tenant survey metadata list used by report integrations. It requires the ReportsRead scope on the API key. The tenant's effective plan must also enable Report API access, retain the client within External integrations, and pass the active-tenant and subscription checks.
Required Scope
ReportsRead
Available Endpoints
List Surveys
Returns one unpaged array containing all non-deleted surveys for the key's tenant, ordered by name. Active and inactive surveys are both included.
GET /api/integrations/metadata/surveys
Response fields (per survey):
| Field | Type | Description |
|---|---|---|
id |
integer | Unique identifier |
code |
string or null | Survey code, when present |
name |
string or null | Survey name, when present |
description |
string or null | Survey description, when present |
isActive |
boolean | Whether the survey is active |
The endpoint accepts no page, pageSize, status, or survey-id parameter.
Response example:
[
{
"id": 45,
"code": "CSAT-2026",
"name": "Customer Satisfaction",
"description": "Quarterly feedback",
"isActive": true
}
]
Contract Boundary
This endpoint is a tenant survey catalog only. It does not return sections, questions, options, runtime rules, or a full survey definition. A per-survey metadata/definition route is not part of the current contract.
Tenant Isolation
All Metadata API responses are scoped to the tenant associated with the API key.
Notes
- Metadata does not include response rows. To retrieve aggregate response summaries, use the reports endpoint with
ReportsRead. - Full survey definition endpoints are not part of the current integration contract.