Appendix

This appendix collects cross-cutting reference material that does not belong to a single endpoint: Postman/collection variables, product glossary, pagination shape, and how Platform admin APIs differ from chat SDK APIs.

Use it when wiring environments, naming things in your integration, or checking whether a call should use a client token or a chat user token.

These reusable variables appear throughout this documentation and the underlying Postman collection. Prefer setting them once per environment instead of hardcoding values in every request.

After Auth → Login Client, scripts typically populate accessToken, refreshToken, and clientId. After User → Login, they populate userAccessToken.

Modern list endpoints return items under data.list plus a data.pagination object. Query parameters such as page and limit are documented per endpoint when supported; some moderation/settings lists use server defaults with no required query string.

{
  "list": [],
  "pagination": {
    "currentPage": 1,
    "totalCount": 42,
    "hasNextPage": true,
    "hasPreviousPage": false,
    "pageSize": 10
  }
}

• currentPage is 1-based.
• Use hasNextPage / hasPreviousPage to drive pager UI without recomputing totals locally.
• pageSize reflects the page that was returned (may differ from your requested limit if capped).

• Resource ids are MongoDB ObjectIds (24 hex characters) exposed as _id strings.
• Timestamps are ISO-8601 UTC strings (createdAt, updatedAt, mutedUntil, etc.).
• Treat mute as active only while mutedUntil is in the future.
• Nullables such as resolutionNote or groupImage may be null when unset — do not assume empty string.

Mixing tokens is a common cause of 401/403. If a Platform call fails auth, confirm you are not accidentally sending the chat user token.

• Authentication — token types and login flow.
• Headers — Authorization, Content-Type, tenant headers.
• Sample requests / responses — request style and envelope parsing.
• Error codes / Status codes — failure handling.