Path parameters

• ChatServiceSid string Required

  The SID of the Conversation Service to read the User resources from.

Query parameters

• PageSize integer

  How many resources to return in each list page. The default is 50, and the maximum is 1000.

  Minimum value is 1, maximum value is 1000.

Responses

• 200

  OK

  Hide response attributes Show response attributes object

  • meta object
    Hide meta attributes Show meta attributes object

    • first_page_url string(uri)
    • key string
    • next_page_url string(uri)
    • page integer
    • page_size integer
    • previous_page_url string(uri)
    • url string(uri)
  • users array[object]
    Hide users attributes Show users attributes array[object]

    • account_sid string | null

      The SID of the Account that created the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • attributes string | null

      The JSON Object string that stores application-specific data

    • chat_service_sid string | null

      The SID of the Conversation Service that the resource is associated with

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.

    • date_created string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was created

    • date_updated string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was last updated

    • friendly_name string | null

      The string that you assigned to describe the resource

    • identity string | null

      The string that identifies the resource's User

    • is_notifiable boolean | null

      Whether the User has a potentially valid Push Notification registration for this Conversations Service

    • is_online boolean | null

      Whether the User is actively connected to this Conversations Service and online

    • links object(uri-map) | null
    • role_sid string | null

      The SID of a service-level Role assigned to the user

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RL[0-9a-fA-F]{32}$.

    • sid string | null

      The unique string that identifies the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^US[0-9a-fA-F]{32}$.

    • url string(uri) | null

      An absolute URL for this user.