GET /api/v1/groups

Specifies sort order: asc or desc (for search queries only). This parameter is ignored if sortBy isn't present.

Default value: "asc"

Specifies the number of group results in a page.

Okta recommends using a specific value other than the default or maximum. If your request times out, retry your request with a smaller limit and page the results.

The Okta default Everyone group isn't returned for users with a group admin role.

Filter expression for groups. See Filter.

Filtering supports the following limited number of properties: id, type, lastUpdated, and lastMembershipUpdated.

Note: All filters must be URL encoded. For example, filter=lastUpdated gt "2013-06-01T00:00:00.000Z" is encoded as filter=lastUpdated%20gt%20%222013-06-01T00:00:00.000Z%22. See Special characters.

Specifies the field to sort by (for search queries only). sortBy can be any single property, for example sortBy=profile.name. Groups with the same value for the sortBy property are ordered by id'. Use with sortOrder to control the order of results.

Finds a group that matches the name property.

Note: Paging and searching are currently mutually exclusive. You can't page a query. The default limit for a query is 300 results. Query is intended for an auto-complete picker use case where users refine their search string to constrain the results.

Specifies the pagination cursor for the next page of groups. The after cursor should be treated as an opaque value and obtained through the next link relation. See Pagination.

Searches for groups with a supported filtering expression for all properties except for _embedded, _links, and objectClass. Okta recommends this query parameter because it provides the largest range of search options and optimal performance.

This operation supports pagination.

Using search requires URL encoding, for example, search=type eq "OKTA_GROUP" is encoded as search=type+eq+%22OKTA_GROUP%22.

This operation searches many properties:

• Any group profile attribute, including imported app group profile attributes.
• The top-level properties: id, created, lastMembershipUpdated, lastUpdated, and type.
• The source of groups with type of APP_GROUP, accessed as source.id.

You can also use the sortBy and sortOrder parameters.

Searches for groups can be filtered by the following operators: sw, eq, and co. You can only use co with these select profile attributes: profile.name and profile.description. See Operators.

If specified, additional metadata is included in the response. Possible values are stats and app. This additional metadata is listed in the _embedded property of the response.

Note: You can use the stats value to return the number of users within a group. This is listed as the _embedded.stats.usersCount value in the response. See this Knowledge Base article for more information and an example.