search

vrchatapi / vrchatapi.github.io

✨ VRChat API Documentation - A Community-Driven API documentation project.
https://vrchatapi.github.io
MIT License
218 stars 43 forks source link

Document /groups/ID/posts #143

Open Protected opened 2 months ago

Protected commented 2 months ago

Ever since multiple posts/announcements per group became possible, the /groups/ID/announcement endpoint has been insufficient. The website uses /groups/ID/posts to retrieve the post history of a group.

Query parameters:

n: Amount of results (like for group members). Seems to default to 5. The website issues multiple calls to the endpoint as you scroll down. offset: Which result to return from, defaulting to 0.

Results appear sorted by reverse creation date by default.

Returns:

{
    "total": AMOUNT,
    "posts": [GroupAnnouncement]
}

Where AMOUNT is the total amount of existing posts, not the amount of returned posts.

The GroupAnnouncement object is outdated in the website. The following fields are missing (returned equally by both endpoints):

editorId: string visibility: string (defaults to "group", there's presumably some value for public posts) roleIds: [string] (assumed)

Protected commented 2 months ago

Oops, looks like someone already mentioned this in https://github.com/vrchatapi/specification/issues/198

Tresvian commented 2 months ago

I'm working on it, https://github.com/vrchatapi/specification/pull/315