Query groups
Identical to GET /groups but accepts the filter set as a JSON request
body instead of query-string parameters. Returns the same paginated
index shape.
Authorization
bearerAuth In: header
Query Parameters
Comma-separated list of relationships to include. Allowed values are resource-specific; consult the operation for the allowlist.
Comma-separated list of attributes to sort by. Prefix with - for
descending order (-created_at,family_name).
Offset pagination parameters.
TypeScript Definitions
Use the request body type in TypeScript.
Filter predicates on Group attributes, keyed the
same way as the filter query parameter on GET /groups (e.g.
{ "filter": { "name_en_cont": "board" } }). The two reserved
keys search_query and auto_complete_search trigger a
full-text search.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/groups/query" \ -H "Content-Type: application/json" \ -d '{}'{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "type": "groups", "attributes": { "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f", "name": "string", "name_en": "string", "name_fr": "string", "name_es": "string", "description": "string", "description_en": "string", "description_fr": "string", "description_es": "string", "external_id": "string", "type": "string", "type_external_id": "string", "slug": "string", "start_date": "2019-08-24", "end_date": "2019-08-24", "identifying_number": 0, "data": {}, "active": true, "active_member_count": 0, "tags": [ "string" ], "custom_data_field": {}, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }, "relationships": { "parent_group": { "data": { "type": "groups", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "links": { "self": "/groups/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/parent_group", "related": "/groups/7247ad7d-9275-454b-9e3a-0570e403739e/parent_group" } }, "organization": { "data": { "type": "organizations", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "links": { "self": "/groups/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/organization", "related": "/groups/7247ad7d-9275-454b-9e3a-0570e403739e/organization" } }, "web_address": { "data": { "type": "web_addresses", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "links": { "self": "/groups/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/web_address", "related": "/groups/7247ad7d-9275-454b-9e3a-0570e403739e/web_address" } }, "address": { "data": { "type": "addresses", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "links": { "self": "/groups/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/address", "related": "/groups/7247ad7d-9275-454b-9e3a-0570e403739e/address" } }, "administrators": { "data": [ { "type": "people", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" } ], "links": { "self": "/groups/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/administrators", "related": "/groups/7247ad7d-9275-454b-9e3a-0570e403739e/administrators" } }, "service_identities": { "data": [ { "type": "service_identities", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" } ], "links": { "self": "/groups/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/service_identities", "related": "/groups/7247ad7d-9275-454b-9e3a-0570e403739e/service_identities" } } } } ], "meta": { "page": { "total_items": 0, "total_pages": 0, "number": 0, "size": 0 } }}{ "errors": [ { "status": 0, "title": "string", "source": { "pointer": "string", "parameter": "string" }, "meta": { "error": "string", "field": "string" } } ]}{ "errors": [ { "status": 0, "title": "string", "source": { "pointer": "string", "parameter": "string" }, "meta": { "error": "string", "field": "string" } } ]}