List groups

get

https://miro.com/api/v1/scim/Groups

Retrieves the list of groups (teams) in the organization.

Note: Along with groups (teams), the users that are part of those groups (teams) are also retrieved. Only users that have member role in the organization are fetched.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

attributes

string

A comma-separated list of attribute names to return in the response.

Example attributes: id,displayName
Note: It is also possible to fetch attributes within complex attributes, for Example: members.display.

filter

string

You can request a subset of resources by specifying the filter query parameter containing a filter expression. Attribute names and attribute operators used in filters are not case sensitive. The filter parameter must contain at least one valid expression. Each expression must contain an attribute name followed by an attribute operator and an optional value.
eq = equal
ne = not equal
co = contains
sw = starts with
ew = ends with
pr = preset (has value)
gt = greater than
ge = greater than or equal to
lt = less than
le = less than or equal to
and = Logical "and"
or = Logical "or"
not = "Not" function
() = Precedence grouping
The value must be passed within parenthesis.

For Example: displayName eq "Product Team" will fetch information related to team matching the display name "Product Team".
Note: Filtering on complex attributes is not supported

startIndex

integer

Use startIndex in combination with count query parameters to receive paginated results.

start index is 1-based.

Example: startIndex=1

count

integer

Specifies the maximum number of query results per page.

Use count in combination with startIndex query parameters to receive paginated results.

The count query parameter is set to 100 by default and the maximum value allowed for this parameter is 1000.

Example: count=12

sortBy

string

Specifies the attribute whose value will be used to order the response. Example sortBy=displayName

sortOrder

string

enum

Defines the order in which the 'sortBy' parameter is applied. Example: sortOrder=ascending

Allowed:

Headers

string

enum

Defaults to application/scim+json

Generated from available response content types

Allowed:

Responses

200Successful Operation

400Malformed request

401Invalid authentication credentials

403Invalid access

404Not Found

429Too many requests.

500Internal Server Error