List user

GET /v2/Services/{ServiceSid}/Users

TODO: Resource-level docs

Path parameters

ServiceSid string Required

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
  
  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
  
  account_sid string | null
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.
  
  attributes string | null
  
  date_created string(date-time) | null
  
  date_updated string(date-time) | null
  
  friendly_name string | null
  
  identity string | null
  
  is_notifiable boolean | null
  
  is_online boolean | null
  
  joined_channels_count integer | null
  
  links object(uri-map) | null
  
  role_sid string | null
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RL[0-9a-fA-F]{32}$.
  
  service_sid string | null
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.
  
  sid string | null
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^US[0-9a-fA-F]{32}$.
  
  url string(uri) | null

GET /v2/Services/{ServiceSid}/Users

curl \
 -X GET https://ip-messaging.twilio.com/v2/Services/{ServiceSid}/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",
      "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,
      "joined_channels_count": 42,
      "links": {},
      "role_sid": "string",
      "service_sid": "string",
      "sid": "string",
      "url": "https://example.com"
    }
  ]
}