Communities

Return Communities for an account

Return a list of communities accessible to the caller. Supports filtering by community ID or name, and bulk retrieval of community data.

get/api/v1/communities

Request

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

Query parameters

idinteger[]

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.