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
Resolves a user_id or email into one of four outcomes and returns
which outcome occurred via the outcome field. HTTP status mirrors the
outcome: 201 when something was created (added, invited), 200
when no work was needed (already_member, invitation_pending).
Resolution rules:
added: The request targeted auser_idand that user already follows the caller. A group membership is created immediately. The "must follow caller" signal is treated as opt-in, so no invite/accept round trip is required.invited: A new pending invitation was created and an email was sent.invitation_pending: An open invitation for this user or email already exists; the existing invitation is returned unchanged.already_member: The user is already a member; no action is taken.
When invited by email and no user with that email exists, the caller
must have permission to invite new users.
Authentication required.
Path Params
id
string
required
Resource ID or slug
POST
https://api.are.na/v3/groups/{id}/invitations
Result of `POST /v3/groups/{id}/invitations`. Inspect `outcome` to
outcome
GroupMemberInviteOutcome!
Discriminator for the result of `POST /v3/groups/{id}/invitations`.
addedinvitedinvitation_pendingalready_member
user
EmbeddedUser!
The user that this request resolved to, when known. Null only when
EmbeddedUser
EmbeddedUser
Embedded user representation (used when user is nested in other resources)
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
unknown
null
invitation
MembershipInvitation!
The invitation associated with this request, for `invited` and
MembershipInvitation
MembershipInvitation
Pending invitation for a user to join a group.
id
integer!
Unique identifier for the invitation
type
string!
MembershipInvitation
target
EmbeddedGroup!
Embedded group representation (used when group is nested in other resources)
invitee
EmbeddedUser!
User being invited, when available
invitee_email
string | null (email)!
Email address being invited, visible to users who can manage invitations
invited_by
EmbeddedUser!
Embedded user representation (used when user is nested in other resources)
state
string!
pendingaccepteddeclinedrevoked
accepted_at
string | null (date-time)!
When the invitation was accepted
created_at
string (date-time)!
When the invitation was created
updated_at
string (date-time)!
When the invitation was last updated
_links
object!
Links for navigation. Empty today because no public endpoint
unknown
null