Перейти к основному содержанию
GET
/
users
Get users
curl --request GET \
  --url https://api.oquiz.net/users
[
  {
    "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>"
  }
]

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

q
string

Query string, search by username

Maximum string length: 255
cursor
string

Cursor id for pagination

cursorOrder
string

Cursor fallback for pagination

take
number

Number of users to take

orderBy

Order by

orderDirection

Order direction

Ответ

200 - application/json
id
string
обязательно

User id

username
string
обязательно

User username, used for navigation

realname
null | string
обязательно

User real name, used for display

image
object
обязательно

User image

about
null | string
обязательно

User about

verified
boolean
обязательно

User is verified

banned
boolean
обязательно

User is banned

anonymous
boolean
обязательно

User is anonymous

User social links

membership
object
обязательно

User membership

banner
object
обязательно

User banner

pkgCount
number
обязательно

Published packages count

createdAt
string
обязательно

User creation date