Skip to main content

lib/slack/web/docs/conversations.members.json

{
  "desc": "Returns a paginated list of members party to a conversation.",

  "args": {
    "channel": {
      "example" : "G1234567890",
      "required": true,
      "desc"    : "ID of the conversation to retrieve members for"
    },
    "cursor": {
      "example" : "dXNlcjpVMDYxTkZUVDI=",
      "required": false,
      "desc"    : "Paginate through collections of data by setting the cursor parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See pagination for more detail."
    },
    "exclude_archived": {
      "example" : "true",
      "required": false,
      "desc"    : "Set this to `true` to exclude archived channels from the list",
      "default" : "false"
    },
    "limit": {
      "example" : 20,
      "required": false,
      "desc"    : "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.",
      "default" : 100
    }
  },

  "errors": {
    "method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.",
    "channel_not_found": "Value passed for `channel` was invalid.",
    "invalid_limit": "Value passed for `limit` was invalid.",
    "invalid_cursor": "Value passed for `cursor` was invalid.",
    "fetch_members_failed": "Failed to fetch members for the conversation."
  }
}