GEgetstream
product:chat

Search roles

Changed on

Searches mentionable roles (user-assignable + channel-assignable, built-in and custom) by name prefix for autocomplete

get/roles/search

Request

  • Base URL
    https://chat.stream-io-api.com
  • URL
    https://chat.stream-io-api.com/roles/search
  • 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

Query parameters

querystring required

Case-insensitive name prefix to match against role names

limitinteger

Maximum number of roles to return (1-25, default 10)

name_gtstring

Return roles with names strictly greater than this cursor (for pagination)

role_type'user' | 'channel'

Optional filter: 'user' for user-assignable roles, 'channel' for channel-assignable roles. Omit to return both.

include_global_rolesboolean

When true, include cross-team operator roles whose name starts with 'global_'. Defaults to false.

Response

Successful response

durationstring required

Changes