Connectors
...
Actions
Get Groups
6 min
description retrieve details of sentinelone groups based on specified filter criteria endpoint url /web/api/v2 1/groups method get inputs parameters (object) accountids (string) list of account ids to filter by countonly (boolean) if true, only total number of items will be returned, without any of the actual objects cursor (string) cursor position returned by the last request use to iterate over more than 1000 items description (string) the description for the group groupids (string) list of group ids to filter by id (string) id isdefault (boolean) if true, default group is set limit (string) limit number of returned items (1 300) name (string) name query (string) free text search on fields name, description rank (string) the rank sets the priority of a dynamic group over others registrationtoken (string) registration token siteids (string) list of site ids to filter by skip (string) skip first number of items (0 1000) to iterate over more than 1000 items, use "cursor" skipcount (boolean) if true, total number of items will not be calculated, which speeds up execution time sortby (string) the column to sort the results by sortorder (string) sort direction type (string) group type types (string) a list of group types updatedat gt (string) updated at greater than updatedat gte (string) updated at greater or equal than updatedat lt (string) updated at lesser than updatedat lte (string) updated at lesser or equal than output example \[ { "status code" 200, "response headers" { "server" "nginx", "date" "tue, 11 jun 2024 11 26 21 gmt", "content type" "application/json", "transfer encoding" "chunked", "connection" "keep alive", "x rqid" "112653fa 4329 4f71 a7a6 5dc163b97fd2", "access control allow origin" "https //cns na1 sentinelone net", "access control allow credentials" "true", "vary" "origin", "strict transport security" "max age=31536000; includesubdomains", "x frame options" "sameorigin", "x content type options" "nosniff", "content security policy" "default src 'self' ; connect src 'self' sentinelone net cdn pendo io app pendo io pendo io data pendo io scalyr com storage googleapis com sentry io sentry io google analytics com gstatic com unpkg com cdn auth0 com wss\ // sentinelone net https //www googletagmanager com https //cdnjs cloudflare com https //dm64t97qsxvuz cloudfront net data ; script src 'self' 'unsafe inline' 'unsafe eval' blob sentinelone net cdn pendo io app pendo io pendo io static storage googleapis com storage googleapis com data pendo io https //www google analytics com https //www googletagmanager com https //unpkg com https //cdnjs cloudflare com https //dm64t97qsxvuz cloudfront net ; img src 'self' blob sentinelone net sentinelone com dm64t97qsxvuz cloudfront net data https //www google analytics com cdn pendo io app pendo io storage googleapis com data pendo io ; style src 'self' 'unsafe inline' sentinelone net app pendo io cdn pendo io storage googleapis com https //cdnjs cloudflare com https //dm64t97qsxvuz cloudfront net ; font src 'self' data sentinelone net https //cdn auth0 com https //dm64t97qsxvuz cloudfront net ; manifest src 'self' https //dm64t97qsxvuz cloudfront net ; frame src 'self' blob https //receptive io https // pendo io https //pendo io extensions storage googleapis com/ https // youtube com sentinelone net scalyr com; frame ancestors 'self' app pendo io sentinelone net; object src 'none' ; worker src 'self' blob ;", "cache control" "no store", "pragma" "no cache", "expires" " 1", "content encoding" "gzip" }, "reason" "ok", "json body" { "data" \[ { "createdat" "2021 11 10t21 37 36 554715z", "creator" "sandeep minhas", "creatorid" "1170348439571106212", "filterid" null, "filtername" null, "id" "1286405255265411734", "inherits" true, "isdefault" true, "name" "default group", "rank" null, "registrationtoken" "eyj1cmwioiaiahr0chm6ly91c2vhms1wyxj0bmvycy5zzw50aw5lbg9uzs5uzxqilcaic2l0zv9rzxkioiaiz19hn2m1odjlntvimze2nme5in0=", "siteid" "1286405255257023125", "totalagents" 2, "type" "static", "updatedat" "2021 11 10t21 37 37 094755z" }, { "createdat" "2023 08 24t21 24 49 806822z", "creator" "travis riley", "creatorid" "1286405906565325677", "filterid" null, "filtername" null, "id" "1758952600065820586", "inherits" true, "isdefault" true, "name" "default group", "rank" null, "registrationtoken" "eyj1cmwioiaiahr0chm6ly91c2vhms1wyxj0bmvycy5zzw50aw5lbg9uzs5uzxqilcaic2l0zv9rzxkioiaiz18zmdy4nwrkzgnjotlmzmy2in0=", "siteid" "1758952600032266153", "totalagents" 0, "type" "static", "updatedat" "2023 08 24t21 24 50 592583z" }, { "createdat" "2023 08 24t21 26 37 251651z", "creator" "travis riley", "creatorid" "1286405906565325677", "filterid" null, "filtername" null, "id" "1758953501371423302", "inherits" true, "isdefault" true, "name" "default group", "rank" null, "registrationtoken" "eyj1cmwioiaiahr0chm6ly91c2vhms1wyxj0bmvycy5zzw50aw5lbg9uzs5uzxqilcaic2l0zv9rzxkioiaiz18wmgm5mznhztnjndfkngiwin0=", "siteid" "1758953501354646085", "totalagents" 0, "type" "static", "updatedat" "2023 08 24t21 26 37 992107z" } ], "pagination" { "nextcursor" null, "totalitems" 3 } } } ] output parameters status code (number) reason (string) json body (object) data (array) createdat (string) creator (string) creatorid (string) filterid (object) filtername (object) id (string) inherits (boolean) isdefault (boolean) name (string) rank (object) registrationtoken (string) siteid (string) totalagents (number) type (string) updatedat (string) pagination (object) nextcursor (object) totalitems (number) response headers header type server string date string content type string transfer encoding string connection string x rqid string access control allow origin string access control allow credentials string vary string strict transport security string x frame options string x content type options string content security policy string cache control string pragma string expires string content encoding string