身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限，因此请为您的密钥赋予所需的最小权限，并通过检查响应来确认，而不是盲目假设。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X GET https://api.zinndigital.com/v1/site-groups/{groupId} \
-H "Authorization: Bearer zdk_live_…"已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
Gated on `sites.view`. 404 rather than 403 for a group in another tenant — a 403 would confirm the row exists.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
groupId (path) | string | 是 | — |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
id | string | 是 | — |
name | string | 是 | Unique per organisation, case-insensitively. Two groups called `Casino` and `CASINO` are a support ticket rather than a feature — nobody can tell them apart in a filter and half… |
colour | string<slate, blue, green, amber, red, purple, teal, pink> | 是 | A chip colour from a closed set, never a free hex value. The dashboard draws these through the design system's contrast-checked tone tokens; a customer-supplied colour would ren… |
notes | string | 是 | The operator's own note. Never published, never shown to anyone else. |
site_count | integer | 是 | — |
created_at | string | 是 | — |
updated_at | string | 是 | — |
此端点可能返回的错误
401 · 403 · 404