Fetch a frontline user

GET /v1/Users/{Sid}
Account sid auth token

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

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

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

      The unique string that we created to identify the User resource.

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

    • identity string | null

      The application-defined string that uniquely identifies the resource's User. This value is often a username or an email address, and is case-sensitive.

    • friendly_name string | null

      The string that you assigned to describe the User.

    • avatar string | null

      The avatar URL which will be shown in Frontline application.

    • state string

      Current state of this user. Can be either active or deactivated and defaults to active

      Values are active or deactivated.

    • is_available boolean | null

      Whether the User is available for new conversations. Defaults to false for new users.

    • url string(uri) | null

      An absolute API resource URL for this user.
GET /v1/Users/{Sid} 
curl \
 --request GET 'https://frontline-api.twilio.com/v1/Users/{Sid}' \
 --user "username:password"
Response examples (200) 
{
  "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://frontline-api.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "state": "active",
  "avatar": "https://example.com/profile.png",
  "identity": "john@example.com",
  "is_available": true,
  "friendly_name": "John Doe"
}