Retrieve a list of all conversation users in your service

GET /v1/Services/{ChatServiceSid}/Users

A Service User resource represents a conversation user belonging to a specific conversation service.

Retrieve a list of all conversation users in your service

Path parameters

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
    • users array[object]
      Hide users attributes Show users attributes
      • 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.
GET /v1/Services/{ChatServiceSid}/Users 
curl \
 -X GET https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Users \
 --user "username:password"
Response examples (200) 
{
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  },
  "users": [
    {
      "account_sid": "string",
      "attributes": "string",
      "chat_service_sid": "string",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "friendly_name": "string",
      "identity": "string",
      "is_notifiable": true,
      "is_online": true,
      "links": {},
      "role_sid": "string",
      "sid": "string",
      "url": "https://example.com"
    }
  ]
}