Перейти к основному содержанию
GET
/
pkgs
Get packages
curl --request GET \
  --url https://api.oquiz.net/pkgs
{
  "data": [
    {
      "locales": [
        "<string>"
      ],
      "name": "<string>",
      "description": "<string>",
      "image": {
        "src": "<string>",
        "color": "<string>"
      },
      "categories": [
        {
          "name": "<string>",
          "id": "<string>",
          "i18n": {
            "name": "<string>"
          },
          "emoji": "<string>",
          "color": "<string>"
        }
      ],
      "id": "<string>",
      "type": "<unknown>",
      "settings": {
        "multipliers": {},
        "timers": {}
      },
      "difficulty": "<unknown>",
      "rating": 123,
      "explicit": true,
      "verified": true,
      "user": {
        "id": "<string>",
        "username": "<string>",
        "realname": "<string>",
        "image": {
          "src": "<string>",
          "color": "<string>"
        },
        "about": "<string>",
        "verified": true,
        "banned": true,
        "anonymous": true,
        "socialLinks": [
          {
            "provider": "<unknown>",
            "url": "<string>"
          }
        ],
        "membership": {
          "discord": true
        },
        "banner": {
          "type": "<unknown>",
          "value": "<string>",
          "color": "<string>"
        },
        "pkgCount": 123,
        "createdAt": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "userId": "<string>",
      "deletedAt": "2023-11-07T05:31:56Z",
      "meta": {
        "size": {
          "text": 123,
          "audio": 123,
          "video": 123,
          "images": 123
        },
        "starts": 123
      },
      "ratingsCount": 123,
      "playCount": 123,
      "series": [
        {
          "name": "<string>",
          "id": "<string>",
          "image": {
            "src": "<string>",
            "color": "<string>"
          },
          "slug": "<string>"
        }
      ],
      "publishedVersionId": "<string>"
    }
  ],
  "total": 123
}

Параметры запроса

q
string

Search query, by package name or description

Maximum string length: 255
collection
string

Filter by collection slug (e.g., 'popular')

difficulty
any[]

Filter by difficulty

authors
string[]

Filter by users' ids, works like OR

categories
string[]

Filter by categories' ids, works like OR

userDrafts
boolean

Filter only current user drafts

userFavorites
boolean

Filter only current user favorites

createdAtFrom
string<date-time>

Filter by packages created at from

createdAtTo
string<date-time>

Filter by packages created at to

cursor
string

Cursor id for pagination

cursorOrder
string

Cursor fallback for pagination

take
number

Number of packages to take

orderDirection

Order direction

orderBy

Order by

Ответ

200 - application/json
data
object[]
обязательно
total
number
обязательно