>>

Sphere

The Sphere payload.

FieldTypeDescription
idNumberThe spheres’s ID.
owner_idNumberThe ID of the sphere’s owner.
name?StringThe name of the sphere.
slugStringThe slug of the sphere.
typeSphereTypeThe sphere’s type.
description?StringThe sphere’s description, can be between 1 and 4096 characters.
icon?NumberThe sphere’s icon. This field has to be a valid file ID in the “sphere-icons” bucket.
banner?NumberThe sphere’s banner. This field has to be a valid file ID in the “sphere-banners” bucket.
badgesNumberThe sphere’s badges as a bitfield.
categoriesArray of CategorysThe categories that this sphere contains.
membersArray of MembersThe members that are inside this sphere.
emojisArray of EmojisThe emojis that this sphere has.
>>

Example

 
{
  "id": 4080402038786,
  "owner_id": 4080403808259,
  "slug": "spehre",
  "name": "Spehre",
  "type": "HYBRID",
  "description": "Truly the sphere of all time",
  "icon": 4080412852228,
  "badges": 0,
  "categories": [
    {
      "id":5490083823619,
      "name":"uncategorised",
      "position":0,
      "channels": [
        {
          "type":"TEXT",
          "id":5490083823620,
          "sphere_id":5490083823619,
          "name":"general",
          "position":0,
          "category_id":5490083823619
        }
      ]
    }
  ],
  "members": [
    {
      "user": {
        "id": 5490049220609,
        "username": "John-Mahjong",
        "social_credit": 0,
        "status": {
          "type": "ONLINE"
        },
        "badges": 0,
        "permissions": 0,
        "email": "john.mahjong@example.com",
        "verified": false
      },
      "sphere_id": 5490083823619
    }
  ]
}