PluralBuddyPluralBuddy
API References

List system alters

GET
/v1/users/{user}/system/list-alters

List data about alters in a system. {user} can be @me to target the current OAuth user. This endpoint does allow for external system tag data (if achievable in conjunction with the system's privacy settings and the logged in OAuth user).

Authorization

oAuth2 alters:read
AuthorizationBearer <token>

OAuth 2.1 authentication

In: header

Scope: alters:read

Path Parameters

user*string

{user} is a Discord user Snowflake, or @me, referencing the current OAuth user.

Query Parameters

max?number

How many entries to show at most if in a pagination. Can only be at most 250 alters.

Rangevalue <= 250
skip?number

How many entries to skip if in a pagination.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/users/string/system/list-alters"
[  {    "alterId": 0,    "systemId": "string",    "username": "string",    "displayName": "string",    "nameMap": [      {        "server": "string",        "name": "string"      }    ],    "color": "string",    "description": "string",    "created": "2019-08-24T14:15:22Z",    "pronouns": "string",    "avatarUrl": "string",    "avatarUrlMap": {},    "webhookAvatarUrl": "string",    "banner": "string",    "lastMessageTimestamp": "2019-08-24T14:15:22Z",    "messageCount": 0,    "alterMode": "nickname",    "proxyTags": [],    "tagIds": [],    "public": 0,    "flags": 0,    "fields": {}  }]

How is this guide?