Get groups

Groups

Via this method you are able to search on specific groups. Gourps are also known as Hierarchies in the Cirrus platform You are able to find only groups which contain a 'Organization ID'.

Get /groups/

Header

Name	Data Type	Description
Content-type:	application/json	for all requests
Authorization:	EAPI {token}	for all requests

Request Parameters

Parameters indicated with a * are mandatory

Parameter	Type	Description
search	String	Filter of groups by Title, Path and ExternalId

Sample Request URL

https://api.cirrusplatform.com/api/v1/integrations/groups?search=test

Sample successfull Response

Deprecated: SynchronizationKey is no longer in use (and only kept for backward compatibility)

[
    {
        "ExternalId": "GroupKey5",
        "Title": "GroupKey5",
        "Path": "Test education \\ GroupKey5",
        "ParentExternalId": null,
        "SynchronizationKey": "09855da4-1697-4605-a581-e579d2ee4827",
        "AllowRelationshipWithSchedules": true,
        "IsArchived": false,
        "IsOrganization": true
    },
    {
        "ExternalId": "GroupKey6",
        "Title": "GroupKey6",
        "Path": "Test education \\ GroupKey6",
        "ParentExternalId": "R014",
        "SynchronizationKey": "09855da4-1697-4605-a581-e579d2ee4828",
        "AllowRelationshipWithSchedules": true,
        "IsArchived": false,
        "IsOrganization": false
    },
    {
        "ExternalId": "GroupKey7",
        "Title": "GroupKey7",
        "Path": "Test education \\ GroupKey5 \\ GroupKey7",
        "ParentExternalId": "GroupKey5",
        "SynchronizationKey": "09855da4-1697-4605-a581-e579d2ee4829",
        "AllowRelationshipWithSchedules": true,
        "IsArchived": false,
        "IsOrganization": false
    }
]

Unsuccesfull response

Will return a https status 200 with no content

Responses

Code	Description
200	Successful operation
403	Not allowed to use external API
500	Internal server error