chat.bsky.convo.getConvo

GET /xrpc/chat.bsky.convo.getConvo

This endpoint is part of the Bluesky Chat (DMs) APIs. Requests usually require authentication, are directed to the user's PDS intance, and proxied to the single central chat service by setting the appropriate service DID (did:web:api.bsky.chat) in the service proxying header.

To learn more about calling atproto API endpoints like this one, see the API Hosts and Auth guide.

Request

Query Parameters

convoId stringrequired

Responses

application/json

Schema
Example (from schema)

Schema

convo

object

required

id stringrequired

rev stringrequired

members

object[]

required

Array [

did didrequired

handle handlerequired

displayName string

Possible values: <= 640 characters

avatar uri

associated

object

lists integer

feedgens integer

starterPacks integer

labeler boolean

chat

object

allowIncoming stringrequired

Possible values: [all, none, following]

viewer

object

Metadata about the requesting account's relationship with the subject account. Only has meaningful content for authed requests.

muted boolean

mutedByList

object

uri at-urirequired

cid cidrequired

name stringrequired

Possible values: non-empty and <= 64 characters

purpose

object

required

oneOf

app.bsky.graph.defs.modlist
app.bsky.graph.defs.curatelist
app.bsky.graph.defs.referencelist

string

avatar uri

listItemCount integer

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

viewer

object

muted boolean

blocked at-uri

indexedAt date-time

blockedBy boolean

blocking at-uri

blockingByList

object

uri at-urirequired

cid cidrequired

name stringrequired

Possible values: non-empty and <= 64 characters

purpose

object

required

oneOf

app.bsky.graph.defs.modlist
app.bsky.graph.defs.curatelist
app.bsky.graph.defs.referencelist

string

avatar uri

listItemCount integer

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

viewer

object

muted boolean

blocked at-uri

indexedAt date-time

following at-uri

followedBy at-uri

knownFollowers

object

The subject's followers whom you also follow

count integerrequired

followers

object[]

required

Possible values: < 5

Array [

did didrequired

handle handlerequired

displayName string

Possible values: <= 640 characters

avatar uri

associated

object

lists integer

feedgens integer

starterPacks integer

labeler boolean

chat

object

allowIncoming stringrequired

Possible values: [all, none, following]

viewer

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

createdAt date-time

]

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

chatDisabled boolean

Set to true when the actor cannot actively participate in converations

]

lastMessage

object

oneOf

chat.bsky.convo.defs.messageView
chat.bsky.convo.defs.deletedMessageView

id stringrequired

rev stringrequired

text stringrequired

Possible values: <= 10000 characters

facets

object[]

Array [

index

object

required

Specifies the sub-string range a facet feature applies to. Start index is inclusive, end index is exclusive. Indices are zero-indexed, counting bytes of the UTF-8 encoded text. NOTE: some languages, like Javascript, use UTF-16 or Unicode codepoints for string slice indexing; in these languages, convert to byte arrays before working with facets.

byteStart integerrequired

byteEnd integerrequired

features

object[]

required

Array [

oneOf

app.bsky.richtext.facet.mention
app.bsky.richtext.facet.link
app.bsky.richtext.facet.tag

did didrequired

tag stringrequired

Possible values: <= 640 characters

]

embed

object

oneOf

app.bsky.embed.record.view

record

object

required

oneOf

app.bsky.embed.record.viewRecord
app.bsky.embed.record.viewNotFound
app.bsky.embed.record.viewBlocked
app.bsky.embed.record.viewDetached
app.bsky.feed.defs.generatorView
app.bsky.graph.defs.listView
app.bsky.labeler.defs.labelerView
app.bsky.graph.defs.starterPackViewBasic

uri at-urirequired

cid cidrequired

author

object

required

did didrequired

handle handlerequired

displayName string

Possible values: <= 640 characters

avatar uri

associated

object

lists integer

feedgens integer

starterPacks integer

labeler boolean

chat

object

allowIncoming stringrequired

Possible values: [all, none, following]

viewer

object

Metadata about the requesting account's relationship with the subject account. Only has meaningful content for authed requests.

muted boolean

mutedByList

object

uri at-urirequired

cid cidrequired

name stringrequired

Possible values: non-empty and <= 64 characters

purpose

object

required

oneOf

app.bsky.graph.defs.modlist
app.bsky.graph.defs.curatelist
app.bsky.graph.defs.referencelist

string

avatar uri

listItemCount integer

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

viewer

object

muted boolean

blocked at-uri

indexedAt date-time

blockedBy boolean

blocking at-uri

blockingByList

object

uri at-urirequired

cid cidrequired

name stringrequired

Possible values: non-empty and <= 64 characters

purpose

object

required

oneOf

app.bsky.graph.defs.modlist
app.bsky.graph.defs.curatelist
app.bsky.graph.defs.referencelist

string

avatar uri

listItemCount integer

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

viewer

object

muted boolean

blocked at-uri

indexedAt date-time

following at-uri

followedBy at-uri

knownFollowers

object

The subject's followers whom you also follow

count integerrequired

followers undefined[]required

Possible values: <= 5

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

createdAt date-time

value required

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

replyCount integer

repostCount integer

likeCount integer

quoteCount integer

embeds

object[]

Array [

oneOf

app.bsky.embed.images.view
app.bsky.embed.video.view
app.bsky.embed.external.view
app.bsky.embed.recordWithMedia.view

images

object[]

required

Possible values: < 4

Array [

thumb urirequired

Fully-qualified URL where a thumbnail of the image can be fetched. For example, CDN location provided by the App View.

fullsize urirequired

Fully-qualified URL where a large version of the image can be fetched. May or may not be the exact original blob. For example, CDN location provided by the App View.

alt stringrequired

Alt text description of the image, for accessibility.

aspectRatio

object

width:height represents an aspect ratio. It may be approximate, and may not correspond to absolute dimensions in any given unit.

width integerrequired

Possible values: >= 1

height integerrequired

Possible values: >= 1

]

cid cidrequired

playlist urirequired

thumbnail uri

alt string

Possible values: <= 10000 characters

aspectRatio

object

width:height represents an aspect ratio. It may be approximate, and may not correspond to absolute dimensions in any given unit.

width integerrequired

Possible values: >= 1

height integerrequired

Possible values: >= 1

record required

media

object

required

oneOf

app.bsky.embed.images.view
app.bsky.embed.video.view
app.bsky.embed.external.view

images

object[]

required

Possible values: < 4

Array [

thumb urirequired

Fully-qualified URL where a thumbnail of the image can be fetched. For example, CDN location provided by the App View.

fullsize urirequired

Fully-qualified URL where a large version of the image can be fetched. May or may not be the exact original blob. For example, CDN location provided by the App View.

alt stringrequired

Alt text description of the image, for accessibility.

aspectRatio

object

width:height represents an aspect ratio. It may be approximate, and may not correspond to absolute dimensions in any given unit.

width integerrequired

Possible values: >= 1

height integerrequired

Possible values: >= 1

]

cid cidrequired

playlist urirequired

thumbnail uri

alt string

Possible values: <= 10000 characters

aspectRatio

object

width:height represents an aspect ratio. It may be approximate, and may not correspond to absolute dimensions in any given unit.

width integerrequired

Possible values: >= 1

height integerrequired

Possible values: >= 1

]

indexedAt date-timerequired

uri at-urirequired

notFound booleanrequired

Default value: true

uri at-urirequired

blocked booleanrequired

Default value: true

author

object

required

did didrequired

viewer

object

Metadata about the requesting account's relationship with the subject account. Only has meaningful content for authed requests.

muted boolean

mutedByList

object

uri at-urirequired

cid cidrequired

name stringrequired

Possible values: non-empty and <= 64 characters

purpose

object

required

oneOf

app.bsky.graph.defs.modlist
app.bsky.graph.defs.curatelist
app.bsky.graph.defs.referencelist

string

avatar uri

listItemCount integer

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

viewer

object

muted boolean

blocked at-uri

indexedAt date-time

blockedBy boolean

blocking at-uri

blockingByList

object

uri at-urirequired

cid cidrequired

name stringrequired

Possible values: non-empty and <= 64 characters

purpose

object

required

oneOf

app.bsky.graph.defs.modlist
app.bsky.graph.defs.curatelist
app.bsky.graph.defs.referencelist

string

avatar uri

listItemCount integer

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

viewer

object

muted boolean

blocked at-uri

indexedAt date-time

following at-uri

followedBy at-uri

knownFollowers

object

The subject's followers whom you also follow

count integerrequired

followers

object[]

required

Possible values: < 5

Array [

did didrequired

handle handlerequired

displayName string

Possible values: <= 640 characters

avatar uri

associated

object

lists integer

feedgens integer

starterPacks integer

labeler boolean

chat

object

allowIncoming stringrequired

Possible values: [all, none, following]

viewer

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

createdAt date-time

]

uri at-urirequired

detached booleanrequired

Default value: true

uri at-urirequired

cid cidrequired

did didrequired

creator

object

required

did didrequired

handle handlerequired

displayName string

Possible values: <= 640 characters

description string

Possible values: <= 2560 characters

avatar uri

associated

object

lists integer

feedgens integer

starterPacks integer

labeler boolean

chat

object

allowIncoming stringrequired

Possible values: [all, none, following]

indexedAt date-time

createdAt date-time

viewer

object

Metadata about the requesting account's relationship with the subject account. Only has meaningful content for authed requests.

muted boolean

mutedByList

object

uri at-urirequired

cid cidrequired

name stringrequired

Possible values: non-empty and <= 64 characters

purpose

object

required

oneOf

app.bsky.graph.defs.modlist
app.bsky.graph.defs.curatelist
app.bsky.graph.defs.referencelist

string

avatar uri

listItemCount integer

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

viewer

object

muted boolean

blocked at-uri

indexedAt date-time

blockedBy boolean

blocking at-uri

blockingByList

object

uri at-urirequired

cid cidrequired

name stringrequired

Possible values: non-empty and <= 64 characters

purpose

object

required

oneOf

app.bsky.graph.defs.modlist
app.bsky.graph.defs.curatelist
app.bsky.graph.defs.referencelist

string

avatar uri

listItemCount integer

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

viewer

object

muted boolean

blocked at-uri

indexedAt date-time

following at-uri

followedBy at-uri

knownFollowers

object

The subject's followers whom you also follow

count integerrequired

followers

object[]

required

Possible values: < 5

Array [

did didrequired

handle handlerequired

displayName string

Possible values: <= 640 characters

avatar uri

associated

object

lists integer

feedgens integer

starterPacks integer

labeler boolean

chat

object

allowIncoming stringrequired

Possible values: [all, none, following]

viewer

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

createdAt date-time

]

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

displayName stringrequired

description string

Possible values: <= 3000 characters

descriptionFacets

object[]

Array [

index

object

required

byteStart integerrequired

byteEnd integerrequired

features

object[]

required

Array [

oneOf

app.bsky.richtext.facet.mention
app.bsky.richtext.facet.link
app.bsky.richtext.facet.tag

did didrequired

tag stringrequired

Possible values: <= 640 characters

]

avatar uri

likeCount integer

acceptsInteractions boolean

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

viewer

object

like at-uri

indexedAt date-timerequired

uri at-urirequired

cid cidrequired

creator

object

required

did didrequired

handle handlerequired

displayName string

Possible values: <= 640 characters

description string

Possible values: <= 2560 characters

avatar uri

associated

object

lists integer

feedgens integer

starterPacks integer

labeler boolean

chat

object

allowIncoming stringrequired

Possible values: [all, none, following]

indexedAt date-time

createdAt date-time

viewer

object

Metadata about the requesting account's relationship with the subject account. Only has meaningful content for authed requests.

muted boolean

mutedByList

object

uri at-urirequired

cid cidrequired

name stringrequired

Possible values: non-empty and <= 64 characters

purpose

object

required

oneOf

app.bsky.graph.defs.modlist
app.bsky.graph.defs.curatelist
app.bsky.graph.defs.referencelist

string

avatar uri

listItemCount integer

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

viewer

object

muted boolean

blocked at-uri

indexedAt date-time

blockedBy boolean

blocking at-uri

blockingByList

object

uri at-urirequired

cid cidrequired

name stringrequired

Possible values: non-empty and <= 64 characters

purpose

object

required

oneOf

app.bsky.graph.defs.modlist
app.bsky.graph.defs.curatelist
app.bsky.graph.defs.referencelist

string

avatar uri

listItemCount integer

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

viewer

object

muted boolean

blocked at-uri

indexedAt date-time

following at-uri

followedBy at-uri

knownFollowers

object

The subject's followers whom you also follow

count integerrequired

followers

object[]

required

Possible values: < 5

Array [

did didrequired

handle handlerequired

displayName string

Possible values: <= 640 characters

avatar uri

associated

object

lists integer

feedgens integer

starterPacks integer

labeler boolean

chat

object

allowIncoming stringrequired

Possible values: [all, none, following]

viewer

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

createdAt date-time

]

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

name stringrequired

Possible values: non-empty and <= 64 characters

purpose

object

required

oneOf

app.bsky.graph.defs.modlist
app.bsky.graph.defs.curatelist
app.bsky.graph.defs.referencelist

string

description string

Possible values: <= 3000 characters

descriptionFacets

object[]

Array [

index

object

required

byteStart integerrequired

byteEnd integerrequired

features

object[]

required

Array [

oneOf

app.bsky.richtext.facet.mention
app.bsky.richtext.facet.link
app.bsky.richtext.facet.tag

did didrequired

tag stringrequired

Possible values: <= 640 characters

]

avatar uri

listItemCount integer

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

viewer

object

muted boolean

blocked at-uri

indexedAt date-timerequired

uri at-urirequired

cid cidrequired

creator

object

required

did didrequired

handle handlerequired

displayName string

Possible values: <= 640 characters

description string

Possible values: <= 2560 characters

avatar uri

associated

object

lists integer

feedgens integer

starterPacks integer

labeler boolean

chat

object

allowIncoming stringrequired

Possible values: [all, none, following]

indexedAt date-time

createdAt date-time

viewer

object

Metadata about the requesting account's relationship with the subject account. Only has meaningful content for authed requests.

muted boolean

mutedByList

object

uri at-urirequired

cid cidrequired

name stringrequired

Possible values: non-empty and <= 64 characters

purpose

object

required

oneOf

app.bsky.graph.defs.modlist
app.bsky.graph.defs.curatelist
app.bsky.graph.defs.referencelist

string

avatar uri

listItemCount integer

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

viewer

object

muted boolean

blocked at-uri

indexedAt date-time

blockedBy boolean

blocking at-uri

blockingByList

object

uri at-urirequired

cid cidrequired

name stringrequired

Possible values: non-empty and <= 64 characters

purpose

object

required

oneOf

app.bsky.graph.defs.modlist
app.bsky.graph.defs.curatelist
app.bsky.graph.defs.referencelist

string

avatar uri

listItemCount integer

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

viewer

object

muted boolean

blocked at-uri

indexedAt date-time

following at-uri

followedBy at-uri

knownFollowers

object

The subject's followers whom you also follow

count integerrequired

followers

object[]

required

Possible values: < 5

Array [

did didrequired

handle handlerequired

displayName string

Possible values: <= 640 characters

avatar uri

associated

object

lists integer

feedgens integer

starterPacks integer

labeler boolean

chat

object

allowIncoming stringrequired

Possible values: [all, none, following]

viewer

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

createdAt date-time

]

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

likeCount integer

viewer

object

like at-uri

indexedAt date-timerequired

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

uri at-urirequired

cid cidrequired

record required

creator

object

required

did didrequired

handle handlerequired

displayName string

Possible values: <= 640 characters

avatar uri

associated

object

lists integer

feedgens integer

starterPacks integer

labeler boolean

chat

object

allowIncoming stringrequired

Possible values: [all, none, following]

viewer

object

Metadata about the requesting account's relationship with the subject account. Only has meaningful content for authed requests.

muted boolean

mutedByList

object

uri at-urirequired

cid cidrequired

name stringrequired

Possible values: non-empty and <= 64 characters

purpose

object

required

oneOf

app.bsky.graph.defs.modlist
app.bsky.graph.defs.curatelist
app.bsky.graph.defs.referencelist

string

avatar uri

listItemCount integer

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

viewer

object

muted boolean

blocked at-uri

indexedAt date-time

blockedBy boolean

blocking at-uri

blockingByList

object

uri at-urirequired

cid cidrequired

name stringrequired

Possible values: non-empty and <= 64 characters

purpose

object

required

oneOf

app.bsky.graph.defs.modlist
app.bsky.graph.defs.curatelist
app.bsky.graph.defs.referencelist

string

avatar uri

listItemCount integer

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

viewer

object

muted boolean

blocked at-uri

indexedAt date-time

following at-uri

followedBy at-uri

knownFollowers

object

The subject's followers whom you also follow

count integerrequired

followers undefined[]required

Possible values: <= 5

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

createdAt date-time

listItemCount integer

joinedWeekCount integer

joinedAllTimeCount integer

labels

object[]

Array [

ver integer

src didrequired

DID of the actor who created this label.

uri urirequired

AT URI of the record, repository (account), or other resource that this label applies to.

cid cid

Optionally, CID specifying the specific version of 'uri' resource this label applies to.

val stringrequired

Possible values: <= 128 characters

The short string name of the value or type of this label.

neg boolean

If true, this is a negation label, overwriting a previous label.

cts date-timerequired

Timestamp when this label was created.

exp date-time

Timestamp at which this label expires (no longer applies).

sig byte

Signature of dag-cbor encoded label.

]

indexedAt date-timerequired

sender

object

required

did didrequired

sentAt date-timerequired

muted booleanrequired

unreadCount integerrequired

{
  "convo": {
    "id": "string",
    "rev": "string",
    "members": [
      {
        "did": "string",
        "handle": "string",
        "displayName": "string",
        "avatar": "string",
        "associated": {
          "lists": 0,
          "feedgens": 0,
          "starterPacks": 0,
          "labeler": true,
          "chat": {
            "allowIncoming": "all"
          }
        },
        "viewer": {
          "muted": true,
          "mutedByList": {
            "uri": "string",
            "cid": "string",
            "name": "string",
            "purpose": "string",
            "avatar": "string",
            "listItemCount": 0,
            "labels": [
              {
                "ver": 0,
                "src": "string",
                "uri": "string",
                "cid": "string",
                "val": "string",
                "neg": true,
                "cts": "2024-11-07T00:27:30.595Z",
                "exp": "2024-11-07T00:27:30.595Z",
                "sig": "string"
              }
            ],
            "viewer": {
              "muted": true,
              "blocked": "string"
            },
            "indexedAt": "2024-11-07T00:27:30.595Z"
          },
          "blockedBy": true,
          "blocking": "string",
          "blockingByList": {
            "uri": "string",
            "cid": "string",
            "name": "string",
            "purpose": "string",
            "avatar": "string",
            "listItemCount": 0,
            "labels": [
              {
                "ver": 0,
                "src": "string",
                "uri": "string",
                "cid": "string",
                "val": "string",
                "neg": true,
                "cts": "2024-11-07T00:27:30.595Z",
                "exp": "2024-11-07T00:27:30.595Z",
                "sig": "string"
              }
            ],
            "viewer": {
              "muted": true,
              "blocked": "string"
            },
            "indexedAt": "2024-11-07T00:27:30.595Z"
          },
          "following": "string",
          "followedBy": "string",
          "knownFollowers": {
            "count": 0,
            "followers": [
              {
                "did": "string",
                "handle": "string",
                "displayName": "string",
                "avatar": "string",
                "associated": {
                  "lists": 0,
                  "feedgens": 0,
                  "starterPacks": 0,
                  "labeler": true,
                  "chat": {
                    "allowIncoming": "all"
                  }
                },
                "labels": [
                  {
                    "ver": 0,
                    "src": "string",
                    "uri": "string",
                    "cid": "string",
                    "val": "string",
                    "neg": true,
                    "cts": "2024-11-07T00:27:30.595Z",
                    "exp": "2024-11-07T00:27:30.595Z",
                    "sig": "string"
                  }
                ],
                "createdAt": "2024-11-07T00:27:30.595Z"
              }
            ]
          }
        },
        "labels": [
          {
            "ver": 0,
            "src": "string",
            "uri": "string",
            "cid": "string",
            "val": "string",
            "neg": true,
            "cts": "2024-11-07T00:27:30.596Z",
            "exp": "2024-11-07T00:27:30.596Z",
            "sig": "string"
          }
        ],
        "chatDisabled": true
      }
    ],
    "lastMessage": {},
    "muted": true,
    "unreadCount": 0
  }
}

Bad Request

application/json

Schema
Example (from schema)

Schema

error stringrequired

Possible values: [InvalidRequest, ExpiredToken, InvalidToken]

message stringrequired

{
  "error": "InvalidRequest",
  "message": "string"
}

Unauthorized

application/json

Schema
Example (from schema)

Schema

error required

message stringrequired

{
  "message": "string"
}

chat.bsky.convo.getConvo

/xrpc/chat.bsky.convo.getConvo

Request​

Query Parameters

Responses​

Request

Responses