Skip to main content

chat.bsky.convo.listConvos

GET 

/xrpc/chat.bsky.convo.listConvos

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

    limit integer

    Possible values: >= 1 and <= 100

    Default value: 50

    cursor string

Responses

OK

Schema

    cursor string

    convos

    object[]

    required

  • Array [

  • 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

    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

    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: &lt; 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

    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

    did didrequired
  • ]

  • ]

  • embed

    object

    oneOf

    record

    object

    required

    oneOf

    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

    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

    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

    images

    object[]

    required

    Possible values: &lt; 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

  • ]

  • ]

  • indexedAt date-timerequired

    sender

    object

    required

    did didrequired
    sentAt date-timerequired
    muted booleanrequired
    unreadCount integerrequired
  • ]

Loading...