Followings v1
Reference for the Followings v1 endpoints on Roblox.
Base URL: https://followings.roblox.com
Endpoints
Section titled “Endpoints”| Method | Path | Name |
|---|---|---|
GET | /v1/users/:userId/universes | getUsersUseridUniverses |
POST | /v1/users/:userId/universes/:universeId | postUsersUseridUniversesUniverseid |
DELETE | /v1/users/:userId/universes/:universeId | deleteUsersUseridUniversesUniverseid |
GET | /v1/users/:userId/universes/:universeId/status | getUsersUseridUniversesUniverseidStatus |
getUsersUseridUniverses
Section titled “getUsersUseridUniverses”GET /v1/users/:userId/universes
Gets all the followings between a user with userId and universes
Usage
import { fetchApi } from 'rozod';import { getUsersUseridUniverses } from 'rozod/lib/endpoints/followingsv1';
const data = await fetchApi(getUsersUseridUniverses, { userId: /* integer */});Parameters
Section titled “Parameters”| Name | Type | Required | Description |
|---|---|---|---|
userId | integer | Yes |
Response
Section titled “Response”Array of objects:
| Field | Type | Description |
|---|---|---|
universeId | number | |
userId | number |
Errors
Section titled “Errors”| Status | Description |
|---|---|
| 401 | 0: Authorization has been denied for this request. |
| 403 | User is not authorized for this action. |
postUsersUseridUniversesUniverseid
Section titled “postUsersUseridUniversesUniverseid”POST /v1/users/:userId/universes/:universeId
Creates the following between a user with userId and universe with universeId
Usage
import { fetchApi } from 'rozod';import { postUsersUseridUniversesUniverseid } from 'rozod/lib/endpoints/followingsv1';
const data = await fetchApi(postUsersUseridUniversesUniverseid, { userId: /* integer */, universeId: /* integer */});Parameters
Section titled “Parameters”| Name | Type | Required | Description |
|---|---|---|---|
userId | integer | Yes | |
universeId | integer | Yes |
Response
Section titled “Response”| Field | Type | Description |
|---|---|---|
universeId | number | |
userId | number |
Errors
Section titled “Errors”| Status | Description |
|---|---|
| 400 | The user has reached the limit of number of followed universes. |
| 401 | 0: Authorization has been denied for this request. |
| 403 | User is not authorized for this action. 0: Token Validation Failed |
deleteUsersUseridUniversesUniverseid
Section titled “deleteUsersUseridUniversesUniverseid”DELETE /v1/users/:userId/universes/:universeId
Deletes the following between a user with userId and universe with universeId
Usage
import { fetchApi } from 'rozod';import { deleteUsersUseridUniversesUniverseid } from 'rozod/lib/endpoints/followingsv1';
const data = await fetchApi(deleteUsersUseridUniversesUniverseid, { userId: /* integer */, universeId: /* integer */});Parameters
Section titled “Parameters”| Name | Type | Required | Description |
|---|---|---|---|
userId | integer | Yes | |
universeId | integer | Yes |
Response
Section titled “Response”| Field | Type | Description |
|---|---|---|
universeId | number | |
userId | number |
Errors
Section titled “Errors”| Status | Description |
|---|---|
| 401 | 0: Authorization has been denied for this request. |
| 403 | User is not authorized for this action. 0: Token Validation Failed |
getUsersUseridUniversesUniverseidStatus
Section titled “getUsersUseridUniversesUniverseidStatus”GET /v1/users/:userId/universes/:universeId/status
Gets the status of a following relationship between a user and a universe.
Usage
import { fetchApi } from 'rozod';import { getUsersUseridUniversesUniverseidStatus } from 'rozod/lib/endpoints/followingsv1';
const data = await fetchApi(getUsersUseridUniversesUniverseidStatus, { userId: /* integer */, universeId: /* integer */});Parameters
Section titled “Parameters”| Name | Type | Required | Description |
|---|---|---|---|
userId | integer | Yes | |
universeId | integer | Yes |
Response
Section titled “Response”| Field | Type | Description |
|---|---|---|
UniverseId | number | |
UserId | number | |
CanFollow | boolean | |
IsFollowing | boolean | |
FollowingCountByType | number | |
FollowingLimitByType | number |
Errors
Section titled “Errors”| Status | Description |
|---|---|
| 401 | 0: Authorization has been denied for this request. |
| 403 | User is not authorized for this action. |