GEgetstream
product:chat

Query deleted channels

Changed on

Lists soft-deleted channels, ordered by created_at. Server-side only. Without a filter it lists every soft-deleted channel of the app; filter by team to scope it to one tenant. To permanently remove the returned channels, pass their cids to Delete channels (POST /channels/delete) with hard_delete set to true; the single-channel Delete channel endpoint does not accept soft-deleted channels.

post/channels/deleted

Request

  • Base URL
    https://chat.stream-io-api.com
  • URL
    https://chat.stream-io-api.com/channels/deleted
  • Auth
    • API key in header Authorization and API key in query parameter api_key and API key in header Stream-Auth-Type
    • or API key in query parameter api_key and API key in header Stream-Auth-Type

Request body

filter_conditionsobject

Optional filter. Omit it, or pass {}, to list every soft-deleted channel of the app; for example {"team": "tenant-a"} narrows to one tenant

limitinteger

Number of channels per page, 1-100 (default 25)

nextstring

Cursor for the next page, from the previous response

prevstring

Cursor for the previous page, from the previous response

Response

Successful response

durationstring required

Duration of the request in milliseconds

nextstring
prevstring

Example response

{
  "channels": [
    {
      "config": {
        "partition_ttl": "24h"
      }
    }
  ]
}

Changes