Skip to main content Module api Copy item path Source AboutInfo About metadata. AboutResponse Response payload for about.json. AddMembersOutcome Result of a bulk add-members call. AdminReport Raw report payload, distilled from /admin/reports/{id}.json. Only the
fields dsc analytics actually reads are deserialised — Discourse
emits a lot more (axis labels, chart modes, descriptions) that we don’t
care about. ApiKeySummary One row from /admin/api/keys.json. CategoriesResponse Response payload for categories.json. CategoryDefinition The full definition of a category (from /categories.json?show_permissions=true). CategoryDefinitionList Category definition listing. CategoryDefinitionsResponse Response payload for /categories.json?show_permissions=true. CategoryInfo Category metadata. CategoryList Category listing. CategoryResponse Response payload for category JSON. CreateCategoryResponse Response payload for creating a category. CreateGroupResponse Response payload for creating a group. CreatePostResponse Response payload for creating a post/topic. CreatedApiKey Response from POST /admin/api/keys.json — includes the full secret key. CreatedCategory Created category payload. CreatedGroup Created group payload. CustomEmoji DiscourseClient HTTP client for the Discourse API. GroupDetail Group details with settings used for deep-copy. GroupDetailResponse Response payload for group detail. GroupMember GroupMembersResponse GroupPermission One group’s permission on a category, as returned in group_permissions.
permission_type: 1 = full, 2 = create_post, 3 = readonly. GroupSummary Group summary. GroupsResponse Response payload for groups.json. InviteResult Distilled successful response from POST /invites.json. PmTopicSummary Distilled row from /topics/private-messages-*.json. Post Topic post. PostEditOptions Side-effect controls for a post edit (PUT /posts/{id}.json). The default
is an ordinary edit that bumps the topic and records a revision. PostInfo PostStream Topic post stream. ReportPoint One day-bucket from a flat (non-stacked) report’s data array. SearchHit One result row in a search response — distilled from the topic stanza of
/search.json (which contains far more than we need). SiteInfo Site metadata. SiteResponse Response payload for site.json. SiteSettingDetail A single site setting with its full metadata, as returned by
GET /admin/site_settings.json. TagGroupInfo A tag group as returned by the Discourse admin API. TagInfo TopicList Topic list for a category. TopicResponse Response payload for topic JSON. TopicSummary Topic summary. UploadInfo Distilled fields from /uploads.json — the response carries more (id,
width/height, dominant_color, etc.) but these are the ones every caller
will reach for. UserAction One row from /user_actions.json. Distilled — Discourse returns more
fields than most callers need. UserDetail Distilled /users/.json payload. UserSummary One row from /admin/users/list/.json. VersionInfo