Enums index

ChatType

Possible values:

• direct

• group

• task

GroupStatus

Possible values:

• admin

• member

MarkupType

Possible values:

• bold

• italic

• underscore

• strike

• code

• codeblock

• quote

• link

• time

• unsafe

Mediasubtype

Possible values:

• sticker

• newtask

Mediatype

Possible values:

• plain

• change

• deleted

• file

• image

• video

• audiomsg

• contact

• pdf

TeamStatus

Possible values:

• owner

• admin

• member

• guest

UploadMediaType

Possible values:

• file

• image

• video

• audio

• imagefile

Type aliases

ActiveUserDailyStatList

Base Type: ActiveUserDailyStat

Is array

BotCommands

Bot commands list

Base Type: BotCommand

Is array

Err

Base Type: string

ISODateTimeString

Date and time in RFC3339 format. Example: 2019-09-18T00:00:07.435409Z

Base Type: string

JID

Base Type: string

MessageLinks

Base Type: MessageLink

Is array

PushDeviceType

Base Type: int

RGBColor

Color in #rrggbb format where rr, gg, bb are hexadecimal numbers from 00 to ff of red, green and blue channels correspondingly. (yellow would be #ffff00)

Base Type: string

SharpLinks

#-links autocomplete response

Base Type: SharpLink

Is array

TaskFilterKey

Base Type: string

TaskSortKey

Base Type: string

TaskTabKey

Base Type: string

JSON objects index

BotCommand

Bot commands information

Fields:
key (string) — What should be inserted to the chat
title (string) — What should be visible by user
args (array[string]) — Command options, if any

ButtonColors

ButtonColors button colors for app

Fields:
brand_static (RGBColor) — Brand static color
brand_active (RGBColor) — Brand active color
brand_disable (RGBColor) — Brand disable color
simple_static (RGBColor) — Simple static color
simple_active (RGBColor) — Simple active color
simple_disable (RGBColor) — Simple disable color

CallDevice

Call participant device

Fields:
muted (boolean) — Device muted
useragent (string) — Device description

CallOnliner

Call participant

Fields:
jid (JID) — Contact id
display_name (string) — Contact name
role (string) — Contact role
icon (string) — Contact icon
muted (boolean) — Microphone muted. Computed from devices muted states
devices (array[CallDevice]) — Member devices, strictly one for now

Chat

Chat (direct, group, task) representation

Fields:
jid (JID) — Group/Task/Contact id
chat_type (ChatType) — Chat type
base_gentime (number) 💥 — Base fields (not related to concrete participant) version
gentime (number) — Chat fields related to concrete participant) version
created (string) — Creation date, iso datetime
display_name (string) — Title
icons (IconData) — Icons info
counters_enabled (boolean) 💥 — Include unread messages to counters
can_call (boolean) 💥 — Can I call to this chat
can_send_message (boolean) 💥 — Can I send message to this chat
cant_send_message_reason (string) 💥 — Why I can’t send message to this chat (if can’t)
collapsed (boolean) 💥 — Description collapsed. Used for tasks only
draft (string) 💥 — Last message draft, if any
draft_gentime (number) 💥 — Last message draft version, if any
hidden (boolean) 💥 — Hidden chat
notifications_enabled (boolean) 💥 — Push notifications enabled
num_importants (number) 💥 — Number of important messages
num_unread (number) 💥 — Unread counter
num_unread_notices (number) 💥 — Mentions (@) counter
last_message (Message) 💥 — Last message object
last_read_message_id (string) 💥 — Last read message id, if any
section (string) 💥 — Project / section id, if any
changeable_fields (array[string]) 💥 — List of editable fields
pinned (boolean) 💥 — Is chat pinned on top
pinned_sort_ordering (number) 💥 — Sort ordering for pinned chat
num_members (number) 💥 — Non-archive participants number
can_delete (boolean) 💥 — Can I delete this chat
description (string) 💥 — Group or task description
markup (array[MarkupEntity]) 💥 — Markup entities for description field. Experimental
feed (boolean) 💥 — Present in feed (main screen)
pinned_message (Message) 💥 — Pinned message for this chat
color_index (number) 💥 — Custom color index from table of colors. Tasks only
num_items (number) 💥 — Items in checklist. Tasks only
num_checked_items (number) 💥 — Checked items in checklist. Tasks only
assignee (JID) 💥 — Assignee contact id. Tasks only
num (number) 💥 — Task number in this team
observers (array[JID]) 💥 — Task followers id’s. TODO: rename to “followers”
owner (JID) 💥 — Task creator
task_status (string) 💥 — Task status. May be custom
title (string) 💥 — Task title. Generated from number and description
done (string) 💥 — Task done date in iso format, if any
done_reason (string) 💥 — Task done reason, if any
deadline (string) 💥 — Task deadline in iso format, if any
deadline_expired (boolean) 💥 — Is task deadline expired
links (MessageLinks) 💥 — Links in description
tags (array[string]) 💥 — Task tags list, if any
importance (number) 💥 — Task importance, if available in team
urgency (number) 💥 — Task urgency, if available in team
spent_time (number) 💥 — Task spent time, number
complexity (number) 💥 — Task complexity, number
linked_messages (array[any]) 💥 — Used for “Create task from messages…”
uploads (array[Upload]) 💥 — Upload uids for request, upload objects for response
items (array[TaskItem]) 💥 — Checklist items. Task only
parents (array[Subtask]) 💥 — Parent tasks
tabs (array[TaskTabKey]) 💥 — Tab names
status (GroupStatus) 💥 — My status in group chat
members (array[GroupMembership]) 💥 — Group chat members
can_add_member (boolean) 💥 — Can I add member to this group chat
can_remove_member (boolean) 💥 — Can I remove member from this group chat
can_change_member_status (boolean) 💥 — Can I change member status in this group chat
can_change_settings (boolean) 💥 — deprecated: use changeable fields
default_for_all (boolean) 💥 — Any new team member will be added to this group chat
readonly_for_members (boolean) 💥 — Readonly for non-admins group chat (Like Channels in Telegram but switchable)
autocleanup_age (number) 💥 — Delete messages in this chat in seconds. Experimental function
public (boolean) 💥 — Can other team member see this task/group chat
can_join (boolean) 💥 — Can I join to this public group/task
can_delete_any_message (boolean) 💥 — Can I delete any message in this chat
can_set_important_any_message (boolean) 💥 — Can I change Important flag in any message in this chat
last_activity (string) 💥 — Date of the last message sent even if it was deleted
draft_num (number) 💥 — Deprecated

ChatShort

Minimal chat representation

Fields:
jid (JID) — Group/Task/Contact id
chat_type (ChatType) — Chat type
display_name (string) — Title
icons (IconData) — Icon data

ColorRule

Set of rules to apply to tasks for coloring

Fields:
uid (string) — Rule id
priority (number) — Rule priority
description (string) 💥 — Rule description
color_index (number) — Color index
section_enabled (boolean) 💥 — Project filter enabled
section (string) 💥 — Project id if project filter enabled
tags_enabled (boolean) 💥 — Tags filter enabled
tags (array[string]) 💥 — Tag ids if tags filter enabled
task_status (string) 💥 — Task status
task_importance_enabled (boolean) 💥 — Task importance filter enabled
task_importance (number) 💥 — Task importance if task importance filter enabled
task_urgency_enabled (boolean) 💥 — Task urgency filter enabled
task_urgency (number) 💥 — Task urgency if task urgency filter enabled

Contact

Contact

Fields:
jid (JID) — Contact Id
node (string) 💥 — Node uid for external users
display_name (string) — Full name in chats
short_name (string) — Short name in chats
contact_email (string) — Contact email in this team
contact_phone (string) — Contact phone in this team
icons (IconData) — Icons data
gentime (number) — Object version
role (string) — Role in this team
mood (string) 💥 — Mood in this team
status (TeamStatus) — Status in this team
last_activity (string) 💥 — Last activity in this team (iso datetime)
is_archive (boolean) 💥 — Contact deleted
botname (string) 💥 — Bot name. Empty for users
sections (array[string]) — Section ids
can_send_message (boolean) 💥 — Can I send message to this contact
cant_send_message_reason (string) 💥 — Why I can’t send message to this chat (if can’t)
can_call (boolean) 💥 — Can I call to this contact
can_create_task (boolean) 💥 — Can I create task for this contact
can_import_tasks (boolean) 💥 — Can I import tasks in this team
can_add_to_group (boolean) 💥 — Can I add this contact to group chats
can_delete (boolean) 💥 — Can I remove this contact from team
changeable_fields (array[string]) 💥 — Changeable fields
family_name (string) 💥 — Family name
given_name (string) 💥 — Given name
patronymic (string) 💥 — Patronymic, if any
default_lang (string) 💥 — Default language code
debug_show_activity (boolean) 💥 — Enable debug messages in UI
dropall_enabled (boolean) 💥 — Enable remove all messages experimental features
alt_send (boolean) 💥 — Use Ctrl/Cmd + Enter instead Enter
asterisk_mention (boolean) 💥 — Use * as @ for mentions
always_send_pushes (boolean) 💥 — Send push notifications even contact is online
hide_pushes_content (boolean) 💥 — Hide pushes body
timezone (string) 💥 — Timezone, if any
quiet_time_start (string) 💥 — Quiet time start
quiet_time_finish (string) 💥 — Quiet time finish
focus_until (string) 💥 — Focus mode enabled until
group_notifications_enabled (boolean) 💥 — Push notifications for group chats
task_notifications_enabled (boolean) 💥 — Push notifications for task chats
contact_short_view (boolean) 💥 — Short view in contact list
group_short_view (boolean) 💥 — Short view in group list
task_short_view (boolean) 💥 — Short view in task list
contact_mshort_view (boolean) 💥 — Short view in contact list in mobile app
group_mshort_view (boolean) 💥 — Short view in group list in mobile app
auth_2fa_enabled (boolean) 💥 — Two-factor authentication is configured and confirmed
auth_2fa_status (string) 💥 — Two-factor authentication status
task_mshort_view (boolean) 💥 — Short view in task list in mobile app
contact_show_archived (boolean) 💥 — Show archived contacts in contact list
unread_first (boolean) 💥 — Show unread chats first in feed
munread_first (boolean) 💥 — Show unread chats first in feed in mobile app
can_add_to_team (boolean) 💥 — Can I add new members to this team
can_manage_sections (boolean) 💥 — Can I manage contact sections in this team
can_manage_projects (boolean) 💥 — Can I manage task projects in this team
can_manage_tags (boolean) 💥 — Can I manage tags in this team
can_manage_integrations (boolean) 💥 — Can I manage integrations in this team
can_manage_color_rules (boolean) 💥 — Can I manage color rules in this team
can_create_group (boolean) 💥 — Can I create group chats in this team
can_join_public_groups (boolean) 💥 — Can I view/join public group in this team
can_join_public_tasks (boolean) 💥 — Can I view/join public tasks in this team
custom_fields (ContactCustomFields) 💥 — Extra contact fields
can_delete_any_message (boolean) 💥 — Deprecated

ContactCustomFields

Extra contact fields

Fields:
company (string) 💥 — Company
department (string) 💥 — Department
title (string) 💥 — Title
mobile_phone (string) 💥 — MobilePhone
source (string) 💥 — Import source
ad_uid (string) 💥 — User UUID in Active Directory

ContactShort

Short contact representation

Fields:
jid (JID) — Contact Id
display_name (string) — Full name in chats
short_name (string) — Short name in chats
icons (IconData) — Icons data
gentime (number) — Object version

Country

Country for phone numbers selection on login screen

Fields:
code (string) — Phone code
iso (string) — Country ISO code
name (string) — Country name
default (boolean) 💥 — Selected by default
popular (boolean) 💥 — Is popular, need to cache

DeletedChat

Minimal chat representation for deletion

Fields:
jid (JID) — Group/Task/Contact id
chat_type (ChatType) — Chat type
gentime (number) — Chat fields (related to concrete participant) version
is_archive (boolean) — Archive flag. Always true for this structure

DeletedRemind

Remind deleted message

Fields:
uid (string) — Remind id

DeletedSection

Deleted task project or contact section

Fields:
uid (string) — Section uid
gentime (number) — Object version

DeletedTag

Delete tag message

Fields:
uid (string) — Tag id

DeletedTeam

Team deletion message. Readonly

Fields:
uid (string) — Team id
is_archive (boolean) — Team deleted
gentime (number) — Object version

EasyApiMessage

Simple api for integrations /api/message or /tasks/[team]/[num]/message

Fields:
key (string) — Comma separated api keys (for /api/message calls only)
message (string) — Message text. Required
message_id (string) — Message uuid. Optional
nopreview (boolean) — Disable links preview
important (boolean) — Mark message as important
silently (boolean) — Disable counters and push notifications
convert_linebreaks (boolean) — Convert “\n” to “\n”

Emoji

Emoji

Fields:
char (string) — Unicode symbol
key (string) — Text representation

Features

Server information. Readonly

Fields:
host (string) — Current host
build (string) — Build/revision of server side
desktop_version (string) — Desktop application version
front_version (string) — Webclient version
app_title (string) — Application title
landing_url (string) 💥 — Landing page address, if any
app_schemes (array[string]) — Local applications urls
userver (string) — Static files server address
ios_app (string) — Link to AppStore
android_app (string) — Link to Google Play
ios_corp_app (string) — Link to AppStore for corporate app
android_corp_app (string) — Link to Google Play for corporate app
theme (string) — Default UI theme
min_ios_version (string) — Minimal iOS application version required for this server. Used for breaking changes
min_android_version (string) — Minimal android application version required for this server. Used for breaking changes
min_corp_ios_version (string) — Minimal iOS corp application version required for this server. Used for breaking changes
min_corp_android_version (string) — Minimal android corp application version required for this server. Used for breaking changes
free_registration (boolean) — Free registration allowed
max_upload_mb (number) — Maximum size of user’s upload
max_linked_messages (number) — Maximum number of forwarded messages
max_message_uploads (number) — Maximum number of message uploads
max_username_part_length (number) — Maximum chars for: family_name, given_name, patronymic if any
max_group_title_length (number) — Maximum chars for group chat name
max_team_title_length (number) — Maximum chars for team name
max_role_length (number) — Maximum chars for role in team
max_mood_length (number) — Maximum chars for mood in team
max_message_length (number) — Maximum chars for text message
max_section_length (number) — Maximum length for contact’s sections names
max_project_length (number) — Maximum length for project
max_tag_length (number) — Maximum length for tags
max_task_title_length (number) — Maximum length for task title
max_color_rule_description_length (number) — Maximum length for ColorRule description
max_url_length (number) — Maximum length for urls
max_integration_comment_length (number) — Maximum length for Integration comment
max_teams (number) — Maximum teams for one account
max_message_search_limit (number) — Maximum search result
multi_nodes (boolean) 💥 — Multi nodes mode (federation) enabled
afk_age (number) — Max inactivity seconds
auth_by_password (boolean) 💥 — Password authentication enabled
auth_by_qr_code (boolean) 💥 — QR-code / link authentication enabled
auth_by_sms (boolean) 💥 — SMS authentication enabled
auth_2fa (boolean) 💥 — Two-factor authentication (2FA) enabled
is_pin_code_required (boolean) — Mandatory setting of the pin code in the application
pin_code_wrong_limit (number) — Max number of attempts to enter an invalid PIN code
oauth_services (array[OAuthService]) 💥 — External services
ice_servers (array[ICEServer]) — ICE servers for WebRTC
custom_server (boolean) — True for premise installation
installation_type (string) — Name of installation
installation_title (string) 💥 — Installation title, used on login screen
custom_app_icon_name (string) 💥 — Custom application icon name, if any
app_login_background (string) 💥 — AppBackground image url, if any
web_login_background (string) 💥 — WebBackground image url, if any
is_testing (boolean) — Testing installation
metrika (string) — Yandex metrika counter id
amplitude_api_key (string) 💥 — Amplitude api key
min_search_length (number) — Minimal chars number for starting global search
resend_timeout (number) — Resend message in n seconds if no confirmation from server given
sentry_dsn_js (string) — Frontend sentry.io settings
server_drafts (boolean) — Message drafts saved on server
firebase_app_id (string) — Firebase settings for web-push notifications
firebase_sender_id (string) — Firebase settings for web-push notifications
firebase_api_key (string) — Firebase settings for web-push notifications
firebase_auth_domain (string) — Firebase settings for web-push notifications
firebase_database_url (string) — Firebase settings for web-push notifications
firebase_project_id (string) — Firebase settings for web-push notifications
firebase_storage_bucket (string) — Firebase settings for web-push notifications
calls_version (number) — Calls version. 0 = disabled, 1 = audio only, 2 = audio+video
mobile_calls (boolean) — Calls functions enabled for mobile applications
calls_record (boolean) — Calls record enabled
only_one_device_per_call (boolean) 💥 — Disallow call from multiple devices. Experimental
max_participants_per_call (number) 💥 — Maximum number of participants per call
safari_push_id (string) — Safari push id for web-push notifications
message_uploads (boolean) — Multiple message uploads
terms (Terms) — Team entity naming. Experimental
single_group_teams (boolean) — Cross team communication. Experimental
wiki_pages (boolean) — Wiki pages in chats. Experimental
allow_admin_mute (boolean) 💥 — Wiki pages in chats. Experimental
default_wallpaper (Wallpaper) 💥 — Default wallpaper url for mobile apps, if any
support_email (string) — Support email
custom_theme (boolean) — True if server has custom theme
task_checklist (boolean) — Deprecated
readonly_groups (boolean) — Deprecated
task_dashboard (boolean) — Deprecated
task_messages (boolean) — Deprecated
task_public (boolean) — Deprecated
task_tags (boolean) — Deprecated
calls (boolean) — Deprecated
min_app_version (string) — Deprecated
file_extension_whitelist (array[string]) — File Extension Whitelist
file_extension_blacklist (array[string]) — File Extension Blacklist
file_extension_whitelist_priority (boolean) — File Extension Whitelist Priority

FontColors

FontColors font colors for app

Fields:
text (RGBColor) — Text color
title (RGBColor) — Title color
sub (RGBColor) — Sub color
brand_button (RGBColor) — Brand button color
simple_button (RGBColor) — Simple button color
bubble_sent (RGBColor) — Bubble sent color
bubble_received (RGBColor) — Bubble received color

GroupMembership

Group chat membership status

Fields:
jid (JID) — Contact id
status (GroupStatus) 💥 — Status in group
can_remove (boolean) 💥 — Can I remove this member

ICEServer

Interactive Connectivity Establishment Server for WEB Rtc connection. Readonly

Fields:
urls (string) — URls

IconColors

IconColors icon colors for app

Fields:
title (RGBColor) — Title color
brand (RGBColor) — Brand color
other (RGBColor) — Other color

IconData

Icon data. For icon generated from display name contains Letters + Color fields

Fields:
sm (SingleIcon) — Small icon
lg (SingleIcon) — Large image
letters (string) 💥 — Letters (only for stub icon)
color (string) 💥 — Icon background color (only for stub icon)
blurhash (string) 💥 — Compact representation of a placeholder for an image (experimental)
stub (string) 💥 — Deprecated

InputColors

InputColors input colors for app

Fields:
static (RGBColor) — Static color
active (RGBColor) — Active color
disable (RGBColor) — Disable color
error (RGBColor) — Error color

Integration

Integration for concrete chat

Fields:
uid (string) 💥 — Id
comment (string) — Comment, if any
created (string) 💥 — Creation datetime, iso
enabled (boolean) — Integration enabled
form (IntegrationForm) — Integration form
group (JID) — Chat id
help (string) 💥 — Full description
kind (string) — Unique integration name

IntegrationField

Integration form field

Fields:
label (string) — Label
readonly (boolean) — Is field readonly
value (string) — Current value

IntegrationForm

Integration form

Fields:
api_key (IntegrationField) 💥 — Api key field, if any
webhook_url (IntegrationField) 💥 — Webhook url, if any
url (IntegrationField) 💥 — Url, if any

IntegrationKind

Integration kind

Fields:
kind (string) — Integration unique name
title (string) — Plugin title
template (Integration) — Integration template
icon (string) — Path to icon
description (string) — Plugin description

Integrations

Complete integrations data, as received from server

Fields:
integrations (array[Integration]) — Currently existing integrations
kinds (array[IntegrationKind]) — Types of integrations available for setup

InvitableUser

Account from other team, Active Directory or node

Fields:
uid (string) — Account id
node (string) 💥 — Node uid for external users
display_name (string) — Full name
icons (IconData) — Icons
teams (array[string]) 💥 — Common team uids, if any

JSEP

JavaScript Session Establishment Protocol

Fields:
sdp (string) — Session Description Protocol information
type (string) — See https://rtcweb-wg.github.io/jsep/#rfc.section.4.1.8

MarkupEntity

Markup entity. Experimental

Fields:
op (number) — Open marker offset
oplen (number) 💥 — Open marker length
cl (number) — Close marker offset
cllen (number) 💥 — Close marker length
typ (MarkupType) — Marker type
url (string) 💥 — Url, for Link type
repl (string) 💥 — Text replacement
time (string) 💥 — Time, for Time type
childs (array[MarkupEntity]) 💥 — List of internal markup entities

Message

Chat message

Fields:
content (MessageContent) — Message content struct
push_text (string) 💥 — Simple plaintext message representation
from (JID) — Sender contact id
to (JID) — Recipient id (group, task or contact)
message_id (string) — Message uid
created (string) — Message creation datetime (set by server side) or sending datetime in future for draft messages
drafted (string) 💥 — Creation datetime for draft messages
gentime (number) — Object version
chat_type (ChatType) — Chat type
chat (JID) — Chat id
links (MessageLinks) 💥 — External/internals links
markup (array[MarkupEntity]) 💥 — Markup entities. Experimental
important (boolean) 💥 — Importance flag
edited (string) 💥 — ISODateTimeString of message modification or deletion
received (boolean) 💥 — Message was seen by anybody in chat. True or null
num_received (number) 💥 — Unused yet
nopreview (boolean) 💥 — Disable link previews. True or null
has_previews (boolean) 💥 — Has link previews. True or null
prev (string) 💥 — Previous message id in this chat. Uid or null
is_first (boolean) 💥 — This message is first in this chat. True or null
is_last (boolean) 💥 — This message is last in this chat. True or null
uploads (array[Upload]) 💥 — Message uploads
reactions (array[MessageReaction]) 💥 — Message reactions struct. Can be null
reply_to (Message) 💥 — Message that was replied to, if any
linked_messages (array[Message]) 💥 — Forwarded messages. Can be null. Also contains double of ReplyTo for backward compatibility
notice (boolean) 💥 — Has mention (@). True or null
silently (boolean) 💥 — Message has no pushes and did not affect any counters
editable_until (string) 💥 — Author can change this message until date. Can be null
num (number) 💥 — Index number of this message. Starts from 0. Null for deleted messages. Changes when any previous message wad deleted
is_archive (boolean) 💥 — This message is archive. True or null
_debug (string) 💥 — Debug information, if any

MessageColors

MessageColors message colors for app

Fields:
bubble_sent (RGBColor) — Bubble sent color
bubble_received (RGBColor) — Bubble received color
bubble_important (RGBColor) — Bubble important color
status_feed (RGBColor) — Status feed color
status_bubble (RGBColor) — Status bubble color
allocated (RGBColor) — Allocated color

MessageContent

Chat message content

Fields:
text (string) — Text representation of message
type (Mediatype) — Message type
subtype (Mediasubtype) 💥 — Message subtype, if any
upload (string) 💥 — Upload id, if any. Deprecated: use Uploads instead
mediaURL (string) 💥 — Upload url, if any. Deprecated: use Uploads instead
size (number) 💥 — Upload size, if any. Deprecated: use Uploads instead
duration (number) 💥 — Upload duration, if any. Deprecated: use Uploads instead
processing (boolean) 💥 — Upload still processing, if any. Deprecated: use Uploads instead
blurhash (string) 💥 — Compact representation of a placeholder for an image. Deprecated: use Uploads instead
previewHeight (number) 💥 — Upload preview height, in pixels, if any. Deprecated: use Uploads instead
previewWidth (number) 💥 — Upload width, in pixels, if any. Deprecated: use Uploads instead
previewURL (string) 💥 — Upload preview absolute url, if any. Deprecated: use Uploads instead
preview2xURL (string) 💥 — Upload high resolution preview absolute url, if any. Deprecated: use Uploads instead
name (string) 💥 — Upload name, if any. Deprecated: use Uploads instead
animated (boolean) 💥 — Upload is animated image, if any. Deprecated: use Uploads instead
title (string) 💥 — Change title (for “change” mediatype)
old (string) 💥 — Change old value (for “change” mediatype)
new (string) 💥 — Change new value (for “change” mediatype)
actor (JID) 💥 — Change actor contact id (for “change” mediatype)
comment (string) 💥 — Comment (for “audiomsg” mediatype)
given_name (string) 💥 — Given name (for “contact” mediatype)
family_name (string) 💥 — Family name (for “contact” mediatype)
patronymic (string) 💥 — Patronymic name (for “contact” mediatype)
phones (array[string]) 💥 — Contact phones list (for “contact” mediatype)
emails (array[string]) 💥 — Emails list (for “contact” mediatype)
stickerpack (string) 💥 — Stickerpack name (for “sticker” subtype)
pdf_version (PdfVersion) 💥 — Pdf version, if any

MessageLink

Checked message links. In short: “Click here: {link.Pattern}” => “Click here: <a href=’{link.Url}’>{link.Text}</a>”

Fields:
pattern (string) — Text fragment that should be replaced by link
url (string) — Internal or external link
text (string) — Text replacement
preview (MessageLinkPreview) 💥 — Optional preview info, for websites
uploads (array[Upload]) 💥 — Optional upload info
nopreview (boolean) 💥 — Website previews disabled
youtube_id (string) 💥 — Optional youtube movie id

MessageLinkPreview

Website title and description

Fields:
title (string) — Website title or og:title content
description (string) 💥 — Website description

MessageReaction

Message emoji reaction

Fields:
name (string) — Emoji
counter (number) — Number of reactions
details (array[MessageReactionDetail]) — Details

MessageReactionDetail

Message reaction detail

Fields:
created (string) — When reaction added, iso datetime
sender (JID) — Reaction author
name (string) — Reaction emoji

MyReactions

Reactions to messages: frequently used and all available

Fields:
top (array[Reaction]) — My frequently used reactions
all (array[Reaction]) — All available reactions

Node

Node (for external users)

Fields:
uid (string) — Node uid
title (string) — Node title
enabled (boolean) — Synchronization with node works

OAuthService

OAuth service

Fields:
name (string) — Integration title
url (string) — Redirect url

OnlineCall

Active call status

Fields:
jid (JID) — Chat or contact id
uid (string) — Call id
start (string) 💥 — Call start
online_count (number) 💥 — Number participants in call

OnlineContact

Contact online status

Fields:
jid (JID) — Contact id
afk (boolean) 💥 — Is away from keyboard
focused (boolean) 💥 — Focus mode enabled
mobile (boolean) — Is mobile client

PdfVersion

PDF preview of mediafile. Experimental

Fields:
url (string) — Absolute url
text_preview (string) 💥 — First string of text content

PushDevice

Push device info

Fields:
type (string) — Type: android, ios, web, safari
device_id (string) — Device id generated by client library
notification_token (string) — Notification token
voip_notification_token (string) — Notification token for VOIP (iOS only)
name (string) — Readable device name
data_pushes (boolean) — Send silently data pushes that must be fully processed by app. Must be true for modern mobile clients
data_badges (boolean) — Send badge value as data. Experimental
allowed_notifications (boolean) — deprecated

Reaction

Emoji reaction

Fields:
name (string) — Unicode symbol

ReceivedMessage

Message receiving status

Fields:
chat (JID) — Chat or contact id
message_id (string) — Message id
received (boolean) — Is received
num_received (number) 💥 — Number of contacts received this message. Experimental
_debug (string) 💥 — Debug message, if any

Remind

Remind

Fields:
uid (string) — Remind id
chat (JID) — Chat id
fire_at (string) — Activation time, iso
comment (string) 💥 — Comment, if any

Resp

Server response

Fields:
_time (string) 💥 — Server side work time
ok (boolean) — Request status
result (any) 💥 — Result only if ok is true)
error (Err) 💥 — Error (only if ok is false)
details (string) 💥 — Error (only if ok is false and Error is ‘InvalidData’)
reason (string) 💥 — Reason (only if ok is false and Error is `AccessDenied`)
markup (array[MarkupEntity]) 💥 — Reason markup (only if ok is false and Error is `AccessDenied`)

Section

Task project or contact section

Fields:
uid (string) — Section uid
sort_ordering (number) — Sort ordering
name (string) — Name
gentime (number) — Object version
description (string) 💥 — Description, if any
is_archive (boolean) 💥 — Is deleted

Session

Websocket session

Fields:
uid (string) — Session id
created (string) — Creation datetime
lang (string) 💥 — Language code
team (string) 💥 — Team id
is_mobile (boolean) 💥 — Mobile
afk (boolean) 💥 — Away from keyboard
useragent (string) 💥 — User agent
addr (string) 💥 — IP address

SharpLink

#-link autocomplete information

Fields:
key (string) — What should be inserted to the chat
title (string) — What should be visible by user
icons (IconData) 💥 — Icon data, if any
meta (SharpLinkMeta) — Internal details

SharpLinkMeta

#-link autocomplete details

Fields:
jid (JID) — Chat id
chat_type (ChatType) — Chat type
public (boolean) 💥 — Is task or group public for non-guests
task_status (string) 💥 — Task status (for tasks)
num (number) 💥 — Task number (for tasks)
done (boolean) 💥 — Deprecated: use `TaskStatus == “done”` comparsion

ShortMessage

Short message based on chat message

Fields:
from (JID) — Sender contact id
to (JID) — Recipient id (group, task or contact)
message_id (string) — Message uid
created (string) — Message creation datetime (set by server side) or sending datetime in future for draft messages
gentime (number) — Object version
chat_type (ChatType) — Chat type
chat (JID) — Chat id
is_archive (boolean) 💥 — This message is archive. True or null

SingleIcon

Small or large icon

Fields:
url (string) — absolute url to icon
width (number) — Icon width, in pixels
height (number) — Icon height, in pixels

Subscription

Subscription - an entity that signifies the fact of subscribing to the tariff of any team for a certain period (not defined, in the case of the default tariff)

Fields:
uid (string) — Subscription id
activated (string) 💥 — Subscription activation time
expires (string) 💥 — Subscription expiration time
tariff_uid (string) 💥 — ID of the tariff for which the subscription is valid
user_uid (string) 💥 — ID of the user who subscribed

Subtask

Link to sub/sup task

Fields:
jid (JID) — Task id
assignee (JID) — Assignee contact id. Tasks only
title (string) — Task title. Generated from number and description
num (number) — Task number in this team
display_name (string) — Title
public (boolean) 💥 — Is task or group public for non-guests
task_status (string) 💥 — Subtask task status

SwitcherColors

SwitcherColors switcher colors for app

Fields:
on (RGBColor) — On color
off (RGBColor) — Off color

Tag

Task tag

Fields:
uid (string) — Tag id
name (string) — Tag name

Tariff

Tariff for teams

Fields:
uid (string) — Tariff id
title_en (string) — Title of tariff in enlish
title_ru (string) — Title of tariff in russian
price (string) 💥 — Price of tariff
cloud_space (number) 💥 — Cloud space reserved for storing team users uploads in megabytes
max_members_in_team (number) 💥 — Maximum allowed number of members in a team
max_participants_per_call (number) 💥 — Maximum number of participants per call
max_upload_filesize (number) 💥 — maximum file size for uploading

Task

Task

Fields:
custom_color_index (number) 💥 — Custom task color
description (string) 💥 — Task description
tags (array[string]) 💥 — Task tags
section (string) 💥 — Task section UID
observers (array[JID]) 💥 — User who follow the task
items (array[string]) 💥 — Items of the task
assignee (JID) 💥 — User who was assigned the task
deadline (string) 💥 — Deadline time, if any
public (boolean) 💥 — Is task or group public for non-guests
remind_at (string) 💥 — Fire a reminder at this time
task_status (string) 💥 — Task status
importance (number) 💥 — Task importance
urgency (number) 💥 — Task urgency
complexity (number) 💥 — Task complexity
spent_time (number) 💥 — Time spent
linked_messages (array[string]) 💥 — Linked messages
uploads (array[string]) 💥 — Task uploads

TaskColor

Task color rules color

Fields:
regular (RGBColor) — Regular color
dark (RGBColor) — Dark color
light (RGBColor) — Light color

TaskCounters

Tasks counters

Fields:
jid (JID) — Task jid
num_unread (number) 💥 — Unreads counter
num_unread_notices (number) 💥 — Mentions (@) counter

TaskFilter

Task filter

Fields:
field (TaskFilterKey) — Task filter field
title (string) — Filter title

TaskItem

Task checklist item

Fields:
uid (string) 💥 — Id
gentime (number) — Object version
sort_ordering (number) 💥 — Sort ordering
text (string) — Text or “#{OtherTaskNumber}”
checked (boolean) 💥 — Item checked
can_toggle (boolean) 💥 — Can I toggle this item
can_change (boolean) 💥 — Can I change this item
subtask (Subtask) 💥 — Link to subtask. Optional

TaskSort

Task sort type

Fields:
key (TaskSortKey) — Field
title (string) — Sort title

TaskStatus

Custom task status

Fields:
uid (string) 💥 — Status id
sort_ordering (number) — Status sort ordering
name (string) — Status internal name
title (string) — Status localized name
is_archive (boolean) 💥 — Status not used anymore

TaskTab

Task tab

Fields:
key (TaskTabKey) — Tab name
title (string) — Tab title
hide_empty (boolean) — Disable this tab when it has no contents
show_counter (boolean) — Show unread badge
pagination (boolean) — Enable pagination
filters (array[TaskFilter]) — Filters inside tab
sort (array[TaskSort]) — Sort available in tab
unread_tasks (array[TaskCounters]) — Unread tasks with jid and counters

Team

Team

Fields:
uid (string) — Team id
is_archive (boolean) 💥 — Team deleted
gentime (number) — Object version
name (string) — Team name
default_task_deadline (string) 💥 — Default task deadline
max_message_update_age (number) — Max message update/deletion age, in seconds
icons (IconData) — Team icons
last_active (boolean) — User last activity was in this team
changeable_statuses (array[TeamStatus]) 💥 — What status I can set to other team members
bad_profile (boolean) 💥 — My profile in this team isn’t full
need_confirmation (boolean) — Need confirmation after invite to this team
use_patronymic (boolean) 💥 — Patronymic in usernames for this team
user_fields (array[string]) — Username fields ordering. Possible values: “family_name”, “given_name”, “patronymic”
display_family_name_first (boolean) 💥 — Family name should be first in display name
use_task_importance (boolean) 💥 — Use importance field in task
task_importance_min (number) 💥 — Minimal value of task importance. Default is 1
task_importance_max (number) 💥 — Maximum value of task importance. Default is 5
task_importance_rev (boolean) 💥 — Bigger number = bigger importance. Default: lower number = bigger importance
use_task_urgency (boolean) 💥 — Use urgency field in task
use_task_complexity (boolean) 💥 — Use complexity field in task
use_task_spent_time (boolean) 💥 — Use spent time field in task
uploads_size (number) 💥 — Total uploads size, bytes
uploads_size_limit (number) 💥 — Maximum uploads size, bytes, if any
unread (TeamUnread) 0️⃣ — Unread message counters
me (Contact) — My profile in this team
contacts (array[Contact]) 💥 — Team contacts. Used only for team creation
single_group (JID) 💥 — For single group teams, jid of chat
theme (Theme) 💥 — Color theme, if any
hide_archived_users (boolean) 💥 — Don’t show archived users by default
pinned (boolean) 💥 — Team pinned
available_tariffs (array[string]) 💥 — Team’s available tariff by includig archive ones
subscription (Subscription) 💥 — Сurrent team subscription

TeamCounter

Unread message counters

Fields:
uid (string) — Team id
unread (TeamUnread) — Unread message counters

TeamShort

Short team representation. For invites, push notifications, etc. Readonly

Fields:
uid (string) — Team id
name (string) — Team name
icons (IconData) — Team icons

Terms

Experimental translation fields for “team” entity renaming. Readonly

Fields:
EnInTeam (string) — “in team”
EnTeam (string) — “team”
EnTeamAccess (string) — “access to team”
EnTeamAdmin (string) — “team admin”
EnTeamAdmins (string) — “team admins”
EnTeamGuest (string) — “team guest”
EnTeamMember (string) — “team member”
EnTeamMembers (string) — “team members”
EnTeamOwner (string) — “team owner”,
EnTeamSettings (string) — “team settings”
RuTeamSettings (string) — “настройки команды”
EnTeams (string) — “teams”
EnToTeam (string) — “to team”
RuInTeam (string) — “в команде”
RuTeam (string) — “команда”
RuTeamAccess (string) — “доступ к команде”
RuTeamAdmin (string) — “администратор команды”
RuTeamAdmins (string) — “администраторы команды”
RuTeamD (string) — “команде”
RuTeamGuest (string) — “гость команды”
RuTeamMember (string) — “участник команды”
RuTeamMembers (string) — “участники команды”
RuTeamOwner (string) — “владелец команды”
RuTeamP (string) — “команде”
RuTeamR (string) — “команды”
RuTeams (string) — “команды”
RuTeamsD (string) — “командам”
RuTeamsP (string) — “командах”
RuTeamsR (string) — “команд”
RuTeamsT (string) — “командами”
RuTeamsV (string) — “команды”
RuTeamT (string) — “командой”
RuTeamV (string) — “команду”
RuToTeam (string) — “в команду”

Theme

Color theme

Fields:
BgColor (RGBColor) — BgColor for web
BgHoverColor (RGBColor) — BgHoverColor for web
TextColor (RGBColor) — TextColor for web
MutedTextColor (RGBColor) — MutedTextColor for web
AccentColor (RGBColor) — AccentColor for web
AccentHoverColor (RGBColor) — AccentHoverColor for web
TextOnAccentHoverColor (RGBColor) — TextOnAccentHoverColor for web
MainAccent (RGBColor) — MainAccent for web
MainAccentHover (RGBColor) — MainAccentHover for web
MainLightAccent (RGBColor) — MainLightAccent for web
MainLink (RGBColor) — MainLink for web
brand (RGBColor) — Brand color for app
brand_dark (RGBColor) — BrandDark color for app
brand_light (RGBColor) — Brand light color for app
back (RGBColor) — Back light color for app
back_light (RGBColor) — Back light color for app
back_dark (RGBColor) — Back dark color for app
success (RGBColor) — Success color for app
success_light (RGBColor) — Success light color for app
error (RGBColor) — Error color for app
error_light (RGBColor) — Error light color for app
background (RGBColor) — Background color for app
tab_background (RGBColor) — Tab background color for app
chat_input_background (RGBColor) — Chat input background color for app
substrate_background (RGBColor) — Substrate background color for app
modal_background (RGBColor) — Modal background color for app
title_background (RGBColor) — Title background color for app
attention (RGBColor) — Attention color for app
attention_light (RGBColor) — Attention light color for app
font (FontColors) 0️⃣ — Font colors for app
message (MessageColors) 0️⃣ — Message colors for app
switcher (SwitcherColors) 0️⃣ — Switcher colors for app
button (ButtonColors) 0️⃣ — Button colors for app
input (InputColors) 0️⃣ — Input colors for app
ic (IconColors) 0️⃣ — Icon colors for app
web_base (WebBase) 0️⃣ — WebBase colors for web
AppAccentColor (RGBColor) — Deprecated
AppPrimaryColor (RGBColor) — Deprecated

Unread

Unread message counters

Fields:
messages (number) — Total unread messages
notice_messages (number) — Total unread messages with mentions
chats (number) — Total chats with unread messages

Upload

Uploaded media

Fields:
uid (string) — Upload id
created (string) — Uploaded at
size (number) — Upload size in bytes
duration (number) 💥 — Mediafile duration (for audio/video only)
name (string) — Filename
url (string) — Absolute url
preview (UploadPreview) 💥 — Preview details
content_type (string) — Content type
animated (boolean) 💥 — Is animated (images only)
blurhash (string) 💥 — Compact representation of a placeholder for an image (images only)
processing (boolean) 💥 — File still processing (video only)
pdf_version (PdfVersion) 💥 — PDF version of file. Experimental
type (UploadMediaType) — ?type=file,image,audio,video

UploadPreview

Upload preview

Fields:
url (string) — Absolute url to image
url_2x (string) — Absolute url to high resolution image (retina)
width (number) — Width in pixels
height (number) — Height in pixels

UploadShortMessage

Upload + ShortMessage

Fields:
upload (Upload) — Upload information
message (ShortMessage) — Short message information

User

Account data

Fields:
phone (string) 💥 — Phone for login
email (string) 💥 — Email for login
family_name (string) 💥 — Family name
given_name (string) 💥 — Given name
patronymic (string) 💥 — Patronymic, if any
default_lang (string) 💥 — Default language code
alt_send (boolean) — Use Ctrl/Cmd + Enter instead Enter
asterisk_mention (boolean) — Use * as @ for mentions
always_send_pushes (boolean) — Send pushes even user is online
hide_pushes_content (boolean) — Hide pushes body
unread_first (boolean) — Show unread chats in chat list first
munread_first (boolean) — Show unread chats in chat list first on mobiles
timezone (string) — Timezone
quiet_time_start (string) 0️⃣ — Start silently time (no pushes, no sounds)
quiet_time_finish (string) 0️⃣ — Finish silently time (no pushes, no sounds)
icons (IconData) — Icon data

UserWithMe

Account data with extra information

Fields:
inviter (JID) 💥 — Inviter id, if any
teams (array[Team]) — Available teams
devices (array[PushDevice]) — Registered push devices
phone (string) 💥 — Phone for login
email (string) 💥 — Email for login
family_name (string) 💥 — Family name
given_name (string) 💥 — Given name
patronymic (string) 💥 — Patronymic, if any
default_lang (string) 💥 — Default language code
alt_send (boolean) — Use Ctrl/Cmd + Enter instead Enter
asterisk_mention (boolean) — Use * as @ for mentions
always_send_pushes (boolean) — Send pushes even user is online
hide_pushes_content (boolean) — Hide pushes body
unread_first (boolean) — Show unread chats in chat list first
munread_first (boolean) — Show unread chats in chat list first on mobiles
timezone (string) — Timezone
quiet_time_start (string) 0️⃣ — Start silently time (no pushes, no sounds)
quiet_time_finish (string) 0️⃣ — Finish silently time (no pushes, no sounds)
icons (IconData) — Icon data

Wallpaper

Chat wallpaper

Fields:
key (string) — Unique identifier
name (string) — Localized description
url (string) — Url to jpg or png

HTTP Queries

TaskFilter

Query parameters for listing messages

• assignee - * ?assignee=jid,jid

• created_gte - * ?created_gte=<isodate>

• created_lte - * ?created_lte=<isodate>

• deadline_gte - * ?deadline_gte=<isodate>

• deadline_lte - * ?deadline_lte=<isodate>

• done_gte - * ?done_gte=<isodate>

• done_lte - * ?done_lte=<isodate>

• exclude_task_status - * ?exclude_task_status = new,done | new | any

• gentime_gt - gentime great than group/chat

• member - * ?member=jid,jid

• num - * ?num=num1,num2,num3..

• observer - * ?observer=jid,jid // TODO: rename to ?follower=

• owner - * ?owner=jid,jid

• public - * ?public=true|false

• q - * ?q=

• section - * ?section=[ uid,uid… | “-” ]

• short - * ?short=true|false

• sort - * ?sort = [ “created” | “-created” | “last_message” | “-last_message” | “deadline” | “-deadline” ]

• tag - * ?tag=[ tag,tag,tag… | “-” ]

• task_status - * ?task_status = new,done | new | any