ckanaction

group_list

Return a list of the names of the site's groups.

POST
group_list
Authorization<token>

CKAN API token

In: header

type?string

the type of group to list (default: 'group'), see docs for IGroupForm

sort?string

sorting of the search results. Default: "title asc" string of field name and sort-order. The allowed fields are 'name', 'package_count' and 'title'

limit?integer

the maximum number of groups returned. Default: 1000 when all_fields=false unless set in site's configuration ckan.group_and_organization_list_max. Default: 25 when all_fields=true unless set in site's configuration ckan.group_and_organization_list_all_fields_max

offset?integer

when limit is given, the offset to start returning groups from

groups?array<string>

a list of names of the groups to return, if given only groups whose names are in this list will be returned

all_fields?boolean

return group dictionaries instead of just names. Only core fields are returned - get some more using the include_* options. Returning a list of packages is too expensive, so the packages property for each group is deprecated, but there is a count of the packages in the package_count property. (default: False)

include_dataset_count?boolean

if all_fields, include the full package_count (default: True)

include_extras?boolean

if all_fields, include the group extra fields (default: False)

include_tags?boolean

if all_fields, include the group tags

include_groups?boolean

if all_fields, include the groups the groups are in

include_users?boolean

if all_fields, include the group users

curl -X POST "http://localhost:5000/api/3/action/group_list" \  -H "Content-Type: application/json" \  -d '{}'