Groups¶

GET /api/statusnet/groups/timeline/(int: id)(string: nickname).json¶

Show a group’s timeline. Similar to other timeline resources.

Query Parameters:
Parameters:	id (int) – ID of the group for which to return results for nickname (string) – handle of the group for which to return results for
	count (int) – number of statuses to try and retrieve since_id (int) – returns statuses with an ID greater than (that is, more recent than) the specified ID max_id (int) – returns statuses with an ID less than (that is, older than) or equal to the specified ID

Example response: a list of status objects

GET /api/statusnet/groups/show/(int: id)(string: nickname).json¶

Show details about the group.

Parameters:	id (int) – ID of the group for which to return results for nickname (string) – handle of the group for which to return results for

Example response: Group object

POST /api/statusnet/groups/join/(int: id)(string: nickname).json¶

Join a group.

Request Headers:
Parameters:	id (int) – ID of the group for which to return results for nickname (string) – handle of the group for which to return results for
	Authorization – username and password or OAuth token to authenticate

Example response: Group object

POST /api/statusnet/groups/leave/(int: id)(string: nickname).json¶

Leave a group.

Request Headers:
Parameters:	id (int) – ID of the group for which to return results for nickname (string) – handle of the group for which to return results for
	Authorization – username and password or OAuth token to authenticate

Example response: Group object

POST /api/statusnet/groups/create.json¶

Create a group.

Form Parameters:
	nickname – name of the new group full_name – (optional) full name associated with the group homepage – (optional) home page URL associated with the group location – (optional) The city or country describing where the group is located. The contents are not normalized or geocoded in any way description – (optional) A description of the group aliases – (optional) aliases that group has
Request Headers:
	Authorization – username and password or OAuth token to authenticate

Example response: Group object

GET /api/statusnet/groups/list_all.json¶

List all local groups.

Query Parameters:
	count (int) – number of groups to try and retrieve

Example response: a list of group objects

GET /api/statusnet/groups/list.json¶

Show the groups which the specified user is a member of.

Query Parameters:
	count (int) – number of groups to try and retrieve user_id (int) – ID of the user for whom to return results for screen_name (str) – handle of the user for whom to return results for

Example response: a list of group objects

GET /api/statusnet/groups/membership/(int: id)(string: nickname).json¶

List the members of the specified group.

Query Parameters:
Parameters:	id (int) – ID of the group for which to return results for nickname (str) – handle of the group for which to return results for
	count (int) – number of users to try and retrieve

Example response: a list of user objects

GET /api/statusnet/groups/is_member.json¶

Show if the specified user is a member of the specified group.

Query Parameters:
	user_id (int) – ID of the user for whom to return results for screen_name (str) – handle of the user for whom to return results for group_id (int) – (optional) ID of the group for which to return results for group_name (str) – (optional) handle of the group for which to return results for

Example response:

{"is_member": true}

GET /api/statusnet/groups/admins/(int: id)(string: nickname).json¶

List the admins of the specified group.

Query Parameters:
Parameters:	id (int) – ID of the group for which to return results for nickname (str) – handle of the group for which to return results for
	count (int) – number of users to try and retrieve

Example response: a list of user objects