All Resources
GET
Get a group
/v3/groups/{id}
GET
Get group contents
/v3/groups/{id}/contents
GET
Get group followers
/v3/groups/{id}/followers
GET
List pending group invitations
/v3/groups/{id}/invitations
GET
Get group invite
/v3/groups/{id}/invite
GET
Get group members
/v3/groups/{id}/members
POST
Create a group
/v3/groups
POST
Add or invite a group member
/v3/groups/{id}/invitations
POST
Create or reuse group invite
/v3/groups/{id}/invite
POST
Join a group
/v3/groups/{id}/members
PUT
Update a group
/v3/groups/{id}
DELETE
Revoke a pending group invitation
/v3/groups/{id}/invitations/{invitation_id}
DELETE
Remove a group member
/v3/groups/{id}/members/{user_id}
DELETE
Delete a group
/v3/groups/{id}
DELETE
Delete group invite
/v3/groups/{id}/invite
DELETE
Leave a group
/v3/groups/{id}/members/me
Adds the authenticated user to the group as a member. Requires a valid
group invite token from GET/POST /v3/groups/{id}/invite; the token is
the authorization to join, so it may grant access to a private group.
Idempotent: if the authenticated user is already the owner or a member,
the endpoint returns 200 with that user's group-member entry.
Authentication required.
Path Params
id
string
required
Resource ID or slug
Body Params
invite_token
string
The group's invite code, authorizing the authenticated user to join
POST
https://api.are.na/v3/groups/{id}/members
Group member entry, including the group owner and any collaborators
id
integer!
Unique identifier for the user
type
string!
User type
User
name
string!
User's display name
slug
string!
URL-safe identifier (use this in API paths)
avatar
string | null (uri)!
URL to user's avatar image
initials
string!
User's initials
role
string!
The user's role on the group. `owner` is the group's creator;
ownermember