Returns badges issued to the authenticated user, organized by display slot. Also indicates which badges are currently selected in the user's chat profile.

GET

/xrpc/place.stream.badge.getIssuedBadges

Parameters

Query Parameters

streamer

DID of the streamer channel to compute the server badge against.

string format: did

DID of the streamer channel to compute the server badge against.

Responses

200

Success

object

server

Computed server badge (streamer, mod, or bot) for the given streamer context. Absent if the user has no server role.

object

badgeType

required

string

issuer

required

DID of the badge issuer.

string format: did

recipient

required

DID of the badge recipient.

string format: did

name

Display name from the badge definition.

string

description

Description from the badge definition.

string

imageUrl

Resolved image URL for the badge icon.

string format: uri

signature

TODO: Cryptographic signature of the badge (of a place.stream.key).

string

streamer

required

Streamer-issued badges (e.g. VIP) available to the user.

object

selected

The currently selected badge in this slot, if any.

object

issuanceUri

required

AT URI of the place.stream.badge.issuance record.

string format: uri

issuanceCid

CID of the place.stream.badge.issuance record.

string

badgeType

required

string

name

Display name from the badge definition.

string

description

Description from the badge definition.

string

imageUrl

Resolved image URL for the badge icon.

string format: uri

issuer

required

DID of the badge issuer.

string format: did

selected

Whether this badge is currently in the user’s chat profile selection.

boolean

available

required

All badges available for this slot.

Array<object>

A resolved view of a badge issuance, including def fields for display.

object

issuanceUri

required

AT URI of the place.stream.badge.issuance record.

string format: uri

issuanceCid

CID of the place.stream.badge.issuance record.

string

badgeType

required

string

name

Display name from the badge definition.

string

description

Description from the badge definition.

string

imageUrl

Resolved image URL for the badge icon.

string format: uri

issuer

required

DID of the badge issuer.

string format: did

selected

Whether this badge is currently in the user’s chat profile selection.

boolean

user

required

Globally-issued cosmetic badges (e.g. event) available to the user.

object

selected

The currently selected badge in this slot, if any.

object

issuanceUri

required

AT URI of the place.stream.badge.issuance record.

string format: uri

issuanceCid

CID of the place.stream.badge.issuance record.

string

badgeType

required

string

name

Display name from the badge definition.

string

description

Description from the badge definition.

string

imageUrl

Resolved image URL for the badge icon.

string format: uri

issuer

required

DID of the badge issuer.

string format: did

selected

Whether this badge is currently in the user’s chat profile selection.

boolean

available

required

All badges available for this slot.

Array<object>

A resolved view of a badge issuance, including def fields for display.

object

issuanceUri

required

AT URI of the place.stream.badge.issuance record.

string format: uri

issuanceCid

CID of the place.stream.badge.issuance record.

string

badgeType

required

string

name

Display name from the badge definition.

string

description

Description from the badge definition.

string

imageUrl

Resolved image URL for the badge icon.

string format: uri

issuer

required

DID of the badge issuer.

string format: did

selected

Whether this badge is currently in the user’s chat profile selection.

boolean