Get a list of groups

Get a list of groups

get_groups(
  authority = NULL,
  document_uri = NULL,
  expand = NULL,
  api_path = get_hs_host(),
  api_key = NULL
)

Source

https://h.readthedocs.io/en/latest/api-reference/v1/

Arguments

authority

Filter returned groups to this authority. Default: main instance authority.

document_uri

Document URI - only retrieve public (i.e. non-private) groups that apply to a given document URI.

expand

One or more relations to expand for a group resource Optional: `organization, scopes`

api_path

The hypothesis API path, can be specify by `hypothesis.api.api_path` option or `HYPOTHESIS_API_PATH` environment variable. Default: `https://hypothes.is/api/`.

api_key

User api key, generated on the platform.