Skip to main content

List stream members

GET 
/api/streams/{stream_id}/members
warning

Requires Streams to be enabled in company settings.

Required permissions:

  • settings.company: allows listing stream members.

Request​

Path Parameters

    stream_id stringrequired

    Possible values: Value must match regular expression [0-9]+

    The ID of the stream

Query Parameters

    limit integer

    Possible values: >= 1 and <= 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.

    Operators:

    Usage: eq:{value}

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 stream members.

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

    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...