v1

latestOpenAPI 3.0.02026-08-062438369.6 KB
Groups

Get all groups

Returns a paginated list of all groups for your organization. Use this endpoint to sync group records into an external system or to find groups by name or parent. Filter by parent_id to retrieve only direct child groups of a specific group, or use the date filters to retrieve only recently created or modified groups.

get/groups

Query parameters

name_likestring

The group name, or part of a name, to search for.

parent_idstring

Filter results to only groups that are direct children of the group with this ID. Provide the VOMO Group ID of the parent group.

created_beforestring date-time

Date the Group was created on or before.

created_afterstring date-time

Date the Group was created on or after

updated_beforestring date-time

Date the Group was updated on or before.

updated_afterstring date-time

Date the Group was updated on or after

Response

Returns the paginated list of groups for your organization. The response includes pagination links and meta fields to navigate additional pages.