Skip to main content

List groups

GET 

/groups

Returns directory groups.

The list returns the default field set (distinguishedName, displayName, cn, sAMAccountName, objectSid, domain_fqdn, domain_netbios, access, isEntraId, isHybrid) plus the object id. Query-string filtering, advanced, select, sorting and paging work as for GET /users.

Required role: any authenticated user.

Request​

Responses​

A page of groups.

Response Headers
    X-Pagination-Count

    Number of records in this page.

    X-Pagination-Max-Count

    Page size used for the request (limit).

    X-Pagination-Page

    Current page number.

    X-Pagination-Pages

    Total number of pages.

    X-Pagination-Total

    Total number of records matching the query.

    Link

    RFC 8288 links with rel values first, last, and, when they exist, prev and next.