Skip to main content
GET
List or filter groups

Authorizations

Authorization
string
header
required

Plerion organization API key (plerion_oak_…), created by an organization admin in the Plerion console. Write operations require a key with readWrite access level; GET and .search work with read access level.

Query Parameters

filter
string

RFC 7644 filter expression. Operators eq ne co sw ew gt ge lt le pr, logical and/or/not, grouping, and complex attribute filters such as emails[type eq "work"]. Attribute names are case-insensitive; userName and email comparisons are case-insensitive.

sortBy
string

Attribute path to sort by (for example userName or meta.lastModified).

sortOrder
enum<string>
default:ascending
Available options:
ascending,
descending
startIndex
integer
default:1

1-based index of the first result.

Required range: x >= 1
count
integer
default:100

Maximum results per page. Values above 1000 are clamped to 1000.

Required range: 0 <= x <= 1000
attributes
string

Comma-separated attribute paths to include in the response.

excludedAttributes
string

Comma-separated attribute paths to omit from the response.

Response

Filtered, sorted, paginated list of groups.

schemas
string[]
required
Allowed value: "urn:ietf:params:scim:api:messages:2.0:ListResponse"
totalResults
integer
required
startIndex
integer
itemsPerPage
integer
Resources
object[]