Home Page > Integration > REST API > Groups

Groups

Groups - /REST/1/Groups/:id

This endpoint is used for manipulating the Group resource. Objects are always returned in a JSON format within an array. Empty results return an empty array.

 

Object

The Group resource takes on the following JSON object:

[
    {
        "alive": "<bool>",
        "default_for_new_users": "<bool>",
        "expires": "<bool>",
        "expiry_date": "<date>",
        "hidden": "<bool>",
        "id": "<int>",
        "name": "<string>"
    }
]

Last updated date: 1/16/2019

GET

This verb is used for retrieving resources, it is subject to the parameters mentioned in the overview. Only the name is searchable.

 

POST

The following JSON parameters are required when creating a resource:

 

JSON Parameter Allowed Values Notes
name string This will be the display name of the group.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.