GET /api/v1/groups

Lists all Groups with pagination support.

The number of Groups returned depends on the specified limit, if you have a search, filter, and/or query parameter set, and if that parameter is not null. We recommend using a limit less than or equal to 200.

A subset of Groups can be returned that match a supported filter expression, query, or search criteria.

Note: Results from the filter or query parameter are driven from an eventually consistent datasource. The synchronization lag is typically less than one second. See Filtering for more information on expressions.

Servers

https://{yourOktaDomain}

Query parameters

Name	Type	Required	Description
`sortOrder`	String	No	Specifies sort order: `asc` or `desc` (for search queries only). This parameter is ignored if if `sortBy` is not present. Groups with the same value for the `sortBy` property will be ordered by `id` Default value: "asc"
`limit`	Integer	No	Specifies the number of Group results in a page. Don't write code that depends on the default or maximum value, as it might change. If you receive an `HTTP 500` status code, you likely exceeded the request timeout. 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. Note: We strongly encourage using a limit that's less than or equal to 200. Any number greater than 200 affects performance and accuracy.
`filter`	String	No	Filter expression for Groups 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`.
`sortBy`	String	No	Specifies field to sort by (for search queries only). `sortBy` can be any single property, for example `sortBy=profile.name`.
`q`	String	No	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.
`after`	String	No	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.
`expand`	String	No	If specified, additional metadata is included in the response. Possible values are `stats` and `app`.
`search`	String	No	Searches for groups with a supported filtering expression for all attributes except for `_embedded`, `_links`, and `objectClass`. Search currently performs a `startsWith` match but it should be considered an implementation detail and might change without notice in the future. 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 property, including imported app group profile properties. * 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 `sortBy` and `sortOrder` parameters.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.