Skip to content

Document user guild tags #6836

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jul 1, 2025
Merged

Document user guild tags #6836

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
96a6b93
[primary guild] Add documentation for user primary guild.
hammerdr May 2, 2024
b359b29
Fix links
kirbycool Jun 24, 2025
16d23a6
"object"
advaith1 Jun 24, 2025
6faeb15
Update badge path and add null identity_enabled explainer.
kirbycool Jul 1, 2025
96e17b6
Clarify null case
kirbycool Jul 1, 2025
5b010b7
Update guild tag badge name
kirbycool Jul 1, 2025
ff3ef27
Fix tables
kirbycool Jul 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,7 @@ Discord uses ids and hashes to render images in the client. These hashes can be
| Role Icon | role-icons/[role_id](/docs/topics/permissions#role-object)/[role_icon](/docs/topics/permissions#role-object).png | PNG, JPEG, WebP |
| Guild Scheduled Event Cover | guild-events/[scheduled_event_id](/docs/resources/guild-scheduled-event#guild-scheduled-event-object)/[scheduled_event_cover_image](/docs/resources/guild-scheduled-event#guild-scheduled-event-object).png | PNG, JPEG, WebP |
| Guild Member Banner | guilds/[guild_id](/docs/resources/guild#guild-object)/users/[user_id](/docs/resources/user#user-object)/banners/[member_banner](/docs/resources/guild#guild-member-object).png \* | PNG, JPEG, WebP, GIF |
| Server Tag Badge | clan-badges/[guild_id](/docs/resources/guild#guild-object)/[badge_hash](/docs/resources/user#user-object-user-primary-guild).png \* | PNG, JPEG, WebP |
Copy link

@ooliver1 ooliver1 Jun 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what the asterisk is doing here, as this does not support GIFs, and the asterisk isn't present in the icon routes for example. Just to improve clarity.


\* In the case of endpoints that support GIFs, the hash will begin with `a_` if it is available in GIF format. These images can also be retrieved as animated WebP using the `?animated=true` querystring parameter. (example: `a_1269e74af4df7417b13759eae50c83dc`)

Expand Down
16 changes: 16 additions & 0 deletions docs/resources/user.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ There are other rules and restrictions not shared here for the sake of spam and
| public_flags? | integer | the public [flags](/docs/resources/user#user-object-user-flags) on a user's account | identify |
| avatar_decoration_data? | ?[avatar decoration data](/docs/resources/user#avatar-decoration-data-object) object | data for the user's avatar decoration | identify |
| collectibles? | ?[collectibles](/docs/resources/user#collectibles) object | data for the user's collectibles | identify |
| primary_guild? | ?[user primary guild](/docs/resources/user#user-object-user-primary-guild) object | the user's primary guild | identify |

###### Example User

Expand Down Expand Up @@ -75,6 +76,12 @@ There are other rules and restrictions not shared here for the sake of spam and
"label": "",
"palette": "cobalt"
}
},
"primary_guild": {
"identity_guild_id": "1234647491267808778",
"identity_enabled": true,
"tag": "DISC",
"badge": "7d1734ae5a615e82bc7a4033b98fade8"
}
}
```
Expand Down Expand Up @@ -110,6 +117,15 @@ Premium types denote the level of premium a user has. Visit the [Nitro](https://
| 2 | Nitro |
| 3 | Nitro Basic |

###### User Primary Guild

| Field | Type | Description |
|-------------------|------------|---------------------------------------------------------------|
| identity_guild_id | ?snowflake | the id of the user's primary guild |
| identity_enabled | ?boolean | whether the user is displaying the primary guild's server tag |
Copy link

@ooliver1 ooliver1 Jun 25, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really do think the behaviour of this being null meaning a new identity hasn't been affirmed should be documented. It is very unclear otherwise.

| tag | ?string | the text of the user's server tag. Limited to 4 characters |
| badge | ?string | the [server tag badge hash](/docs/reference#image-formatting) |

### Avatar Decoration Data Object

The data for the user's [avatar decoration](https://support.discord.com/hc/en-us/articles/13410113109911-Avatar-Decorations).
Expand Down