v1

latestOpenAPI 3.0.02026-07-2653703.5 MB
orgs/groups

List all access groups

listGroups takes the following options:<br/><br/>withSites - to include the group's sites<br/><br/>ignoreSiteSpecificAccess - bypasses site specific access checks<br/><br/>JWT is required for this endpoint with at least one of the following scopes: o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-user:w,o{params.orgId}-user:r,o{params.orgId}-ldp:w,o{params.orgId}-ldp:r,o{params.orgId}-integrations:w,o{params.orgId}-integrations:r,o{params.orgId}-rpt:r,o{params.orgId}-rpt:w,o{params.orgId}-credential:w,o{params.orgId}-credential:r,o{params.orgId}-musterReport:r,o{params.orgId}-musterReport:w,o{params.orgId}-occupancyReport:r,o{params.orgId}-occupancyReport:w,o:w,o:r,s-o:w,s-o:r<br/><br/>Endpoint name: listGroups

get/orgs/{orgId}/groups

Path parameters

orgIdinteger required

Query parameters

limitinteger
offsetinteger
sortstring
orderstring
qstring
filterstring
preFilterstring
optionsstring

Response

Successful

totalCountinteger
filteredCountinteger