List UserGroups

GET

/user-groups

User Groups

Request

Query Params

sort

enum<string>

optional

Allowed values:

_created_at-_created_at

name

object

optional

string

optional

The partial name to search for.

string

optional

The exact name to fetch.

userType

optional

One of

array[string]

string

Allowed values:

adminmanagereducatormarkerstudentguest

subPortals

optional

One of

array[string]

string

limit

number

required

>= 1

offset

number

required

>= 0

include

array[string]

optional

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

array[object (UserGroup) {4}]

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

UserGroup

Example:

UserGroup

attributes

object

optional

relationships

object

optional

included

array[object (GenericResource) {4}]

optional

string

optional

The primary key for each resource.

Example:

FID001

type

string

optional

Identifies the Resource.

Example:

_User

attributes

object

optional

relationships

object

optional

meta

object

optional

total

integer

required

totalWithoutFilters

integer

optional

pages

integer

required

page

integer

required

offset

integer

required

limit

integer

required

totalCount

integer

deprecated

resultCount

integer

deprecated

totalPages

integer

deprecated

currentPage

integer

deprecated

Example

{
    "data": [
        {
            "id": "FID001",
            "type": "UserGroup",
            "attributes": {
                "name": "string",
                "description": "string",
                "attr": {},
                "isDefaultGroup": true,
                "defaultGroupType": "string",
                "isArchived": true,
                "totalUsers": 0,
                "parentId": "string",
                "internal": true,
                "membershipExpiryEnabled": true,
                "membershipExpiryTimeToExpireInMs": 0
            },
            "relationships": {
                "owner": {
                    "data": {
                        "id": "FID001",
                        "type": "User"
                    }
                },
                "userType": {
                    "data": {
                        "id": "FID001",
                        "type": "UserType"
                    }
                },
                "subPortal": {
                    "data": {
                        "id": "FID001",
                        "type": "SubPortal"
                    }
                },
                "parentGroup": {
                    "data": {
                        "id": "FID001",
                        "type": "UserGroup"
                    }
                }
            }
        }
    ],
    "included": [
        {
            "id": "FID001",
            "type": "_User",
            "attributes": {},
            "relationships": {
                "property1": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                },
                "property2": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                }
            }
        }
    ],
    "meta": {
        "total": 0,
        "totalWithoutFilters": 0,
        "pages": 0,
        "page": 0,
        "offset": 0,
        "limit": 0,
        "totalCount": 0,
        "resultCount": 0,
        "totalPages": 0,
        "currentPage": 0
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Modified at 2025-07-08 10:51:22

Create UserGroup

Get UserGroup