List groups

get

https://{tenant}{.kallidus-suite.com}/api/v4/suite/groups

View all groups.

Query Params

$filter

string

OData like filter expression. Supported operators: eq, and, gt, lt.
Supported fields: title, code, categoryId, dateCreated, dateModified, managerId. managerId is the user id of the manager.
parentGroupId is supported in $filter using eq only.
Examples:

categoryId eq 11111111-1111-1111-1111-111111111111
categoryId eq 11111111-1111-1111-1111-111111111111 and managerId eq 22222222-2222-2222-2222-222222222222
parentGroupId eq 33333333-3333-3333-3333-333333333333

$orderby

string

Order results by one or more fields. Use asc or desc for direction.
Supported fields: title, code, categoryId, dateCreated, dateModified.
Example: dateCreated asc

$top

integer

1 to 50

Defaults to 50

Number of records to return (page size)

$count

boolean

Defaults to false

Include total count of matching records in response

$select

string

Comma-separated list of fields to include in response.
Supported fields: all response fields.
Example: id,title,managerId

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Groups retrieved successfully

400Bad Request

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

500Internal Server Error