Sign in

v50

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-02-052210.6 KB
FrontlineV1User

Fetch a frontline user

Fetch a frontline user

get/v1/Users/{Sid}

Path parameters

Sidstring 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.

Response

OK

sidstring nullable

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

identitystring nullable

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_namestring nullable

The string that you assigned to describe the User.

avatarstring nullable

The avatar URL which will be shown in Frontline application.

state'active' | 'deactivated'

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

is_availableboolean nullable

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

urlstring uri nullable

An absolute API resource URL for this user.

All 2 operations