Detail Voice Members - Guilded Client

This is similar to [Detail Team Members] except that it provides three separate lists based on account type, is not key-value based, and does not support userIdsForBasicInfo

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

members

array[object (Member) {16}]

required

string

required

The ID of the member

name

string

required

The name of the member

nickname

string

optional

The nickname of the member

type

enum<string>

optional

The type of user that the member is

Allowed values:

userbot

Default:

user

membershipRole

enum<string>

optional

The "role" of the member

Allowed values:

adminmemberformerMember

profileBannerBlur

string <uri> | null

optional

The banner URL of the member

profilePicture

string <uri> | null

optional

The avatar URL of the member

roleIds

array[integer]

required

The role IDs of the member, not including the base "Member" role

userPresenceStatus

enum<integer>

optional

Enum representing a user's presence

Value	Meaning	Color
1	Online	Green
2	Idle	Orange
3	Do not disturb	Red
4	Offline / invisible	Gray

Allowed values:

1234

teamXp

integer

optional

The total XP that the member has in their team, could be negative

>= -9223372036854776000<= 9223372036854776000

lastOnline

string <date-time>

optional

When the member was last online

joinDate

string <date-time>

optional

Either the date the member joined their team, or the date their account was created, depending on which endpoint was used to receive this object

stonks

integer

optional

The number of "stonks" (points for referring users to the platform / 5) the member has

>= 0

aboutInfo

object | null

optional

Profile info for the member

socialLinks

array[object (SocialLink) {4}]

optional

The social links of the member

userStatus

object

optional

The custom status of the member

bots

array

required

webhooks

array[object (Webhook) {9}]

required

string <uuid>

read-onlyrequired

The ID of the webhook

Example:

00000000-0000-0000-0000-000000000000

name

string

required

The name of the webhook

>= 1 characters<= 128 characters

Example:

E-102 Gamma

teamId

string

read-onlyrequired

The ID of the team

Example:

wlVr3Ggl

iconUrl

string | null

optional

The icon URL of the webhook

channelId

string <uuid>

required

The ID of the channel

Example:

00000000-0000-0000-0000-000000000000

createdBy

string

optional

The ID of the user who created this webhook

createdAt

string <date-time>

read-onlyoptional

The ISO 8601 timestamp that the webhook was created at

deletedAt

string <date-time> | null

read-onlyoptional

The ISO 8601 timestamp that the webhook was deleted at

token

string | null

read-onlyoptional

The token of the webhook

Example

{
  "members": [
    {
      "id": "string",
      "name": "string",
      "nickname": "string",
      "type": "user",
      "membershipRole": "admin",
      "profileBannerBlur": "http://example.com",
      "profilePicture": "http://example.com",
      "roleIds": [
        0
      ],
      "userPresenceStatus": 1,
      "teamXp": -9223372036854776000,
      "lastOnline": "2019-08-24T14:15:22Z",
      "joinDate": "2019-08-24T14:15:22Z",
      "stonks": 0,
      "aboutInfo": {
        "tagLine": "string"
      },
      "socialLinks": [
        {
          "type": "twitch",
          "handle": "string",
          "serviceId": "string",
          "additionalInfo": {
            "channelName": "string",
            "socialLinkId": null,
            "id": null
          }
        }
      ],
      "userStatus": {
        "content": {
          "object": "value",
          "document": {
            "object": "document",
            "data": {
              "profile": {
                "name": "shay",
                "profilePicture": "https://s3-us-west-2.amazonaws.com/www.guilded.gg/WebhookThumbnail/3626a9cdc1020a98bd6c1724049c89a8-Full.webp?w=160&h=160"
              },
              "hiddenEmbedUrls": {
                "{url}": false
              }
            },
            "nodes": [
              {
                "object": "block",
                "type": "markdown-plain-text",
                "data": {
                  "isEmbedMessage": false,
                  "embeds": [
                    {
                      "title": "string",
                      "description": "string",
                      "url": "string",
                      "color": 0,
                      "timestamp": "string",
                      "footer": {
                        "text": "string",
                        "icon_url": "string",
                        "iconUrl": "string"
                      },
                      "thumbnail": {
                        "url": "string"
                      },
                      "image": {
                        "url": "string"
                      },
                      "author": {
                        "name": "string",
                        "url": "string",
                        "icon_url": "string",
                        "iconUrl": "string"
                      },
                      "fields": [
                        {
                          "name": "string",
                          "value": "string",
                          "inline": true
                        }
                      ]
                    }
                  ],
                  "url": "string",
                  "createdBy": "string",
                  "oldName": "string",
                  "newName": "string",
                  "type": "channel-renamed"
                },
                "nodes": [
                  {
                    "object": "text",
                    "type": "mention",
                    "data": {
                      "mention": {
                        "type": "role",
                        "matcher": "string",
                        "name": "string",
                        "nickname": true,
                        "color": "string",
                        "id": "string",
                        "sortOrder": 0
                      },
                      "reaction": {
                        "id": 0,
                        "customReactionId": 0,
                        "customReaction": {
                          "id": 761262,
                          "name": "frog-donut",
                          "png": "https://s3-us-west-2.amazonaws.com/www.guilded.gg/CustomReaction/02f8bf8e57fb08568e9260461f34390c-Full.webp?w=120&h=120",
                          "webp": "https://s3-us-west-2.amazonaws.com/www.guilded.gg/CustomReaction/02f8bf8e57fb08568e9260461f34390c-Full.webp?w=120&h=120",
                          "apng": null
                        }
                      },
                      "channel": {
                        "id": "string"
                      },
                      "href": "string"
                    },
                    "leaves": [
                      {
                        "object": "leaf",
                        "text": "string",
                        "marks": [
                          {
                            "data": {},
                            "object": "mark",
                            "type": "bold"
                          }
                        ]
                      }
                    ]
                  }
                ],
                "": "string"
              }
            ]
          }
        },
        "customReactionId": 0,
        "customReaction": {
          "id": 761262,
          "name": "frog-donut",
          "png": "https://s3-us-west-2.amazonaws.com/www.guilded.gg/CustomReaction/02f8bf8e57fb08568e9260461f34390c-Full.webp?w=120&h=120",
          "webp": "https://s3-us-west-2.amazonaws.com/www.guilded.gg/CustomReaction/02f8bf8e57fb08568e9260461f34390c-Full.webp?w=120&h=120",
          "apng": null
        }
      }
    }
  ],
  "bots": [
    null
  ],
  "webhooks": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "E-102 Gamma",
      "teamId": "WlVr3Gl",
      "iconUrl": "https://img.guildedcdn.com/UserAvatar/d741d0194d8570fc6df9f9445371093c-Medium.png?w=240&h=240",
      "channelId": "00000000-0000-0000-0000-000000000000",
      "deletedAt": null
    }
  ]
}