Returns paginated groups data limited by default to 100 items. Either for the homegroup of the user, who created the API token being used or for a specific group id. The groupOption parameter determines which type of id will be used to query a specific group: id (group id) or path (group path. ex: CompanyA\DivisionB\Region1\LocalOffice2). includeSubgroups option can be used to list all subgroups for the specified group or just its direct children.

SecurityAPIKey
Request
query Parameters
id
string or null

Id of the group of interest. Either GUID or URL-Encoded version of path\to\group string depending on groupOption value. If not specified, response will contain all groups data for the homegroup of the user who created the API token being used on the call data with or without its underlying subgroups depending on includeSubgroups value.

groupOption
string or null
Default: "id"

Option to retrieve groups info, either by its 'id' (GUID) or by 'path'. If id was not specified groupOption is ignored and data will be returned as neither id or groupOpion were specified.

includeSubgroups
boolean
Default: true

Indicates whether results should include data for all subgroups of the group specified.

page
integer <int32> [ 1 .. 2147483647 ]

Number of the page of group records to be returned. If not provided, first page of records will be returned.

limit
integer <int32> [ 1 .. 100 ]
Default: 100

Indicates count of items to retrieve. By default the service will return 100 items.

Responses
200
204

No groups found.

400

The parameters given in the request are invalid.

401

Can occur due to inputting an invalid key, or invalid pod.

403

Access is denied for this API. The given APIKey's context does not have the proper permissions.

500
get/
Request samples 
Response samples 
application/json
[
  • {
    }
]
© 2023 Lytx, Inc. All rights reserved