Community groups

List community groups

Returns the community groups owned by the calling user. Community groups are user-curated collections of communities used to organise dashboard navigation, so they are scoped to a single user and are only available to personal API keys. Organization API keys are rejected with 403 because a group may span communities across multiple organizations and is not meaningful at the organization level.

get/api/v1/communities/groups

Request

  • Base URL: https://api.talkfurther.com
  • URL: https://api.talkfurther.com/api/v1/communities/groups
  • Auth: one of:
    • API key in header Authorization
    • API key in header Authorization

Query parameters

community_idnumber[]

Multiple values may be separated by commas.

community_namestring[]

Multiple values may be separated by commas.

namestring[]

Multiple values may be separated by commas.

orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

searchstring

A search term.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Changes

No recorded changes to this operation across all 1 revision of this API.