streams

Get stream attachments

Changed on

Spaces method and path for this operation:

<div><span class="operation-verb get">get</span>&nbsp;<span class="operation-path">/s/{space_id}/api/streams/{streamName}/attachments</span></div>

Refer to Spaces for more information.

Fetches all attachments linked to a stream that are visible to the current user in the current space. Optionally filter by attachment types, search query, and tags.<br/><br/>[Required authorization] Route required privileges: read_stream.

get/api/streams/{streamName}/attachments

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/streams/{streamName}/attachments
  • Auth
    • API key in header Authorization
    • or HTTP basic

Path parameters

streamNamestring required

The name of the stream

Query parameters

querystring

Search query to filter attachments by title

attachmentTypesstring[]

Filter by attachment types (single value or array)

tagsstring[]

Filter by tags (single value or array)

Request body

object required
OR
unknown required

Response

Successfully retrieved attachments

Changes

  • 3e7e7b646f2eRevision changes
    • warning

      for the path request parameter streamName, the maxLength was set to 200

    • warning

      for the query request parameter query, the maxLength was set to 1000

  • f4def03bd2afRevision changes
    • breaking

      removed subschema #2 from the request body anyOf list

    • info

      the request's body became nullable