Get Banned Users - Teamly API

Request

Path Params

teamId

string

required

Query Params

limit

string

optional

Example:

1000

Header Params

Authorization

string

required

Default:

Bot {token}

Content-Type

string

required

Default:

application/json

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Success

application/json

Body

array of:

user

object (User)

required

id

string

required

Unique identifier for the user

username

string

required

Username of the user

>= 1 characters<= 20 characters

subdomain

string

required

Subdomain associated with the user

profilePicture

string <uri>

optional

URL to the user's profile picture

Default:

null

banner

string <uri>

optional

URL to the user's banner image

Default:

null

bot

boolean

required

Indicates whether the user is a bot

Default:

false

presence

number

required

Presence status of the user (e.g., online, offline, etc.)

>= 0<= 3

Default:

0

badges

array [object {3}]

required

List of badges awarded to the user

userStatus

object

optional

Status set by the user

userRPC

object

optional

Rich presence details of the user

connections

array [object]

required

List of external connections the user has

createdAt

string <date-time>

required

Timestamp of when the user was created

Default:

CURRENT_TIMESTAMP

lastOnline

string <date-time> | null

deprecated

Timestamp of when the user was last online

Default:

CURRENT_TIMESTAMP

system

boolean

required

Indicates whether the user is a system account

Default:

false

reason

string

required

Example

[
  {
    "user": {
      "id": "string",
      "username": "string",
      "subdomain": "string",
      "profilePicture": null,
      "banner": null,
      "bot": false,
      "presence": 0,
      "badges": [],
      "userStatus": {
        "content": null,
        "emojiId": null
      },
      "userRPC": {
        "type": null,
        "name": null,
        "id": null,
        "startedAt": null
      },
      "connections": [],
      "createdAt": "CURRENT_TIMESTAMP",
      "lastOnline": "CURRENT_TIMESTAMP",
      "system": false
    },
    "reason": "string"
  }
]