Get Groups

description retrieves a list of groups from okta identity management without requiring additional parameters endpoint url /api/v1/groups method get inputs parameters (object) q (string) finds a group that matches the name property 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 filter (string) 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 examples filter group with a specific id filter=id eq "00g1emakyztwryyrrtsk" filter groups that are of the type okta group filter=type eq "okta group" filter groups that are of the type okta group with profile updated after 11/11/2015 filter=type eq "okta group" and lastupdated gt "2016 11 11t00 00 00 000z" filter groups that are of the type okta group with profile or memberships updated before 11/11/2015 filter=type eq "okta group" and (lastupdated lt "2015 11 11t00 00 00 000z" or lastmembershipupdated lt "2015 11 11t00 00 00 000z") after (string) 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 limit (number) 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 expand (string) if specified, additional metadata is included in the response possible values are stats and app this additional metadata is listed in the embedded key 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 search (string) 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 sortby (string) specifies field to sort by (for search queries only) sortby can be any single property, for example sortby=profile name sortorder (string) 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 output example \[ { "status code" 200, "response headers" { "content length" "140", "content type" "application/json", "date" "wed, 8 jan 2025 20 37 23 gmt" }, "reason" "ok", "json" { "id" "00g1emakyztwryyrrtsk", "created" "2015 02 06t10🕚28 000z", "lastupdated" "2015 10 05t19 16 43 000z", "lastmembershipupdated" "2015 11 28t19 15 32 000z", "objectclass" \[ "okta\ user group" ], "type" "okta group", "profile" { "name" "west coast users", "description" "all users west of the rockies" }, " links" { "logo" \[ { "name" "medium", "href" "https //{youroktadomain}/img/logos/groups/okta medium png", "type" "image/png" }, { "name" "large", "href" "https //{youroktadomain}/img/logos/groups/okta large png", "type" "image/png" } ], "users" { "href" "https //{youroktadomain}/api/v1/groups/00g1emakyztwryyrrtsk/users" }, "apps" { "href" "https //{youroktadomain}/api/v1/groups/00g1emakyztwryyrrtsk/apps" } } } } ] output parameters status code (number) reason (string) json (object) id (string) created (string) lastupdated (string) lastmembershipupdated (string) objectclass (array) type (string) profile (object) name (string) description (string) links (object) logo (array) name (string) href (string) type (string) users (object) href (string) apps (object) href (string) response headers header type content length string content type string date string