Fetch a frontline user

GET /v1/Users/{Sid}

A User resource represents a frontline user.

Fetch a frontline user

Path parameters

  • Sid string Required

    The SID of the User resource to fetch. This value can be either the sid or the identity of the User resource to fetch.

Responses

  • OK

    Hide response attributes Show response attributes object
    • avatar string | null

      The avatar URL which will be shown in Frontline application

    • friendly_name string | null

      The string that you assigned to describe the User

    • identity string | null

      The string that identifies the resource's User

    • is_available boolean | null

      Whether the User is available for new conversations

    • 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}$.

    • state string | null

      Current state of this user

      Values are active or deactivated.

    • url string(uri) | null

      An absolute URL for this user.

GET /v1/Users/{Sid}
curl \
 -X GET https://frontline-api.twilio.com/v1/Users/{Sid} \
 --user "username:password"
Response examples (200)
{
  "avatar": "string",
  "friendly_name": "string",
  "identity": "string",
  "is_available": true,
  "sid": "string",
  "state": "active",
  "url": "https://example.com"
}
Response examples (200)
{
  "avatar": "string",
  "friendly_name": "string",
  "identity": "string",
  "is_available": true,
  "sid": "string",
  "state": "active",
  "url": "https://example.com"
}