User

created_at
Type: stringFormat: date-time
read-only
required

The date and time (UTC) that the user was created.
first_name
Type: string
required

First name of user
id
Type: integerFormat: int64
required

Unique identifier for the given user.
is_online
Type: boolean
read-only
required

Whether the user currently has Pronto open on at least one device.

Presence changes frequently. To track it as it changes, subscribe to the user.online and user.offline webhook events instead of polling.
last_name
Type: string
required

Last name of user
last_presence_at
Type: string | nullFormat: date-time
read-only
required

The date and time (UTC) the user last came online or went offline. null if the user has never connected.
profile_pic_url
Type: string | null
required

The user's profile picture. This URL can be fetched directly without an access token, and expires. It is valid for at least 24 hours after being returned. Do not store it long-term; request the resource again for a fresh URL.
role
Type: stringenum
required

Organization level role of user

values
adminmanagerusersupportsystem
updated_at
Type: stringFormat: date-time
read-only
required

The date and time (UTC) that the user was last updated.
badge_count
Type: integer

The badge_count property is only available through certain endpoints that support the include=badge_count query parameter. See the endpoint documentation for details and required scopes.
deactivated_at
Type: string | nullFormat: date-time

The date-time stamp at which the user was deactivated.

Visible only with org-users-read for others or profile-read scope for yourself.
email
Type: string | nullFormat: email

Email address of user

Visible only with org-users-read for others or profile-read scope for yourself.
external_id
Type: string | null

The ID used by the external source that this user is generated by (Blackboard, Canvas, etc)

Visible only with org-users-read for others or profile-read scope for yourself.
locked
Type: boolean

Whether the user is locked from changes due to being managed by an external service

Visible only with org-users-read for others or profile-read scope for yourself.
muted
Type: boolean

Whether the user has muted their notifications across all chats.

Only present on your own user when the token has the users-read or users-write scope, or on any user when the requesting user is an org admin with an org-level users scope.
muted_expires_at
Type: string | nullFormat: date-time

The date and time (UTC) that the mute expires, or null if the mute does not expire.

Only present on your own user when the token has the users-read or users-write scope, or on any user when the requesting user is an org admin with an org-level users scope.
notification_preference
Type: stringenum

Which messages trigger notifications for the user by default. Chat memberships set to DEFAULT_INHERIT inherit this value.

Only present on your own user when the token has the users-read or users-write scope, or on any user when the requesting user is an org admin with an org-level users scope.

values
ALLMENTIONSMENTIONS_EXCLUDE_ALLNONE
phone
Type: string | nullFormat: phone

Phone number of user in E.164 format.

See https://en.wikipedia.org/wiki/E.164 for details.

Visible only with org-users-read for others or profile-read scope for yourself.
pronouns
Type: string | null
max length:
40

The user's preferred pronouns. This field is not included unless the user pronouns feature is enabled for the organization.
reactions_notifications_enabled
Type: boolean

Whether the user receives notifications when someone reacts to their messages.

Only present on your own user when the token has the users-read or users-write scope, or on any user when the requesting user is an org admin with an org-level users scope.
title
Type: string | null
max length:
40

The users's title. This field is not included unless the user titles features is enabled for the organization.
welcome_sent_at
Type: string | nullFormat: date-time
read-only

The date and time (UTC) that the user was sent their last welcome message via email and/or phone. Not included in webhook event payloads.

Examples

{
  "id": 123456,
  "external_id": "d747948384aac79d4b9c88129e4835d5",
  "first_name": "John",
  "last_name": "Smith",
  "profile_pic_url": "https://somewhere.pronto.io/files/user/555/profilepic?pronto_time=-62169984000",
  "phone": "+18015551234",
  "email": "user@example.com",
  "role": "user",
  "is_online": true,
  "last_presence_at": "2026-09-23T18:05:53Z",
  "locked": false,
  "welcome_sent_at": "2021-07-22T18:05:54Z",
  "deactivated_at": "2021-07-23T18:55:53Z",
  "created_at": "2021-07-22T18:05:53Z",
  "updated_at": "2021-07-22T18:05:53Z"
}

Claim Task

Message