Groups
11 routes. Paths are relative to https://api.intersink.com/v1. This group belongs to a feature in beta.
- GET/groupsGroups of the channel (?q=, ?mine=1, ?invited=1 for your open invitations, ?page=)
- POST/groupsCreate a group: { title, description?, privacy: public|private, place? }
- GET/groups/{id}A group, with your membership
- PATCH/groups/{id}Edit a group (owner or admins)
- DELETE/groups/{id}Delete a group (owner; archived, posts kept)
- POST/groups/{id}/invitesInvite a profile of this channel: { profile_id } (members of a public group; admins of a private one)
- POST/groups/{id}/joinJoin (public: at once; private: asks the admins) or accept an invitation
- GET/groups/{id}/membersMembers (admins may ask ?status=pending|banned|invited)
- PATCH/groups/{id}/members/{profileId}Approve, ban or unban ({status}); make admin or member, or hand over ownership ({role})
- DELETE/groups/{id}/members/meLeave a group, cancel a join request or decline an invitation
- GET/groups/{id}/postsThe group's posts, newest first (members only for private groups)
Groups of the channel (?q=, ?mine=1, ?invited=1 for your open invitations, ?page=)
GET/groups
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| x-ref | string, header |
Response
200. The payload in data is not described in the spec yet.
Create a group: { title, description?, privacy: public|private, place? }
POST/groups
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| x-ref | string, header |
Response
201. The payload in data is not described in the spec yet.
A group, with your membership
GET/groups/{id}
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path | |
| active_profile_idrequired | string, query | |
| x-ref | string, header |
Response
200. The payload in data is not described in the spec yet.
Edit a group (owner or admins)
PATCH/groups/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path | |
| x-ref | string, header |
Response
200. The payload in data is not described in the spec yet.
Delete a group (owner; archived, posts kept)
DELETE/groups/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path | |
| active_profile_idrequired | string, query | |
| x-ref | string, header |
Response
200. The payload in data is not described in the spec yet.
Invite a profile of this channel: { profile_id } (members of a public group; admins of a private one)
POST/groups/{id}/invites
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path | |
| x-ref | string, header |
Response
201. The payload in data is not described in the spec yet.
Join (public: at once; private: asks the admins) or accept an invitation
POST/groups/{id}/join
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path | |
| active_profile_idrequired | string, query | |
| x-ref | string, header |
Response
201. The payload in data is not described in the spec yet.
Members (admins may ask ?status=pending|banned|invited)
GET/groups/{id}/members
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path | |
| x-ref | string, header |
Response
200. The payload in data is not described in the spec yet.
Approve, ban or unban ({status}); make admin or member, or hand over ownership ({role})
PATCH/groups/{id}/members/{profileId}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path | |
| profileIdrequired | string, path | |
| x-ref | string, header |
Response
200. The payload in data is of type object.
Leave a group, cancel a join request or decline an invitation
DELETE/groups/{id}/members/me
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path | |
| active_profile_idrequired | string, query | |
| x-ref | string, header |
Response
200. The payload in data is not described in the spec yet.
The group's posts, newest first (members only for private groups)
GET/groups/{id}/posts
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path | |
| x-ref | string, header |
Response
200. data is object[].