Skip to content

docs: document GET /groups/:id full schema, list vs detail delta, and subgroup field additions#45

Open
Quazmoz wants to merge 4 commits intogroupme-js:masterfrom
Quazmoz:docs/group-detail-schema
Open

docs: document GET /groups/:id full schema, list vs detail delta, and subgroup field additions#45
Quazmoz wants to merge 4 commits intogroupme-js:masterfrom
Quazmoz:docs/group-detail-schema

Conversation

@Quazmoz
Copy link
Copy Markdown

@Quazmoz Quazmoz commented Mar 19, 2026

What's changed

GET /groups/:id (index.md)

  • Added full response schema table documenting all fields returned by the detail endpoint
  • Added List vs Detail comparison table clarifying which fields are exclusive to the detail view (members, messages metadata) vs the index endpoint
  • Corrected the example response to remove the messages.preview block, which is present on the list endpoint but not returned by the detail endpoint
  • Documented that members[] objects include a membership-scoped id field in the detail view that is absent from the list view

Subgroups (subgroups.md)

  • Added !!! warning noting that id, parent_id, and creator_user_id are returned as integers in subgroup responses, unlike the rest of the API which uses strings
  • Added previously undocumented field message_edit_period (value: 15) to both Index and Show response examples
  • Added last_message_updated_at to the messages object in subgroup responses — this field is present on subgroups but absent from the standard group messages object
  • Added !!! note clarifying the above distinction

How this was verified

All schema changes were verified via live API capture using a working GroupMe MCP server against real group data.

@AlureonTheVirus
Copy link
Copy Markdown
Collaborator

AlureonTheVirus commented Apr 3, 2026 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants