Sign in

v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB
Groups

List all groups

🔑

Required OAuth scope: groups:read.

📖

This endpoint is paginated with a page size of 500 groups. For more information, see the Pagination guide.

Lists all groups in your platform.

get/api/v2/groups

Headers

360-api-version'v2.0' required

The version of the API.

Response

Returns one page of 500 groups.

bannerImageIdstring ObjectId

The banner image of the group. Ensure that given media is an image with the proper size (at least 980px wide and 370px high).

backgroundImageIdstring ObjectId

The background image of the group. Ensure that given media is an image with the proper size (at least 760px wide and 880px high).

faviconImageIdstring ObjectId

The favicon image of the group. Ensure that given media is an image with the proper size (less than 500px wide and 500px high and more than 16px wide and 16px high).

logoImageIdstring ObjectId

The logo image of the group.

subdomainstring

The subdomain of the group.

urlstring

The custom url of the group. The given URL must resolve on the same address as 360learning.com.

_idstring ObjectId required

The unique ID of the group.

namestring required

The name of the group.

customstring

A custom field to store information available only in the General settings of the group, the CSV exports, and the API. This information is not displayed to learners on the platform.

publicboolean required

True if the group is public; false if the group is private.

parentIdstring ObjectId

The unique ID of the parent group. Not defined for the root group.

Example response

[
  {
    "privacyPolicy": {
      "url": "https://example.com/policy"
    },
    "moderationCharter": {
      "url": "https://example.com/policy"
    },
    "termsOfUse": {
      "url": "https://example.com/policy"
    },
    "imprint": {
      "url": "https://example.com/policy"
    },
    "bannerImageId": "507f1f77bcf86cd799439011",
    "backgroundImageId": "507f1f77bcf86cd799439011",
    "faviconImageId": "507f1f77bcf86cd799439011",
    "logoImageId": "507f1f77bcf86cd799439011",
    "subdomain": "company-subdomain",
    "url": "company-domain.com",
    "_id": "507f1f77bcf86cd799439011",
    "name": "Engineering Team",
    "custom": "Unit 101",
    "parentId": "507f1f77bcf86cd799439011"
  }
]