Skip to main content

List streams

GET 
/api/streams

List streams

Request​

Query Parameters

    limit integer

    Possible values: <= 100

    Default value: 100

    The number of items to include in the response.

    offset integer

    Default value: 0

    The offset of the first returned item.

    updated_at date-time

    Filter items by the updated_at field. This is in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    Examples:

    Filter items updated on a date.

    Example: 2024-01-01T20:00:00%2B02:00

    is_archived boolean

    Whether to filter archived streams or not.

    include string

    Possible values: [streamLeaders, streamMembers]

    Comma separated list of relations to include in the response.

    search string

    Keyword to search for in the stream name.

Header Parameters

    Wethod-Company stringrequired

    The company you want to interact with

    Wethod-Version stringrequired

    The API version you want to use

Responses​

Returns the list of streams set for the company.

Schema

  • Array [

    • id integerrequired

    Possible values: >= 1

    The unique identifier of the resource

    created_at date-timerequired

    The date and time when the resource was created

    updated_at date-timerequired

    The date and time when the resource was last updated

    name stringrequired

    Possible values: <= 255 characters

    The stream name

    is_default boolrequired

    Whether this stream is the default one

    archived_at date-time

    The date and time when the resource was archived

    stream_leaders

    object[]

    The list of stream leaders associated with this stream

  • Array [

    • id integerrequired

    Possible values: >= 1

    The unique identifier of the resource

    created_at date-timerequired

    The date and time when the resource was created

    updated_at date-timerequired

    The date and time when the resource was last updated

    stream_id integerrequired

    Possible values: >= 1

    The ID of the stream

    leader_id integerrequired

    Possible values: >= 1

    The ID of the person attached to the stream as leader

    deleted_at date-time

    The date and time when the resource was deleted

  • ]

    • stream_members

    object[]

    The list of stream members associated with this stream

  • Array [

    • id integerrequired

    Possible values: >= 1

    The unique identifier of the resource

    created_at date-timerequired

    The date and time when the resource was created

    updated_at date-timerequired

    The date and time when the resource was last updated

    stream_id integerrequired

    Possible values: >= 1

    The ID of the stream

    member_id integerrequired

    Possible values: >= 1

    The ID of the person attached to the stream as member

    starts_at date

    The start date of the association

    ends_at date

    The end date of the association

  • ]

  • ]

Loading...