Get Sphere
This route does not require a valid Authorization header, however it is preferred to provide it.
GET/spheres/<identifier>
Get a sphere’s data using a Sphere Identifier.
Path Params
| Name | Type |
|---|---|
| identifier | SphereIdentifier |
Response
200Sphere
| Field | Type | Description |
|---|---|---|
| id | Number | The spheres’s ID. |
| owner_id | Number | The ID of the sphere’s owner. |
| name? | String | The name of the sphere. |
| slug | String | The slug of the sphere. |
| type | SphereType | The sphere’s type. |
| description? | String | The sphere’s description, can be between 1 and 4096 characters. |
| icon? | Number | The sphere’s icon. This field has to be a valid file ID in the “sphere-icons” bucket. |
| banner? | Number | The sphere’s banner. This field has to be a valid file ID in the “sphere-banners” bucket. |
| badges | Number | The sphere’s badges as a bitfield. |
| categories | Array of Categorys | The categories that this sphere contains. |
| members | Array of Members | The members that are inside this sphere. |
| emojis | Array of Emojis | The emojis that this sphere has. |
Example
curl \
-H "Authorization: <token>" \
https://api.eludris.gay/spheres/4204171493377
{
"id": 4204171493377,
"owner_id": 4203748065281,
"slug": "horse",
"type": "HYBRID",
"badges": 0,
"channels": [{
"type": "TEXT",
"id": 4204171493378,
"sphere_id": 4204171493377,
"name": "general",
"position": 0
}]
}