Show/hide List Operations Expand Operations

Agents

GET /api/v2/agent_groups CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

usergroups.agent_groups.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (Usergroup)	*
data[][title]	string	*	Title of the usergroup.
data[][id]	integer	*	The unique ID, DB-generated.
data[][note]	string	*	A note or description about the usergroup.
data[][is_agent_group]	boolean	*	Is this an agent group?
data[][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data[][is_enabled]	boolean	*	Is the group enabled?
data[][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data[][permissions][][id]	integer	*	The unique ID.
data[][permissions][][name]	string	*	The name of the permission.
data[][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data[][department_permissions][]	array of objects (DepartmentPermission)	*
data[][department_permissions][][department]	integer id (Department)	*
data[][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][department_permissions][][name]	string	*	The name of the permission.
data[][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][department_permissions][][is_active]	boolean	*
data[][people][]	array of objects (Person)	*	Usergroup members.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

GET /api/v2/agent_groups/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

usergroups.agent_groups.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

GET /api/v2/agent_groups/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

usergroups.agent_groups.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.title	string	*	Title of the usergroup.
data.id	integer	*	The unique ID, DB-generated.
data.note	string	*	A note or description about the usergroup.
data.is_agent_group	boolean	*	Is this an agent group?
data.sys_name	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.is_enabled	boolean	*	Is the group enabled?
data.permissions[]	array of objects (Permission)	*	Usergroup permissions.
data.permissions[][id]	integer	*	The unique ID.
data.permissions[][name]	string	*	The name of the permission.
data.permissions[][value]	integer	*	Any numeric number (ex filesize, flag).
data.permissions[][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.department_permissions[]	array of objects (DepartmentPermission)	*
data.department_permissions[][department]	integer id (Department)	*
data.department_permissions[][app]	string	*	Application name. It's going to be either chat or tickets.
data.department_permissions[][name]	string	*	The name of the permission.
data.department_permissions[][value]	integer	*	Any numeric number (ex filesize, flag).
data.department_permissions[][is_active]	boolean	*
data.people[]	array of objects (Person)	*	Usergroup members.
data.people[][emails]		*
data.people[][labels]		*
data.people[][teams]		*
data.people[][primary_team]		*
data.people[][agentData]		*
data.people[][publicUsergroups]		*
data.people[][publicAgentgroups]		*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

GET /api/v2/agent_teams CRUD

get list of teams

Applicable api modes

session token key oauth

Api tags for this endpoint

people.agent_teams.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Pattern	(1\|0)
Description	limit to my teams only
Datatype	boolean

Parameter	Type	Versions	Description
data[]	array of objects (AgentTeam)	*
data[][id]	integer	*	The unique team ID.
data[][name]	string	*	Team name.
data[][avatar]	object (Avatar)	*	Team`s avatar.
data[][avatar][default_url_pattern]	string	*	Default pattern used if there is no custom one.
data[][avatar][url_pattern]	string	*	Url pattern for avatar gathering.
data[][avatar][base_gravatar_url]	string	*	Url to gravatar.
data[][agents][]	array of integer ids (Person)	*	Agents belong to department.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/agent_teams CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.agent_teams.post

Parameters
Response
Status Codes

Parameter	Type	Required?
name	string	true
avatar	string	false
members[]	array of choices	false

Parameter	Type	Versions	Description
data.id	integer	*	The unique team ID.
data.name	string	*	Team name.
data.avatar	object (Avatar)	*	Team`s avatar.
data.avatar[default_url_pattern]	string	*	Default pattern used if there is no custom one.
data.avatar[url_pattern]	string	*	Url pattern for avatar gathering.
data.avatar[base_gravatar_url]	string	*	Url to gravatar.
data.agents[]	array of integer ids (Person)	*	Agents belong to department.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/agent_teams/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

people.agent_teams.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/agent_teams/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.agent_teams.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/agent_teams/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.agent_teams.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.id	integer	*	The unique team ID.
data.name	string	*	Team name.
data.avatar	object (Avatar)	*	Team`s avatar.
data.avatar[default_url_pattern]	string	*	Default pattern used if there is no custom one.
data.avatar[url_pattern]	string	*	Url pattern for avatar gathering.
data.avatar[base_gravatar_url]	string	*	Url to gravatar.
data.agents[]	array of integer ids (Person)	*	Agents belong to department.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/agent_teams/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.agent_teams.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?
name	string	false
avatar	string	false
members[]	array of choices	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/agent_teams/{id}/agents

Return agents from team given team

Documentation

Touching this endpoint will return a list of agents belongs to specified team.

Applicable api modes

session token key oauth

Api tags for this endpoint

people.agent_teams.get_agents

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	the id of team

Parameter	Type	Versions	Description
data[]	array of objects (Person)	*
data[][id]	integer	*	The unique ID of person.
data[][primary_email]	string representation (PersonEmail)	*	Emails belong to user.
data[][first_name]	string	*	The users name (best guess from other sources etc).
data[][last_name]	string	*	The users name (best guess from other sources etc).
data[][title_prefix]	string	*	The users title.
data[][name]	string	*	The users name (best guess from other sources etc).
data[][display_name]	string	*	Person name.
data[][is_agent]	boolean	*	True if person is agent.
data[][avatar]	object (Avatar)	*	Person`s avatar.
data[][avatar][default_url_pattern]	string	*	Default pattern used if there is no custom one.
data[][avatar][url_pattern]	string	*	Url pattern for avatar gathering.
data[][avatar][base_gravatar_url]	string	*	Url to gravatar.
data[][online]	boolean	*	Is user online?
data[][online_for_chat]	boolean	*	Is user online for chat?
data[][last_seen]	DateTime	*	Date when user was last seen online.
data[][agent_data]	object (AgentData)	*	Agent data.
data[][agent_data][extension_number]	integer	*
data[][agent_data][available_status]	string	*
data[][agent_data][agent_calls_enabled]	boolean	*
data[][agent_data][agent_chat_enabled]	boolean	*
data[][agent_data][agent_can_use_forwarding]	boolean	*
data[][agent_data][forwarding_number]	string	*
data[][agent_data][forwarding_ring_timeout]	integer	*
data[][agent_data][forwarding_number_type]	string	*
data[][agent_data][forwarding_logged_out]	boolean	*
data[][agent_data][work_status_enabled]	boolean	*
data[][agent_data][work_status_managed_after]	DateTime	*
data[][agent_data][login_status]	string	*
data[][was_agent]	boolean	*	Was this person an agent?
data[][can_agent]	boolean	*	Is person allowed to use agent interface.
data[][can_admin]	boolean	*	Is person allowed to use admin interface.
data[][can_billing]	boolean	*	Is person allowed to use billing interface.
data[][can_reports]	boolean	*	Is person allowed to use reports interface.
data[][picture_blob]	integer id (Blob)	*	The user`s profile picture.
data[][disable_picture]	boolean	*	True if user`s picture disabled.
data[][gravatar_url]	string	*	The URL to the users gravatar if any.
data[][is_contact]	boolean	*	Is this person a contact?
data[][disable_autoresponses]	boolean	*	Are autoresponses disabled?
data[][disable_autoresponses_log]	string	*	Disabled autoresponses log.
data[][is_confirmed]	boolean	*	Has person confirmed their email?
data[][is_deleted]	boolean	*	Is the user deleted?
data[][is_disabled]	boolean	*	Is the user disabled?
data[][creation_system]	string	*	The way person was created.
data[][override_display_name]	string	*	Overrides the display name of an person in the user interface (agents only).
data[][display_contact]	string	*	Person name and email address.
data[][summary]	string	*	The summary field as filled in by agents.
data[][language]	integer id (Language)	*	Default person`s language.
data[][organization]	integer id (Organization)	*	The person`s organization.
data[][organization_members][]	array of integer ids (OrganizationMember)	*	Organizations the person is member of.
data[][organization_position]	string	*	The persons position at the organization.
data[][organization_manager]	boolean	*	True if the person is a manager of their organization.
data[][timezone]	string	*	The timezone associated with this user.
data[][date_created]	DateTime	*	The date the user was inserted into the system.
data[][date_last_login]	DateTime	*	The date the user was logged in last time.
data[][browser]	string	*	The browser person was used last time.
data[][all_user_groups][]	array of integer ids (Usergroup)	*	Usergroups the user belongs to including through connections like org groups.
data[][user_groups][]	array of integer ids (Usergroup)	*	Usergroups the user belongs to.
data[][agent_groups][]	array of integer ids (Usergroup)	*	Usergroups the user belongs to.
data[][labels][]	array of objects (label)	*	Labels associated with this user.
data[][emails][]	array of string representations (PersonEmail)	*	Emails belong to user.
data[][phone_numbers][]	array of objects (PersonPhoneNumber)	*	Phone numbers belong to user.
data[][phone_numbers][][number]	string	*	The number, stored in E.164 string format, ie. +19021111111.
data[][phone_numbers][][label]	string	*	A human-defined (optional) label to describe what this phone number is.
data[][phone_numbers][][extension]	string	*	An extension for the number - optional.
data[][phone_numbers][][person]	integer id (Person)	*
data[][tickets_count]	integer	*	Overall tickets count assigned to user.
data[][chats_count]	integer	*	Overall count of chats user participating.
data[][fields][]	dynamically declared custom fields (person)	*	Custom persons data.
data[][contextual_options]	custom handler result for (contextual_options)	*	Contextual person options.
data[][contact_data]	array	*	Contacts for this user.
data[][teams][]	array of integer ids (AgentTeam)	*	Agent teams.
data[][primary_team]	integer id (AgentTeam)	*	Primary agent team.
data[][brands][]	array of integer ids (Brand)	*	Brands.
data[][preferences]	array	*	Prefs.

Status Code	Description
200	Will return when success
404	Returned when chat was not found
400	In all other cases except system error

GET /api/v2/agents CRUD

get list of agents

Applicable api modes

session token key oauth

Api tags for this endpoint

people.agents.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

is_deleted

Pattern	(1\|0\|-1)
Description	deleted filter, defaults to 0
Datatype	integer

online

Pattern	(1\|0\|-1)
Description	is online filter, defaults to 0
Datatype	integer

online_for_chat

Pattern	(1\|0\|-1)
Description	is online for chat filter, defaults to 0
Datatype	integer

Parameter	Type	Versions	Description
data[]	array of objects (BasePerson)	*
data[][id]	integer	*	The unique ID of person.
data[][primary_email]	string representation (PersonEmail)	*	Main user`s email.
data[][first_name]	string	*	The users name (best guess from other sources etc).
data[][last_name]	string	*	The users name (best guess from other sources etc).
data[][title_prefix]	string	*	The users title.
data[][name]	string	*	The users name (best guess from other sources etc).
data[][display_name]	string	*	Person display name.
data[][is_agent]	boolean	*	True if person is agent.
data[][avatar]	object (Avatar)	*	Person`s avatar.
data[][avatar][default_url_pattern]	string	*	Default pattern used if there is no custom one.
data[][avatar][url_pattern]	string	*	Url pattern for avatar gathering.
data[][avatar][base_gravatar_url]	string	*	Url to gravatar.
data[][online]	boolean	*	Is user online?
data[][online_for_chat]	boolean	*	Is user online for chat?
data[][last_seen]	DateTime	*	Date when user was last seen online.
data[][agent_data]	object (AgentData)	*	Agent data.
data[][agent_data][extension_number]	integer	*
data[][agent_data][available_status]	string	*
data[][agent_data][agent_calls_enabled]	boolean	*
data[][agent_data][agent_chat_enabled]	boolean	*
data[][agent_data][agent_can_use_forwarding]	boolean	*
data[][agent_data][forwarding_number]	string	*
data[][agent_data][forwarding_ring_timeout]	integer	*
data[][agent_data][forwarding_number_type]	string	*
data[][agent_data][forwarding_logged_out]	boolean	*
data[][agent_data][work_status_enabled]	boolean	*
data[][agent_data][work_status_managed_after]	DateTime	*
data[][agent_data][login_status]	string	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

GET DEPRECATED /api/v2/agents/assigned_to_chat

get a list of agents, assigned to chats

Applicable api modes

session token key oauth

Api tags for this endpoint

people.agents.get_agents_on_chats

Response
Status Codes

Parameter	Type	Versions	Description
data[]	array of objects (Person)	*

Status Code	Description
200	Returned if everything is ok

GET /api/v2/agents/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

people.agents.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

GET /api/v2/agents/extended

extended agents models

Applicable api modes

session token key oauth

Api tags for this endpoint

people.agents.list_extended

Response
Status Codes

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID of person.
data.primary_email	string representation (PersonEmail)	*	Main user`s email.
data.first_name	string	*	The users name (best guess from other sources etc).
data.last_name	string	*	The users name (best guess from other sources etc).
data.title_prefix	string	*	The users title.
data.name	string	*	The users name (best guess from other sources etc).
data.display_name	string	*	Person display name.
data.is_agent	boolean	*	True if person is agent.
data.avatar	object (Avatar)	*	Person`s avatar.
data.avatar[default_url_pattern]	string	*	Default pattern used if there is no custom one.
data.avatar[url_pattern]	string	*	Url pattern for avatar gathering.
data.avatar[base_gravatar_url]	string	*	Url to gravatar.
data.online	boolean	*	Is user online?
data.online_for_chat	boolean	*	Is user online for chat?
data.last_seen	DateTime	*	Date when user was last seen online.
data.agent_data	object (AgentData)	*	Agent data.
data.agent_data[extension_number]	integer	*
data.agent_data[available_status]	string	*
data.agent_data[agent_calls_enabled]	boolean	*
data.agent_data[agent_chat_enabled]	boolean	*
data.agent_data[agent_can_use_forwarding]	boolean	*
data.agent_data[forwarding_number]	string	*
data.agent_data[forwarding_ring_timeout]	integer	*
data.agent_data[forwarding_number_type]	string	*
data.agent_data[forwarding_logged_out]	boolean	*
data.agent_data[work_status_enabled]	boolean	*
data.agent_data[work_status_managed_after]	DateTime	*
data.agent_data[login_status]	string	*
data.agent_data[extensionNumber]		*
data.agent_data[voicemailAsset]		*
data.agent_data[availableStatus]		*
data.agent_data[forwardingNumber]		*
data.agent_data[loginStatus]		*
data.was_agent	boolean	*	Was this person an agent?
data.can_agent	boolean	*	Is person allowed to use agent interface.
data.can_admin	boolean	*	Is person allowed to use admin interface.
data.can_billing	boolean	*	Is person allowed to use billing interface.
data.can_reports	boolean	*	Is person allowed to use reports interface.

Status Code	Description
200	Returned if everything is ok

GET /api/v2/agents/online

get a list of online agents

Applicable api modes

session token key oauth

Api tags for this endpoint

people.agents.get_agents_online

Response
Status Codes

Parameter	Type	Versions	Description
data[]	array of integers	*
data[][integer]	object (integer)	*

Status Code	Description
200	Returned if everything is ok

PUT /api/v2/agents/profile

edit agent profile

Applicable api modes

session token key oauth

Api tags for this endpoint

people.agents.edit_profile

Parameters
Status Codes

Parameter	Type	Required?	Format
agent_data[available_status]	choice	false	["idle","offline"]
agent_data[agent_calls_enabled]	boolean	false
agent_data[agent_chat_enabled]	boolean	false
agent_data[agent_can_use_forwarding]	boolean	false
agent_data[voicemail_asset]	string	false
agent_data[forwarding_number]	string	false
agent_data[forwarding_ring_timeout]	integer	false
agent_data[forwarding_logged_out]	boolean	false
agent_data[login_status]	choice	false	["logged_in","unknown","logged_out"]

Status Code	Description
204	No content

DELETE /api/v2/agents/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.agents.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/agents/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.agents.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID of person.
data.primary_email	string representation (PersonEmail)	*	Main user`s email.
data.first_name	string	*	The users name (best guess from other sources etc).
data.last_name	string	*	The users name (best guess from other sources etc).
data.title_prefix	string	*	The users title.
data.name	string	*	The users name (best guess from other sources etc).
data.display_name	string	*	Person display name.
data.is_agent	boolean	*	True if person is agent.
data.avatar	object (Avatar)	*	Person`s avatar.
data.avatar[default_url_pattern]	string	*	Default pattern used if there is no custom one.
data.avatar[url_pattern]	string	*	Url pattern for avatar gathering.
data.avatar[base_gravatar_url]	string	*	Url to gravatar.
data.online	boolean	*	Is user online?
data.online_for_chat	boolean	*	Is user online for chat?
data.last_seen	DateTime	*	Date when user was last seen online.
data.agent_data	object (AgentData)	*	Agent data.
data.agent_data[extension_number]	integer	*
data.agent_data[available_status]	string	*
data.agent_data[agent_calls_enabled]	boolean	*
data.agent_data[agent_chat_enabled]	boolean	*
data.agent_data[agent_can_use_forwarding]	boolean	*
data.agent_data[forwarding_number]	string	*
data.agent_data[forwarding_ring_timeout]	integer	*
data.agent_data[forwarding_number_type]	string	*
data.agent_data[forwarding_logged_out]	boolean	*
data.agent_data[work_status_enabled]	boolean	*
data.agent_data[work_status_managed_after]	DateTime	*
data.agent_data[login_status]	string	*
data.agent_data[extensionNumber]		*
data.agent_data[voicemailAsset]		*
data.agent_data[availableStatus]		*
data.agent_data[forwardingNumber]		*
data.agent_data[loginStatus]		*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

DELETE /api/v2/agents/{id}/agent_permissions

remove agents permission (converts agent to user, unassigns tickets)

Applicable api modes

session token key oauth

Api tags for this endpoint

people.agents.delete_permissions

Requirements
Status Codes

Name	Requirement	Type	Description
id

Status Code	Description
200	OK

POST DEPRECATED /api/v2/agents/{id}/reset-password

reset agent password

Applicable api modes

session token key oauth

Api tags for this endpoint

people.agents.reset_password

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id

Parameter	Type	Versions	Description
data[]	array of objects (Person)	*

Status Code	Description
200	Returned if everything is ok

POST /api/v2/agents/{id}/send-token

sends the person a two factor verification token

Applicable api modes

session token key oauth

Api tags for this endpoint

people.agents.send_two_factor_passcode

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id

Parameter	Type	Required?	Format	Description
	string	true		code to send

Status Code	Description
200	OK

POST DEPRECATED /api/v2/agents/{id}/set-password

set agent password

Applicable api modes

session token key oauth

Api tags for this endpoint

people.agents.set_password

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id

Parameter	Type	Versions	Description
data[]	array of objects (Person)	*

Status Code	Description
200	Returned if everything is ok

Show/hide List Operations Expand Operations

Anti-abuse settings

GET /api/v2/settings/anti_abuse/captcha

Get anti-abuse settings

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.anti_abuse.captcha_anti_abuse_setup.get

Response
Status Codes

Parameter	Type	Versions	Description
data.use_recaptcha2	integer	*	True if set to use Google`s recaptcha.
data.recaptcha2_site_key	string	*	Recaptcha key.
data.recaptcha2_secret_key	string	*	Recaptcha key.
data.recaptcha_version	integer	*	Recaptcha version.
data.tickets	string	*	Use it for tickets.
data.comments	string	*	Use it for comments.
data.community	string	*	Use it for community topics.
data.register	string	*	Use it for registration.
data.sharing	string	*	Use it for sharing.

Status Code	Description
200	Success

PUT /api/v2/settings/anti_abuse/captcha

Update anti-abuse settings

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.anti_abuse.captcha_anti_abuse_setup.put

Parameters
Status Codes

Parameter	Type	Required?	Format
use_recaptcha2	boolean	false
recaptcha2_site_key	string	false
recaptcha2_secret_key	string	false
recaptcha_version	choice	false	["2","3"]
tickets	choice	false	[false,"guests","everyone"]
comments	choice	false	[false,"guests","everyone"]
community	choice	false	[false,"guests","everyone"]
register	choice	false	[false,"guests","everyone"]
sharing	choice	false	[false,"guests","everyone"]

Status Code	Description
204	Success
400	Bad request

GET /api/v2/settings/anti_abuse/portal

Get anti-abuse settings

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.anti_abuse.portal_anti_abuse_setup.get

Response
Status Codes

Parameter	Type	Versions	Description
data.accountRateLimit		*
data.agentRateLimit		*
data.userRateLimit		*
data.guestRateLimit		*
data.account_rate_limit	object (PortalAccountRateLimit)	*	Account rate limit object.
data.account_rate_limit[registration_settings]	object (RateLimitLockoutGroup)	*	Limits for registration.
data.account_rate_limit[registration_settings][limit]	integer	*	The limit itself.
data.account_rate_limit[registration_settings][time]	integer	*	Time period for limit.
data.account_rate_limit[registration_settings][enabled]	boolean	*	True of enabled.
data.account_rate_limit[registration_settings][lockout_time]	integer	*
data.account_rate_limit[registration_settings][lockoutTime]		*
data.account_rate_limit[reset_password_settings]	object (RateLimitLockoutGroup)	*	Limits for password resetting.
data.account_rate_limit[registrationSettings]		*
data.account_rate_limit[resetPasswordSettings]		*
data.agent_rate_limit	object (PortalAgentRateLimit)	*	Agent rate limit object.
data.agent_rate_limit[login_settings]	object (RateLimitOptionsGroup)	*	Settings for login.
data.agent_rate_limit[login_settings][limit]	integer	*	The limit itself.
data.agent_rate_limit[login_settings][time]	integer	*	Time period for limit.
data.agent_rate_limit[login_settings][enabled]	boolean	*	True of enabled.
data.agent_rate_limit[login_settings][response]	string	*	How to respond when limit was hit.
data.agent_rate_limit[login_settings][lockout_time]	integer	*
data.agent_rate_limit[login_settings][lockoutTime]		*
data.agent_rate_limit[loginSettings]		*
data.user_rate_limit	object (PortalUserRateLimit)	*	Rate limits for user.
data.user_rate_limit[login_settings]	object (RateLimitOptionsGroup)	*	Settings for login.
data.user_rate_limit[login_settings][limit]	integer	*	The limit itself.
data.user_rate_limit[login_settings][time]	integer	*	Time period for limit.
data.user_rate_limit[login_settings][enabled]	boolean	*	True of enabled.
data.user_rate_limit[login_settings][response]	string	*	How to respond when limit was hit.
data.user_rate_limit[login_settings][lockout_time]	integer	*
data.user_rate_limit[login_settings][lockoutTime]		*
data.user_rate_limit[submit_ticket]	object (RateLimitOptionsGroup)	*	Limits for ticket submitting.
data.user_rate_limit[submit_community_topic]	object (RateLimitOptionsGroup)	*	Limits for community topics submitting.
data.user_rate_limit[submit_comment]	object (RateLimitOptionsGroup)	*	Limits for comments submitting.
data.user_rate_limit[upload_attachment]	object (RateLimitOptionsGroup)	*	Limits for attachment submitting.
data.user_rate_limit[share_content]	object (RateLimitOptionsGroup)	*	Limits for sharing content.
data.user_rate_limit[loginSettings]		*
data.user_rate_limit[submitTicket]		*
data.user_rate_limit[submitCommunityTopic]		*
data.user_rate_limit[submitComment]		*
data.user_rate_limit[uploadAttachment]		*
data.user_rate_limit[shareContent]		*
data.guest_rate_limit	object (PortalUserRateLimit)	*	Rate limits for guests.

Status Code	Description
200	Success

PUT /api/v2/settings/anti_abuse/portal

Update anti-abuse settings

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.anti_abuse.portal_anti_abuse_setup.put

Parameters
Status Codes

Parameter	Type	Required?	Format
account_rate_limit[registration_settings][enabled]	boolean	false
account_rate_limit[registration_settings][limit]	float	false
account_rate_limit[registration_settings][time]	float	false
account_rate_limit[registration_settings][lockout_time]	float	false
account_rate_limit[reset_password_settings][enabled]	boolean	false
account_rate_limit[reset_password_settings][limit]	float	false
account_rate_limit[reset_password_settings][time]	float	false
account_rate_limit[reset_password_settings][lockout_time]	float	false
agent_rate_limit[login_settings][enabled]	boolean	false
agent_rate_limit[login_settings][limit]	float	false
agent_rate_limit[login_settings][time]	float	false
agent_rate_limit[login_settings][response]	choice	false	["captcha","lockout"]
agent_rate_limit[login_settings][lockout_time]	float	false
user_rate_limit[login_settings][enabled]	boolean	false
user_rate_limit[login_settings][limit]	float	false
user_rate_limit[login_settings][time]	float	false
user_rate_limit[login_settings][response]	choice	false	["captcha","lockout"]
user_rate_limit[login_settings][lockout_time]	float	false
user_rate_limit[submit_ticket][enabled]	boolean	false
user_rate_limit[submit_ticket][limit]	float	false
user_rate_limit[submit_ticket][time]	float	false
user_rate_limit[submit_ticket][response]	choice	false	["captcha","lockout"]
user_rate_limit[submit_ticket][lockout_time]	float	false
user_rate_limit[submit_community_topic][enabled]	boolean	false
user_rate_limit[submit_community_topic][limit]	float	false
user_rate_limit[submit_community_topic][time]	float	false
user_rate_limit[submit_community_topic][response]	choice	false	["captcha","lockout"]
user_rate_limit[submit_community_topic][lockout_time]	float	false
user_rate_limit[submit_comment][enabled]	boolean	false
user_rate_limit[submit_comment][limit]	float	false
user_rate_limit[submit_comment][time]	float	false
user_rate_limit[submit_comment][response]	choice	false	["captcha","lockout"]
user_rate_limit[submit_comment][lockout_time]	float	false
user_rate_limit[upload_attachment][enabled]	boolean	false
user_rate_limit[upload_attachment][limit]	float	false
user_rate_limit[upload_attachment][time]	float	false
user_rate_limit[upload_attachment][response]	choice	false	["captcha","lockout"]
user_rate_limit[upload_attachment][lockout_time]	float	false
user_rate_limit[share_content][enabled]	boolean	false
user_rate_limit[share_content][limit]	float	false
user_rate_limit[share_content][time]	float	false
user_rate_limit[share_content][response]	choice	false	["captcha","lockout"]
user_rate_limit[share_content][lockout_time]	float	false
guest_rate_limit[login_settings][enabled]	boolean	false
guest_rate_limit[login_settings][limit]	float	false
guest_rate_limit[login_settings][time]	float	false
guest_rate_limit[login_settings][response]	choice	false	["captcha","lockout"]
guest_rate_limit[login_settings][lockout_time]	float	false
guest_rate_limit[submit_ticket][enabled]	boolean	false
guest_rate_limit[submit_ticket][limit]	float	false
guest_rate_limit[submit_ticket][time]	float	false
guest_rate_limit[submit_ticket][response]	choice	false	["captcha","lockout"]
guest_rate_limit[submit_ticket][lockout_time]	float	false
guest_rate_limit[submit_community_topic][enabled]	boolean	false
guest_rate_limit[submit_community_topic][limit]	float	false
guest_rate_limit[submit_community_topic][time]	float	false
guest_rate_limit[submit_community_topic][response]	choice	false	["captcha","lockout"]
guest_rate_limit[submit_community_topic][lockout_time]	float	false
guest_rate_limit[submit_comment][enabled]	boolean	false
guest_rate_limit[submit_comment][limit]	float	false
guest_rate_limit[submit_comment][time]	float	false
guest_rate_limit[submit_comment][response]	choice	false	["captcha","lockout"]
guest_rate_limit[submit_comment][lockout_time]	float	false
guest_rate_limit[upload_attachment][enabled]	boolean	false
guest_rate_limit[upload_attachment][limit]	float	false
guest_rate_limit[upload_attachment][time]	float	false
guest_rate_limit[upload_attachment][response]	choice	false	["captcha","lockout"]
guest_rate_limit[upload_attachment][lockout_time]	float	false
guest_rate_limit[share_content][enabled]	boolean	false
guest_rate_limit[share_content][limit]	float	false
guest_rate_limit[share_content][time]	float	false
guest_rate_limit[share_content][response]	choice	false	["captcha","lockout"]
guest_rate_limit[share_content][lockout_time]	float	false

Status Code	Description
204	Success
400	Bad request

Show/hide List Operations Expand Operations

Approvals

GET /api/v2/approval_responses/{approvalId} CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

approvals.approval_responses.list

Requirements
Filters
Parameters
Response
Status Codes

Name	Requirement	Type	Description
approvalId

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Required?	Format	Description
message	string	false

Parameter	Type	Versions	Description
data[]	array of objects (ApprovalResponse)	*
data[][vote_type]	string	*	Get pretty name for a vote
data[][id]	integer	*
data[][vote]	integer	*
data[][message]	string	*
data[][created_at]	DateTime	*
data[][approver]	integer id (Person)	*
data[][approval]	integer id (AbstractBaseApproval)	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

GET /api/v2/approval_responses/{approvalId}/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

approvals.approval_responses.count

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
approvalId

Parameter	Type	Required?	Format	Description
message	string	false

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

GET /api/v2/approval_templates CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

approvals.approval_templates.list

Filters
Parameters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Required?
type	choice	true
name	string	true
description	string	false
required_approvals	integer	true
required_rejections	integer	true
can_approvers_view_subject	boolean	true
can_choose_approvers	boolean	true
actions_on_create	string	false
actions_on_partial_approval_response	string	false
actions_on_partial_rejection_response	string	false
actions_on_cancel	string	false
actions_on_approved	string	false
actions_on_rejected	string	false

Parameter	Type	Versions	Description
data[]	array of objects (ApprovalTemplate)	*
data[][id]	integer	*
data[][name]	string	*
data[][description]	string	*
data[][required_approvals]	integer	*
data[][required_rejections]	integer	*
data[][type]	integer id (ApprovalType)	*
data[][can_approvers_view_subject]	boolean	*
data[][actions_on_create]	object (TriggerActions)	*
data[][actions_on_create][version]	integer	*	Actions version.
data[][actions_on_create][actions]	array	*	Actions array representation.
data[][actions_on_partial_approval_response]	object (TriggerActions)	*
data[][actions_on_partial_rejection_response]	object (TriggerActions)	*
data[][actions_on_cancel]	object (TriggerActions)	*
data[][actions_on_approved]	object (TriggerActions)	*
data[][actions_on_rejected]	object (TriggerActions)	*
data[][created_at]	DateTime	*
data[][can_choose_approvers]	boolean	*
data[][selected_approvers]	object (SelectedApprovers)	*
data[][approver_selection_criteria]	object (ApproverSelectionCriteria)	*
data[][approver_selection_criteria][can_select_ticket_user]	boolean	*
data[][approver_selection_criteria][can_select_organization_managers]	boolean	*
data[][approver_selection_criteria][can_select_from_all_agents]	boolean	*
data[][approver_selection_criteria][select_from_people][]	array of integers	*
data[][approver_selection_criteria][min_number_of_approvers]	integer	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/approval_templates CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

approvals.approval_templates.post

Parameters
Response
Status Codes

Parameter	Type	Required?
type	choice	true
name	string	true
description	string	false
required_approvals	integer	true
required_rejections	integer	true
can_approvers_view_subject	boolean	true
can_choose_approvers	boolean	true
actions_on_create	string	false
actions_on_partial_approval_response	string	false
actions_on_partial_rejection_response	string	false
actions_on_cancel	string	false
actions_on_approved	string	false
actions_on_rejected	string	false

Parameter	Type	Versions	Description
data.id	integer	*
data.name	string	*
data.description	string	*
data.required_approvals	integer	*
data.required_rejections	integer	*
data.type	integer id (ApprovalType)	*
data.can_approvers_view_subject	boolean	*
data.actions_on_create	object (TriggerActions)	*
data.actions_on_create[version]	integer	*	Actions version.
data.actions_on_create[actions]	array	*	Actions array representation.
data.actions_on_partial_approval_response	object (TriggerActions)	*
data.actions_on_partial_rejection_response	object (TriggerActions)	*
data.actions_on_cancel	object (TriggerActions)	*
data.actions_on_approved	object (TriggerActions)	*
data.actions_on_rejected	object (TriggerActions)	*
data.created_at	DateTime	*
data.can_choose_approvers	boolean	*
data.selected_approvers	object (SelectedApprovers)	*
data.approver_selection_criteria	object (ApproverSelectionCriteria)	*
data.approver_selection_criteria[can_select_ticket_user]	boolean	*
data.approver_selection_criteria[can_select_organization_managers]	boolean	*
data.approver_selection_criteria[can_select_from_all_agents]	boolean	*
data.approver_selection_criteria[select_from_people][]	array of integers	*
data.approver_selection_criteria[min_number_of_approvers]	integer	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/approval_templates/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

approvals.approval_templates.count

Parameters
Response
Status Codes

Parameter	Type	Required?
type	choice	true
name	string	true
description	string	false
required_approvals	integer	true
required_rejections	integer	true
can_approvers_view_subject	boolean	true
can_choose_approvers	boolean	true
actions_on_create	string	false
actions_on_partial_approval_response	string	false
actions_on_partial_rejection_response	string	false
actions_on_cancel	string	false
actions_on_approved	string	false
actions_on_rejected	string	false

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/approval_templates/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

approvals.approval_templates.delete

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?
type	choice	true
name	string	true
description	string	false
required_approvals	integer	true
required_rejections	integer	true
can_approvers_view_subject	boolean	true
can_choose_approvers	boolean	true
actions_on_create	string	false
actions_on_partial_approval_response	string	false
actions_on_partial_rejection_response	string	false
actions_on_cancel	string	false
actions_on_approved	string	false
actions_on_rejected	string	false

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/approval_templates/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

approvals.approval_templates.get

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?
type	choice	true
name	string	true
description	string	false
required_approvals	integer	true
required_rejections	integer	true
can_approvers_view_subject	boolean	true
can_choose_approvers	boolean	true
actions_on_create	string	false
actions_on_partial_approval_response	string	false
actions_on_partial_rejection_response	string	false
actions_on_cancel	string	false
actions_on_approved	string	false
actions_on_rejected	string	false

Parameter	Type	Versions	Description
data.id	integer	*
data.name	string	*
data.description	string	*
data.required_approvals	integer	*
data.required_rejections	integer	*
data.type	integer id (ApprovalType)	*
data.can_approvers_view_subject	boolean	*
data.actions_on_create	object (TriggerActions)	*
data.actions_on_create[version]	integer	*	Actions version.
data.actions_on_create[actions]	array	*	Actions array representation.
data.actions_on_partial_approval_response	object (TriggerActions)	*
data.actions_on_partial_rejection_response	object (TriggerActions)	*
data.actions_on_cancel	object (TriggerActions)	*
data.actions_on_approved	object (TriggerActions)	*
data.actions_on_rejected	object (TriggerActions)	*
data.created_at	DateTime	*
data.can_choose_approvers	boolean	*
data.selected_approvers	object (SelectedApprovers)	*
data.approver_selection_criteria	object (ApproverSelectionCriteria)	*
data.approver_selection_criteria[can_select_ticket_user]	boolean	*
data.approver_selection_criteria[can_select_organization_managers]	boolean	*
data.approver_selection_criteria[can_select_from_all_agents]	boolean	*
data.approver_selection_criteria[select_from_people][]	array of integers	*
data.approver_selection_criteria[min_number_of_approvers]	integer	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/approval_templates/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

approvals.approval_templates.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?
type	choice	false
name	string	false
description	string	false
required_approvals	integer	false
required_rejections	integer	false
can_approvers_view_subject	boolean	false
can_choose_approvers	boolean	false
actions_on_create	string	false
actions_on_partial_approval_response	string	false
actions_on_partial_rejection_response	string	false
actions_on_cancel	string	false
actions_on_approved	string	false
actions_on_rejected	string	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/approval_templates/{id}/ticket/{ticket}/approvers CRUD

Get a list of approvers

Applicable api modes

session token key oauth

Api tags for this endpoint

approvals.approval_templates.get_ticket_approvers

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
ticket

Parameter	Type	Required?
type	choice	true
name	string	true
description	string	false
required_approvals	integer	true
required_rejections	integer	true
can_approvers_view_subject	boolean	true
can_choose_approvers	boolean	true
actions_on_create	string	false
actions_on_partial_approval_response	string	false
actions_on_partial_rejection_response	string	false
actions_on_cancel	string	false
actions_on_approved	string	false
actions_on_rejected	string	false

Parameter	Type	Versions
data[]	array of objects (Person)	*
data[][emails]		*
data[][labels]		*
data[][teams]		*
data[][primary_team]		*
data[][agentData]		*
data[][publicUsergroups]		*
data[][publicAgentgroups]		*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

GET /api/v2/approval_types CRUD

get list of approval types

Applicable api modes

session token key oauth

Api tags for this endpoint

approvals.approval_types.list

Filters
Parameters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

is_deleted

Pattern	(1\|0)
Description	show only deleted approval types
Datatype	boolean

Parameter	Type	Required?
name	string	true
description	string	false
is_deleted	boolean	false

Parameter	Type	Versions
data[]	array of objects (ApprovalType)	*
data[][name]	string	*
data[][id]	integer	*
data[][description]	string	*
data[][is_deleted]	boolean	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/approval_types CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

approvals.approval_types.post

Parameters
Response
Status Codes

Parameter	Type	Required?
name	string	true
description	string	false
is_deleted	boolean	false

Parameter	Type	Versions
data.name	string	*
data.id	integer	*
data.description	string	*
data.is_deleted	boolean	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/approval_types/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

approvals.approval_types.count

Parameters
Response
Status Codes

Parameter	Type	Required?
name	string	true
description	string	false
is_deleted	boolean	false

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/approval_types/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

approvals.approval_types.delete

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?
name	string	true
description	string	false
is_deleted	boolean	false

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/approval_types/{id} CRUD

get approval type

Applicable api modes

session token key oauth

Api tags for this endpoint

approvals.approval_types.get

Requirements
Filters
Parameters
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Name

Information

is_deleted

Pattern	(1\|0)
Description	show a deleted approval type
Datatype	boolean

Parameter	Type	Required?
name	string	true
description	string	false
is_deleted	boolean	false

Parameter	Type	Versions
data.name	string	*
data.id	integer	*
data.description	string	*
data.is_deleted	boolean	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/approval_types/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

approvals.approval_types.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?
name	string	false
description	string	false
is_deleted	boolean	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/person/{personId}/approval_responses CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

approvals.person_approval_responses.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
personId	\d+

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (ApprovalResponse)	*
data[][vote_type]	string	*	Get pretty name for a vote
data[][id]	integer	*
data[][vote]	integer	*
data[][message]	string	*
data[][created_at]	DateTime	*
data[][approver]	integer id (Person)	*
data[][approval]	integer id (AbstractBaseApproval)	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

GET /api/v2/person/{personId}/approval_responses/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

approvals.person_approval_responses.count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
personId	\d+

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

POST /api/v2/ticket_approvals/{id}/approve CRUD

Approve an approval

Applicable api modes

session token key oauth

Api tags for this endpoint

approvals.ticket_approvals.approve

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format	Description
message	string	false

Parameter	Type	Versions	Description
data.vote_type	string	*	Get pretty name for a vote
data.id	integer	*
data.vote	integer	*
data.message	string	*
data.created_at	DateTime	*
data.approver	integer id (Person)	*
data.approval	integer id (AbstractBaseApproval)	*

Status Code	Description
201	Returned in case of successful resource created
400	We will return this in case your request was malformed

PUT /api/v2/ticket_approvals/{id}/cancel CRUD

Cancel an approval

Applicable api modes

session token key oauth

Api tags for this endpoint

approvals.ticket_approvals.cancel

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
204	Approval was cancelled
400	We will return this in case your request was malformed

POST /api/v2/ticket_approvals/{id}/reject CRUD

Reject an approval

Applicable api modes

session token key oauth

Api tags for this endpoint

approvals.ticket_approvals.reject

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format	Description
message	string	false

Parameter	Type	Versions	Description
data.vote_type	string	*	Get pretty name for a vote
data.id	integer	*
data.vote	integer	*
data.message	string	*
data.created_at	DateTime	*
data.approver	integer id (Person)	*
data.approval	integer id (AbstractBaseApproval)	*

Status Code	Description
201	Returned in case of successful resource created
400	We will return this in case your request was malformed

GET /api/v2/tickets/{ticketId}/ticket_approvals CRUD

Get collection of ticket approvals

Applicable api modes

session token key oauth

Api tags for this endpoint

approvals.ticket_approvals.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
ticketId	\d+

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (TicketApproval)	*
data[][id]	integer	*
data[][name]	string	*
data[][description]	string	*
data[][required_approvals]	integer	*
data[][required_rejections]	integer	*
data[][type]	integer id (ApprovalType)	*
data[][can_approvers_view_subject]	boolean	*
data[][actions_on_create]	object (TriggerActions)	*
data[][actions_on_create][version]	integer	*	Actions version.
data[][actions_on_create][actions]	array	*	Actions array representation.
data[][actions_on_partial_approval_response]	object (TriggerActions)	*
data[][actions_on_partial_rejection_response]	object (TriggerActions)	*
data[][actions_on_cancel]	object (TriggerActions)	*
data[][actions_on_approved]	object (TriggerActions)	*
data[][actions_on_rejected]	object (TriggerActions)	*
data[][created_at]	DateTime	*
data[][status]	string	*
data[][template]	integer id (ApprovalTemplate)	*
data[][responses][]	array of integer ids (ApprovalResponse)	*
data[][approvers][]	array of integer ids (Person)	*
data[][last_approved_response_at]	DateTime	*
data[][last_reject_response_at]	DateTime	*
data[][completed_at]	DateTime	*
data[][cancelled_at]	DateTime	*
data[][cancelled_by]	integer id (Person)	*
data[][ticket]	integer id (Ticket)	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/tickets/{ticketId}/ticket_approvals CRUD

Create a new ticket approval

Applicable api modes

session token key oauth

Api tags for this endpoint

approvals.ticket_approvals.post_approval

Requirements
Response
Status Codes

Name	Requirement	Type	Description
ticketId	\d+

Parameter	Type	Versions	Description
data.id	integer	*
data.name	string	*
data.description	string	*
data.required_approvals	integer	*
data.required_rejections	integer	*
data.type	integer id (ApprovalType)	*
data.can_approvers_view_subject	boolean	*
data.actions_on_create	object (TriggerActions)	*
data.actions_on_create[version]	integer	*	Actions version.
data.actions_on_create[actions]	array	*	Actions array representation.
data.actions_on_partial_approval_response	object (TriggerActions)	*
data.actions_on_partial_rejection_response	object (TriggerActions)	*
data.actions_on_cancel	object (TriggerActions)	*
data.actions_on_approved	object (TriggerActions)	*
data.actions_on_rejected	object (TriggerActions)	*
data.created_at	DateTime	*
data.status	string	*
data.template	integer id (ApprovalTemplate)	*
data.responses[]	array of integer ids (ApprovalResponse)	*
data.approvers[]	array of integer ids (Person)	*
data.last_approved_response_at	DateTime	*
data.last_reject_response_at	DateTime	*
data.completed_at	DateTime	*
data.cancelled_at	DateTime	*
data.cancelled_by	integer id (Person)	*
data.ticket	integer id (Ticket)	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/tickets/{ticketId}/ticket_approvals/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

approvals.ticket_approvals.count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
ticketId	\d+

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

Show/hide List Operations Expand Operations

Apps

GET /api/v2/apps/unsplash/random

Get random images from unsplash

Documentation

Get a random unsplash image.

Applicable api modes

session token key oauth

Api tags for this endpoint

apps.unsplash.random

Filters
Status Codes

Name

Information

count

Pattern	\d
Description	Resource per page count
Datatype	integer

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

GET /api/v2/apps/unsplash/search

Search for specific unsplash image

Documentation

Search for specific unsplash image.

Applicable api modes

session token key oauth

Api tags for this endpoint

apps.unsplash.search

Filters
Status Codes

Name

Information

query

Pattern	\s
Description	Search query
Datatype	string

page

Pattern	\d
Description	Page number
Datatype	integer

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

GET /api/v2/apps/zapier/example/{action}

Provide examples for Zapier webhooks

POST /api/v2/apps/zapier/hooks CRUD

Create a new resource

Applicable api modes

key

Api tags for this endpoint

apps.zapier_hooks.post

Response
Status Codes

Parameter	Type	Versions
data.person		*
data.id	integer	*
data.event	string	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

DELETE /api/v2/apps/zapier/hooks/{id} CRUD

Delete a resource

Applicable api modes

key

Api tags for this endpoint

apps.zapier_hooks.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/apps/zapier/ping

ping and if it not the case install Zapier app

Show/hide List Operations Expand Operations

Articles

POST /api/v2/article_comments/{article}/rate

rate article content

Documentation

Rate article comment.

Applicable api modes

session token key oauth

Api tags for this endpoint

content.comments.article_all_comments.rate_article_comment

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
articles	\d+	integer	the id of article
article		ArticleComment

Parameter	Type	Required?	Format	Description
upvote	choice	true	[0,1]

Status Code	Description
200	Returned if everything is OK

GET /api/v2/article_custom_fields CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

content.article_custom_fields.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (CustomDefArticle)	*
data[][title]		*
data[][parent]	object (CustomDefArticle)	*
data[][parent][parent]	object (CustomDefArticle)	*
data[][parent][children][]	array of objects (CustomDefArticle)	*	Field children.
data[][children][]	array of objects (CustomDefArticle)	*	Field children.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/article_custom_fields CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.article_custom_fields.post

Parameters
Response
Status Codes

Parameter	Type	Required?
title	string	true
description	string	true
handler_class	string	true
parent_id	string	true
default_value	string	true
is_enabled	boolean	true
options	string	true
aliases	string	true
is_user_enabled	boolean	true
is_agent_field	boolean	true
display_order	float	true

Parameter	Type	Versions	Description
data.title		*
data.parent	object (CustomDefArticle)	*
data.parent[parent]	object (CustomDefArticle)	*
data.parent[children][]	array of objects (CustomDefArticle)	*	Field children.
data.parent[title]		*
data.children[]	array of objects (CustomDefArticle)	*	Field children.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

DELETE /api/v2/article_custom_fields/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.article_custom_fields.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/article_custom_fields/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.article_custom_fields.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.title		*
data.parent	object (CustomDefArticle)	*
data.parent[parent]	object (CustomDefArticle)	*
data.parent[children][]	array of objects (CustomDefArticle)	*	Field children.
data.parent[title]		*
data.children[]	array of objects (CustomDefArticle)	*	Field children.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/article_custom_fields/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.article_custom_fields.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?
title	string	false
description	string	false
handler_class	string	false
parent_id	string	false
default_value	string	false
is_enabled	boolean	false
options	string	false
aliases	string	false
is_user_enabled	boolean	false
is_agent_field	boolean	false
display_order	float	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

POST /api/v2/articles/{article}/icon

set Icon

Documentation

Set icon for article.

Applicable api modes

session token key oauth

Api tags for this endpoint

content.articles.set_icon

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
article	\d+	integer	the id of article

Parameter	Type	Required?
urn	string	true
style	string	true
color	string	true

Status Code	Description
200	Returned if everything is OK

POST /api/v2/articles/{article}/splash_image

set Splash Image

Documentation

Set splash image for article.

Applicable api modes

session token key oauth

Api tags for this endpoint

content.articles.select_splash_image

Requirements
Status Codes

Name	Requirement	Type	Description
article	\d+	integer	the id of article

Status Code	Description
200	Returned if everything is OK

POST /api/v2/articles/{article}/splash_image_upload

Create Splash Image For Article

Applicable api modes

session token key oauth

Api tags for this endpoint

content.articles.upload_splash_image

Requirements
Status Codes

Name	Requirement	Type	Description
article	\d+	integer	the id of article

Status Code	Description
200	Returned if everything is OK

Show/hide List Operations Expand Operations

Auth

POST /api/v2/api_tokens

create a new api token

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.api_tokens.new_token

Parameters
Status Codes

Parameter	Type	Required?	Format	Description
	string	true	string	Password

Status Code	Description
201	Created token
401	Invalid credentials
400	Bad request

GET /api/v2/api_tokens/device_setup/{auth}

Authenticate device by authorization code and return auth tokens

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.api_tokens.authenticate_device

Requirements
Status Codes

Name	Requirement	Type	Description
auth		string

Status Code	Description
201	Created token
404	Auth code not found

POST /api/v2/api_tokens/encode_jwt

Takes data given to it by octopus SSO and converts it to a JWT that only this instance can use

POST /api/v2/api_tokens/magic_link/email

Sends magic link email

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.api_tokens.magic_link_email

Parameters
Status Codes

Parameter	Type	Required?	Format	Description
email	string	true
target	string	true

Status Code	Description
204	Created email

GET /api/v2/api_tokens/session

creates a new api token based on the authenticated user's session

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.api_tokens.new_session_token

Status Codes

Status Code	Description
201	Created token
401	Invalid credentials

GET /api/v2/api_tokens/user_sources/{context}.{_format}

Get list of api token usersources.

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.api_tokens.usersources_list

Requirements
Response
Status Codes

Name	Requirement	Type	Description
context	(agent\|user)	string
_format	(json\|html)	string

Parameter	Type	Versions	Description
data[]	array of objects (Usersource)	*
data[][id]	integer	*	The unique ID.
data[][title]	string	*	The title of this usersource.
data[][type]	string	*	"user" or "agent" for now. the interface this usersource applies to
data[][source_type]	string	*
data[][display_type]	string	*
data[][lost_password_url]	string	*
data[][display_order]	integer	*	The order in which to display this source in UserBundle.
data[][display_options]	array	*
data[][is_enabled]	boolean	*	True if this usersource is enabled/usable.
data[][is_all_brands]	boolean	*
data[][brands][]	array of integer ids (Brand)	*	Brands.
data[][is_sso_auto]	boolean	*

Status Code	Description
404	Usersource not found

GET /api/v2/api_tokens/user_sources/{usersource}/callback/{format}

Returns api token on usersource callback

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.api_tokens.usersource_callback

Requirements
Status Codes

Name	Requirement	Type	Description
format	(ios\|deskpro_scheme\|default\|app)	string
usersource

Status Code	Description
200	Created token

POST /api/v2/api_tokens/user_sources/{usersource}/callback/{format}

Returns api token on usersource callback

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.api_tokens.usersource_callback

Requirements
Status Codes

Name	Requirement	Type	Description
format	(ios\|deskpro_scheme\|default\|app)	string
usersource

Status Code	Description
200	Created token

GET /api/v2/api_tokens/user_sources/{usersource}/login

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.api_tokens.usersource_login

Requirements
Status Codes

Name	Requirement	Type	Description
usersource

Status Code	Description
404	Usersource not found

GET /api/v2/me

get information about the authenticated user

Documentation

Gather specific info about authentication.

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.me.me

Response
Status Codes

Parameter	Type	Versions	Description
data.auth_method	string	*	Current user auth method.
data.app_id	string	*	Current application id.
data.person_id	integer	*	Current person ID.
data.person	object (Person)	*	Person entity.
data.person[emails]		*
data.person[labels]		*
data.person[teams]		*
data.person[primary_team]		*
data.person[agentData]		*
data.person[publicUsergroups]		*
data.person[publicAgentgroups]		*
data.api_version	integer	*	Api version.
data.client_type	string	*	Client type.
data.client_version	string	*	Client version.

Status Code	Description
200	Returned if everything is ok

GET /api/v2/me/device-setup-token

get my profile action

Documentation

Get device setup token.

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.me.get_device_setup_token

Response
Status Codes

Parameter	Type	Versions	Description
data.setup_token	string	*

Status Code	Description
200	Returned if everything is ok

GET /api/v2/me/profile

get my profile action

Documentation

Get my profile.

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.profile.get

Response
Status Codes

Parameter	Type	Versions	Description
data.id	integer	*	The unique person ID.
data.name	string	*	Person name.
data.display_name	string	*	Person overridden name.
data.primary_email	string representation (PersonEmail)	*	Person primary email.
data.emails[]	array of string representations (PersonEmail)	*	Person emails list.
data.phone[]	array of strings	*	Person phone.
data.language_id	integer id (Language)	*	Person language.
data.timezone	string	*	Person timezone.
data.avatar	object (ProfileAvatar)	*	Persons avatar.
data.avatar[blob_auth_id]	string	*	Auth identity for this blob.
data.avatar[url]	string	*	Actual url with blob data.
data.initials	string	*	Persons initials.

Status Code	Description
200	Success

PUT /api/v2/me/profile

update my profile action

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.profile.put

Status Codes

Status Code	Description
200	Success
400	Bad request

GET /api/v2/oauth/vendor/{vendor}/client-id

Get the Oauth client ID for a particular vendor

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.o_auth.o_auth_vendor_clients.get_client_id_for_vendor

Requirements
Status Codes

Name	Requirement	Type	Description
vendor

Status Code	Description
200	Everything is ok
404	Oauth client not found for specified vendor

GET /api/v2/oauth/vendor/{vendor}/{clientId}/{tmpString}

Check if a particular token exists for a given vendor

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.o_auth.o_auth_vendor_clients.check_for_token

Requirements
Status Codes

Name	Requirement	Type	Description
vendor
clientId
tmpString

Status Code	Description
200	Everything is ok
404	Oauth client or token not found for specified vendor

GET /api/v2/oauth/vendor/{vendor}/{clientId}/{tmpString}/{token}/{personId}

Check that token has been created and allow it to be retrieved

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.o_auth.o_auth_vendor_clients.store_token

Requirements
Status Codes

Name	Requirement	Type	Description
vendor
clientId
tmpString
token
personId

Status Code	Description
200	Everything is ok
404	No valid token found

GET /api/v2/oauth_clients CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.o_auth.o_auth_clients.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (OAuthClient)	*
data[][name]	string	*
data[][context]	string	*
data[][redirectUris]		*
data[][id]	integer	*	The unique ID.
data[][random_id]	string	*
data[][secret]	string	*
data[][redirect_uris]	array	*
data[][allowed_grant_types]	array	*
data[][sys_name]	string	*
data[][date_created]	DateTime	*
data[][is_enabled]	boolean	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/oauth_clients CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.o_auth.o_auth_clients.post

Parameters
Response
Status Codes

Parameter	Type	Required?	Format
name	string	true
context	choice	true	["user","agent"]
allowed_grant_type	choice	true	["authorization_code","token"]
redirect_uris[]	array of strings	true
is_enabled	boolean	false

Parameter	Type	Versions	Description
data.name	string	*
data.context	string	*
data.redirectUris		*
data.id	integer	*	The unique ID.
data.random_id	string	*
data.secret	string	*
data.redirect_uris	array	*
data.allowed_grant_types	array	*
data.sys_name	string	*
data.date_created	DateTime	*
data.is_enabled	boolean	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/oauth_clients/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.o_auth.o_auth_clients.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/oauth_clients/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.o_auth.o_auth_clients.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/oauth_clients/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.o_auth.o_auth_clients.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.name	string	*
data.context	string	*
data.redirectUris		*
data.id	integer	*	The unique ID.
data.random_id	string	*
data.secret	string	*
data.redirect_uris	array	*
data.allowed_grant_types	array	*
data.sys_name	string	*
data.date_created	DateTime	*
data.is_enabled	boolean	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/oauth_clients/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.o_auth.o_auth_clients.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format
name	string	false
context	choice	false	["user","agent"]
allowed_grant_type	choice	false	["authorization_code","token"]
redirect_uris[]	array of strings	false
is_enabled	boolean	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

Show/hide List Operations Expand Operations

Blobs

GET /api/v2/blobs CRUD

Get collection of resources

Documentation

Entities list.

Selects entities based on the provided "ids" parameter or returns paginated list of no IDs provided. Look carefully at filters section to have a great filtering, grouping or sorting power

Applicable api modes

session token key oauth

Api tags for this endpoint

blobs.blobs.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[(\d:)?(((\d+\-)?[A-Z0-9]+)\|(\b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b)),]+
Description	Comma separated list of resource ids, the format of which depends on the Blobs version. Blobs v1: blob ID or AuthID, Blobs v2: uuid
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (Blob)	*
data[][authcode]	string	*
data[][labels][]	array of objects (LabelBlob)	*
data[][labels][][blob]	object (Blob)	*
data[][sys_name]	string	*	A unique system name for the blob.
data[][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][original_blob][sys_name]	string	*	A unique system name for the blob.
data[][original_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][original_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][original_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][original_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][original_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][original_blob][file_url]	string	*	The HTTP link to download the file.
data[][original_blob][authcode]	string	*
data[][original_blob][blob_hash]	string	*
data[][original_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][original_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][original_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][original_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][original_blob][date_created]	DateTime	*
data[][original_blob][is_temp]	boolean	*
data[][original_blob][source_ref]	string	*
data[][original_blob][labels][]	array of objects (LabelBlob)	*
data[][original_blob][labels][][blob]	object (Blob)	*
data[][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][save_path]	string	*	The path to the file if it's not stored in the database.
data[][file_url]	string	*	The HTTP link to download the file.
data[][blob_hash]	string	*
data[][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][date_created]	DateTime	*
data[][is_temp]	boolean	*
data[][source_ref]	string	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/blobs CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

blobs.blobs.post

Response
Status Codes

Parameter	Type	Versions	Description
data.authcode	string	*
data.labels[]	array of objects (LabelBlob)	*
data.labels[][blob]	object (Blob)	*
data.labels[][blob][sys_name]	string	*	A unique system name for the blob.
data.labels[][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][blob][file_url]	string	*	The HTTP link to download the file.
data.labels[][blob][authcode]	string	*
data.labels[][blob][blob_hash]	string	*
data.labels[][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][blob][date_created]	DateTime	*
data.labels[][blob][is_temp]	boolean	*
data.labels[][blob][source_ref]	string	*
data.labels[][blob][labels][]	array of objects (LabelBlob)	*
data.labels[][label]		*
data.sys_name	string	*	A unique system name for the blob.
data.original_blob	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.original_blob[sys_name]	string	*	A unique system name for the blob.
data.original_blob[original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.original_blob[storage_loc]	string	*	The storage adapter that knows how to load this file.
data.original_blob[storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.original_blob[storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.original_blob[save_path]	string	*	The path to the file if it's not stored in the database.
data.original_blob[file_url]	string	*	The HTTP link to download the file.
data.original_blob[authcode]	string	*
data.original_blob[blob_hash]	string	*
data.original_blob[is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.original_blob[title]	string	*	The title of this file used in interfaces if its a media upload.
data.original_blob[dim_w]	integer	*	If this type of file has dimentions, the width.
data.original_blob[dim_h]	integer	*	If this type of file has dimentions, the height.
data.original_blob[date_created]	DateTime	*
data.original_blob[is_temp]	boolean	*
data.original_blob[source_ref]	string	*
data.original_blob[labels][]	array of objects (LabelBlob)	*
data.original_blob[labels][][blob]	object (Blob)	*
data.storage_loc	string	*	The storage adapter that knows how to load this file.
data.storage_loc_pref	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.storage_loc_specific	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.save_path	string	*	The path to the file if it's not stored in the database.
data.file_url	string	*	The HTTP link to download the file.
data.blob_hash	string	*
data.is_media_upload	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.title	string	*	The title of this file used in interfaces if its a media upload.
data.dim_w	integer	*	If this type of file has dimentions, the width.
data.dim_h	integer	*	If this type of file has dimentions, the height.
data.date_created	DateTime	*
data.is_temp	boolean	*
data.source_ref	string	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/blobs/{authId}/archive

See archive info

GET /api/v2/blobs/{authId}/download/{path}

Serve archived content

GET /api/v2/blobs/{authId}/files

See archive content

DELETE /api/v2/blobs/{id} CRUD

Delete a blob

Documentation

Obviously it's an ability to erase what you've done. Be careful there is no CTRL+Z shortcut.

Applicable api modes

key

Api tags for this endpoint

blobs.blobs.delete

Requirements
Status Codes

Name	Requirement	Type	Description
authId	(\d+\-)?[A-Z0-9]+	integer	The id of the resource
id	(\d+\-)?[A-Z0-9]+	int

Status Code	Description
200	Returned if everything is ok and there is no such blob anymore
404	Well, looks like either blob already deleted either it doesn't exists at all

GET /api/v2/blobs/{id} CRUD

Get a resource

Documentation

Get resource with provided id.

Applicable api modes

session token key oauth

Api tags for this endpoint

blobs.blobs.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	(\d+\-)?[A-Z0-9]+	integer	The id of the resource, the format of which depends on the Blobs version. Blobs v1: blob ID or AuthID, Blobs v2: uuid

Parameter	Type	Versions	Description
data.authcode	string	*
data.labels[]	array of objects (LabelBlob)	*
data.labels[][blob]	object (Blob)	*
data.labels[][blob][sys_name]	string	*	A unique system name for the blob.
data.labels[][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][blob][file_url]	string	*	The HTTP link to download the file.
data.labels[][blob][authcode]	string	*
data.labels[][blob][blob_hash]	string	*
data.labels[][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][blob][date_created]	DateTime	*
data.labels[][blob][is_temp]	boolean	*
data.labels[][blob][source_ref]	string	*
data.labels[][blob][labels][]	array of objects (LabelBlob)	*
data.labels[][label]		*
data.sys_name	string	*	A unique system name for the blob.
data.original_blob	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.original_blob[sys_name]	string	*	A unique system name for the blob.
data.original_blob[original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.original_blob[storage_loc]	string	*	The storage adapter that knows how to load this file.
data.original_blob[storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.original_blob[storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.original_blob[save_path]	string	*	The path to the file if it's not stored in the database.
data.original_blob[file_url]	string	*	The HTTP link to download the file.
data.original_blob[authcode]	string	*
data.original_blob[blob_hash]	string	*
data.original_blob[is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.original_blob[title]	string	*	The title of this file used in interfaces if its a media upload.
data.original_blob[dim_w]	integer	*	If this type of file has dimentions, the width.
data.original_blob[dim_h]	integer	*	If this type of file has dimentions, the height.
data.original_blob[date_created]	DateTime	*
data.original_blob[is_temp]	boolean	*
data.original_blob[source_ref]	string	*
data.original_blob[labels][]	array of objects (LabelBlob)	*
data.original_blob[labels][][blob]	object (Blob)	*
data.storage_loc	string	*	The storage adapter that knows how to load this file.
data.storage_loc_pref	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.storage_loc_specific	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.save_path	string	*	The path to the file if it's not stored in the database.
data.file_url	string	*	The HTTP link to download the file.
data.blob_hash	string	*
data.is_media_upload	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.title	string	*	The title of this file used in interfaces if its a media upload.
data.dim_w	integer	*	If this type of file has dimentions, the width.
data.dim_h	integer	*	If this type of file has dimentions, the height.
data.date_created	DateTime	*
data.is_temp	boolean	*
data.source_ref	string	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

Show/hide List Operations Expand Operations

Brands

GET /api/v2/brands CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

brands.brands.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (Brand)	*
data[][id]	integer	*	The unique ID.
data[][name]	string	*	The brand name.
data[][slug]	string	*
data[][url]	string	*	The brand url.
data[][theme_set]	object (ThemeSet)	*
data[][theme_set][id]	integer	*
data[][theme_set][theme_id]	string	*
data[][theme_set][title]	string	*
data[][edit_theme_set]	object (ThemeSet)	*
data[][departments][]	array of objects (Department)	*
data[][departments][][id]	integer	*
data[][departments][][parent]	object (Department)	*
data[][departments][][children][]	array of objects (Department)	*
data[][departments][][title]	string	*
data[][departments][][user_title]	string	*
data[][departments][][is_tickets_enabled]	boolean	*
data[][departments][][is_chat_enabled]	boolean	*
data[][departments][][display_order]	integer	*
data[][departments][][avatar]	object (Blob)	*
data[][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data[][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data[][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data[][departments][][avatar][authcode]	string	*
data[][departments][][avatar][blob_hash]	string	*
data[][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][departments][][avatar][date_created]	DateTime	*
data[][departments][][avatar][is_temp]	boolean	*
data[][departments][][avatar][source_ref]	string	*
data[][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data[][departments][][avatar][labels][][blob]	object (Blob)	*
data[][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][departments][][brands][]	array of objects (Brand)	*
data[][departments][][brands][][id]	integer	*	The unique ID.
data[][departments][][brands][][name]	string	*	The brand name.
data[][departments][][brands][][slug]	string	*
data[][departments][][brands][][url]	string	*	The brand url.
data[][departments][][brands][][theme_set]	object (ThemeSet)	*
data[][departments][][brands][][edit_theme_set]	object (ThemeSet)	*
data[][departments][][brands][][departments][]	array of objects (Department)	*
data[][departments][][brands][][theme_sets][]	array of objects (ThemeSet)	*
data[][departments][][permissions][]	array of objects (DepartmentPermission)	*
data[][departments][][permissions][][department]	integer id (Department)	*
data[][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][departments][][permissions][][name]	string	*	The name of the permission.
data[][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][departments][][permissions][][is_active]	boolean	*
data[][departments][][chat_queue]	object (UserChatQueue)	*
data[][departments][][chat_queue][id]	integer	*	The unique ID.
data[][departments][][chat_queue][name]	string	*
data[][departments][][chat_queue][routing_model]	string	*
data[][departments][][chat_queue][answer_timeout]	integer	*
data[][departments][][chat_queue][is_all_agents]	boolean	*
data[][departments][][chat_queue][departments][]	array of objects (Department)	*
data[][departments][][chat_queue][max_queue_size]	integer	*
data[][theme_sets][]	array of objects (ThemeSet)	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/brands

create a brand

Documentation

This endpoint gives an ability to create a new Brand.

Applicable api modes

session token key oauth

Api tags for this endpoint

brands.brands.post

Parameters
Response
Status Codes

Parameter	Type	Required?
name	string	true
slug	string	true
url	string	true

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.name	string	*	The brand name.
data.slug	string	*
data.url	string	*	The brand url.
data.theme_set	object (ThemeSet)	*
data.theme_set[id]	integer	*
data.theme_set[theme_id]	string	*
data.theme_set[title]	string	*
data.theme_set[options]		*
data.edit_theme_set	object (ThemeSet)	*
data.departments[]	array of objects (Department)	*
data.departments[][id]	integer	*
data.departments[][parent]	object (Department)	*
data.departments[][children][]	array of objects (Department)	*
data.departments[][title]	string	*
data.departments[][user_title]	string	*
data.departments[][is_tickets_enabled]	boolean	*
data.departments[][is_chat_enabled]	boolean	*
data.departments[][display_order]	integer	*
data.departments[][avatar]	object (Blob)	*
data.departments[][avatar][sys_name]	string	*	A unique system name for the blob.
data.departments[][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.departments[][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.departments[][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.departments[][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.departments[][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.departments[][avatar][file_url]	string	*	The HTTP link to download the file.
data.departments[][avatar][authcode]	string	*
data.departments[][avatar][blob_hash]	string	*
data.departments[][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.departments[][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.departments[][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.departments[][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.departments[][avatar][date_created]	DateTime	*
data.departments[][avatar][is_temp]	boolean	*
data.departments[][avatar][source_ref]	string	*
data.departments[][avatar][labels][]	array of objects (LabelBlob)	*
data.departments[][avatar][labels][][blob]	object (Blob)	*
data.departments[][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.departments[][brands][]	array of objects (Brand)	*
data.departments[][brands][][id]	integer	*	The unique ID.
data.departments[][brands][][name]	string	*	The brand name.
data.departments[][brands][][slug]	string	*
data.departments[][brands][][url]	string	*	The brand url.
data.departments[][brands][][theme_set]	object (ThemeSet)	*
data.departments[][brands][][edit_theme_set]	object (ThemeSet)	*
data.departments[][brands][][departments][]	array of objects (Department)	*
data.departments[][brands][][theme_sets][]	array of objects (ThemeSet)	*
data.departments[][permissions][]	array of objects (DepartmentPermission)	*
data.departments[][permissions][][department]	integer id (Department)	*
data.departments[][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.departments[][permissions][][name]	string	*	The name of the permission.
data.departments[][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.departments[][permissions][][is_active]	boolean	*
data.departments[][chat_queue]	object (UserChatQueue)	*
data.departments[][chat_queue][id]	integer	*	The unique ID.
data.departments[][chat_queue][name]	string	*
data.departments[][chat_queue][routing_model]	string	*
data.departments[][chat_queue][answer_timeout]	integer	*
data.departments[][chat_queue][is_all_agents]	boolean	*
data.departments[][chat_queue][departments][]	array of objects (Department)	*
data.departments[][chat_queue][max_queue_size]	integer	*
data.departments[][chat_queue][routingModel]		*
data.theme_sets[]	array of objects (ThemeSet)	*

Status Code	Description
201	Brand was created

DELETE /api/v2/brands/{id} CRUD

Delete a resource

Documentation

Obviously it's an ability to erase what you've done. Be careful there is no CTRL+Z shortcut.

Applicable api modes

session token key oauth

Api tags for this endpoint

brands.brands.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/brands/{id} CRUD

Get a brand

Documentation

Get resource with provided id.

Applicable api modes

session token key oauth

Api tags for this endpoint

brands.brands.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	default\|\d+	integer	The id of the resource or default

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.name	string	*	The brand name.
data.slug	string	*
data.url	string	*	The brand url.
data.theme_set	object (ThemeSet)	*
data.theme_set[id]	integer	*
data.theme_set[theme_id]	string	*
data.theme_set[title]	string	*
data.theme_set[options]		*
data.edit_theme_set	object (ThemeSet)	*
data.departments[]	array of objects (Department)	*
data.departments[][id]	integer	*
data.departments[][parent]	object (Department)	*
data.departments[][children][]	array of objects (Department)	*
data.departments[][title]	string	*
data.departments[][user_title]	string	*
data.departments[][is_tickets_enabled]	boolean	*
data.departments[][is_chat_enabled]	boolean	*
data.departments[][display_order]	integer	*
data.departments[][avatar]	object (Blob)	*
data.departments[][avatar][sys_name]	string	*	A unique system name for the blob.
data.departments[][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.departments[][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.departments[][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.departments[][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.departments[][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.departments[][avatar][file_url]	string	*	The HTTP link to download the file.
data.departments[][avatar][authcode]	string	*
data.departments[][avatar][blob_hash]	string	*
data.departments[][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.departments[][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.departments[][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.departments[][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.departments[][avatar][date_created]	DateTime	*
data.departments[][avatar][is_temp]	boolean	*
data.departments[][avatar][source_ref]	string	*
data.departments[][avatar][labels][]	array of objects (LabelBlob)	*
data.departments[][avatar][labels][][blob]	object (Blob)	*
data.departments[][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.departments[][brands][]	array of objects (Brand)	*
data.departments[][brands][][id]	integer	*	The unique ID.
data.departments[][brands][][name]	string	*	The brand name.
data.departments[][brands][][slug]	string	*
data.departments[][brands][][url]	string	*	The brand url.
data.departments[][brands][][theme_set]	object (ThemeSet)	*
data.departments[][brands][][edit_theme_set]	object (ThemeSet)	*
data.departments[][brands][][departments][]	array of objects (Department)	*
data.departments[][brands][][theme_sets][]	array of objects (ThemeSet)	*
data.departments[][permissions][]	array of objects (DepartmentPermission)	*
data.departments[][permissions][][department]	integer id (Department)	*
data.departments[][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.departments[][permissions][][name]	string	*	The name of the permission.
data.departments[][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.departments[][permissions][][is_active]	boolean	*
data.departments[][chat_queue]	object (UserChatQueue)	*
data.departments[][chat_queue][id]	integer	*	The unique ID.
data.departments[][chat_queue][name]	string	*
data.departments[][chat_queue][routing_model]	string	*
data.departments[][chat_queue][answer_timeout]	integer	*
data.departments[][chat_queue][is_all_agents]	boolean	*
data.departments[][chat_queue][departments][]	array of objects (Department)	*
data.departments[][chat_queue][max_queue_size]	integer	*
data.departments[][chat_queue][routingModel]		*
data.theme_sets[]	array of objects (ThemeSet)	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

Show/hide List Operations Expand Operations

Chats

GET /api/v2/agent_chats CRUD unstable

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.agent_chats.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (AgentChat)	*
data[][departments][]	array of integer ids (Department)	*	Collection of departments participating in this chat.
data[][agent_teams][]	array of integer ids (AgentTeam)	*	Collection of agent teams participating in this chat.
data[][agents][]	array of integer ids (Person)	*	Collection of agents participating (directly added) in this chat.
data[][id]	integer	*	Id of chat.
data[][chat_type]	string	*	Current chat type, could be agent, agent_team, department or everyone (one instance per whole helpdesk).
data[][is_pinned]	boolean	*	Indicate is chat pinned or not.
data[][date_created]	DateTime	*	DateTime when chat was first time created.
data[][date_last_message]	DateTime	*	Obviously - last message date time.
data[][name]	string	*	Custom groups name for chat with type = 'group'.
data[][admin]	integer id (Person)	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/agent_chats unstable

create an agent`s chat

Documentation

This endpoint gives an ability to start chat with some person, team, department or with everyone in helpdesk.

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.agent_chats.post

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
participant	\d+	integer	an entity identifier
type	(agent\|team\|department\|everyone\|group)	integer	an entity type to start chat with

Parameter	Type	Required?	Format	Description
type	choice	true	["agent","team","department","group","everyone"]

Parameter	Type	Versions	Description
data.departments[]	array of integer ids (Department)	*	Collection of departments participating in this chat.
data.agent_teams[]	array of integer ids (AgentTeam)	*	Collection of agent teams participating in this chat.
data.agents[]	array of integer ids (Person)	*	Collection of agents participating (directly added) in this chat.
data.id	integer	*	Id of chat.
data.chat_type	string	*	Current chat type, could be agent, agent_team, department or everyone (one instance per whole helpdesk).
data.is_pinned	boolean	*	Indicate is chat pinned or not.
data.date_created	DateTime	*	DateTime when chat was first time created.
data.date_last_message	DateTime	*	Obviously - last message date time.
data.name	string	*	Custom groups name for chat with type = 'group'.
data.admin	integer id (Person)	*

Status Code	Description
201	Chat was created
302	We found already started chat with given parameters
400	Couldn't start chat with given parameters

GET /api/v2/agent_chats/counts CRUD unstable

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.agent_chats.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

GET /api/v2/agent_chats/groups unstable
- get agent chat groups
Documentation

This endpoint gives an ability to start chat with some person, team, department or with everyone in helpdesk.

Applicable api modes
session token key oauth
Api tags for this endpoint
chats.agent_chats.get_group_chats

GET /api/v2/agent_chats/messages/counts CRUD unstable

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.agent_chat_all_messages.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/agent_chats/{id} CRUD unstable

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.agent_chats.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/agent_chats/{id} CRUD unstable

Get a resource

Documentation

Retrieves an agent chat with provided id

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.agent_chats.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.departments[]	array of integer ids (Department)	*	Collection of departments participating in this chat.
data.agent_teams[]	array of integer ids (AgentTeam)	*	Collection of agent teams participating in this chat.
data.agents[]	array of integer ids (Person)	*	Collection of agents participating (directly added) in this chat.
data.id	integer	*	Id of chat.
data.chat_type	string	*	Current chat type, could be agent, agent_team, department or everyone (one instance per whole helpdesk).
data.is_pinned	boolean	*	Indicate is chat pinned or not.
data.date_created	DateTime	*	DateTime when chat was first time created.
data.date_last_message	DateTime	*	Obviously - last message date time.
data.name	string	*	Custom groups name for chat with type = 'group'.
data.admin	integer id (Person)	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/agent_chats/{id} unstable

update an agent chat

Documentation

This endpoint gives an ability to start chat with some person, team, department or with everyone in helpdesk.

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.agent_chats.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	a chat id
participant	\d+	integer	an entity identifier
type	(agent\|team\|department\|everyone\|group)	integer	an entity type to start chat with

Parameter	Type	Required?	Format	Description
type	choice	false	["agent","team","department","group","everyone"]

Status Code	Description
204	Chat was updated

DELETE /api/v2/agent_chats/{id}/delete unstable

delete group

Documentation

This endpoint gives an ability to start chat with some person, team, department or with everyone in helpdesk.

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.agent_chats.delete_group

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	a chat id

Status Code	Description
204	Chat was deleted
403	You are not admin or chat is not group chat

DELETE /api/v2/agent_chats/{id}/leave unstable

leave group

Documentation

This endpoint gives an ability to start chat with some person, team, department or with everyone in helpdesk.

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.agent_chats.leave_group

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	a chat id

Status Code	Description
204	Chat was deleted
403	You are admin or chat is not group chat

GET /api/v2/agent_chats/{parentId}/messages CRUD unstable

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.agent_chat_messages.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Datatype

string

order

Datatype	string
Pattern	date_created

Parameter	Type	Versions	Description
data[]	array of objects (AgentChatMessage)	*
data[][uuid]	string	*	A UUID of this message.
data[][person_name]	string	*	Person`s name (will never change, even Person changed they name).
data[][message]	string	*	The message itself. Note: this is HTML.
data[][message_text]	string	*	The message in text only for search purposes.
data[][metadata]	array	*	Additional data attached to message (not implemented).
data[][date_created]	DateTime	*	The date message was originally sent.
data[][timestamp]	integer	*
data[][id]	integer	*	The unique message ID.
data[][chat]	integer id (AgentChat)	*	The chat this message was sent.
data[][person]	integer id (Person)	*	Person that sent this message.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/agent_chats/{parentId}/messages CRUD unstable

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.agent_chat_messages.post

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Required?	Format	Description
message	string	true
uuid	string	true

Parameter	Type	Versions	Description
data.uuid	string	*	A UUID of this message.
data.person_name	string	*	Person`s name (will never change, even Person changed they name).
data.message	string	*	The message itself. Note: this is HTML.
data.message_text	string	*	The message in text only for search purposes.
data.metadata	array	*	Additional data attached to message (not implemented).
data.date_created	DateTime	*	The date message was originally sent.
data.timestamp	integer	*
data.id	integer	*	The unique message ID.
data.chat	integer id (AgentChat)	*	The chat this message was sent.
data.person	integer id (Person)	*	Person that sent this message.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/agent_chats/{parentId}/messages/counts CRUD unstable

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.agent_chat_messages.count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

PUT /api/v2/agent_chats/{parentId}/messages/mark unstable

mark message as sent/read

Documentation

Mark message with given id as sent/read.

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.agent_chat_messages.mark_messages

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
ids	[\d+]	integer[]	Array of ids to update with given status
status	1\|2	integer	Read status. 1 => sent, 2 => read
parentId

Parameter	Type	Required?	Format	Description
ids[]	array of choices	false
status	choice	false	[1,2]

Status Code	Description
204	Returned if success
400	Returned if given status was wrong Returned if ids list was wrong formed

PUT /api/v2/agent_chats/{parentId}/messages/mark_all unstable

mark message as sent/read

Documentation

Mark message with given id as sent/read.

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.agent_chat_messages.mark_all_messages

Requirements
Status Codes

Name	Requirement	Type	Description
parentId

Status Code	Description
204	Returned if success
400	Returned if given status was wrong Returned if ids list was wrong formed

DELETE /api/v2/agent_chats/{parentId}/messages/{id} CRUD unstable

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.agent_chat_messages.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/agent_chats/{parentId}/messages/{id} CRUD unstable

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.agent_chat_messages.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Versions	Description
data.uuid	string	*	A UUID of this message.
data.person_name	string	*	Person`s name (will never change, even Person changed they name).
data.message	string	*	The message itself. Note: this is HTML.
data.message_text	string	*	The message in text only for search purposes.
data.metadata	array	*	Additional data attached to message (not implemented).
data.date_created	DateTime	*	The date message was originally sent.
data.timestamp	integer	*
data.id	integer	*	The unique message ID.
data.chat	integer id (AgentChat)	*	The chat this message was sent.
data.person	integer id (Person)	*	Person that sent this message.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/agent_chats/{parentId}/messages/{id} CRUD unstable

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.agent_chat_messages.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Required?	Format	Description
message	string	false
uuid	string	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/agent_chats/{parentId}/messages/{id}/page unstable

get page where this message is

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.agent_chat_messages.find_message_page

Requirements
Response
Status Codes

Name	Requirement	Type	Description
parentId
id

Parameter	Type	Versions	Description
data.integer	object (integer)	*

Status Code	Description
204	Returned if success
400	Returned if given status was wrong Returned if ids list was wrong formed

GET /api/v2/user_chat_custom_fields CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chat_custom_fields.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (CustomDefChat)	*
data[][title]		*
data[][parent]	object (CustomDefChat)	*
data[][parent][parent]	object (CustomDefChat)	*
data[][parent][children][]	array of objects (CustomDefChat)	*	Field children.
data[][children][]	array of objects (CustomDefChat)	*	Field children.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/user_chat_custom_fields CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chat_custom_fields.post

Parameters
Response
Status Codes

Parameter	Type	Required?	Format	Description
handler_class	choice	true	["Application\\DeskPRO\\CustomFields\\Handler\\Text","Application\\DeskPRO\\CustomFields\\Handler\\Textarea","Application\\DeskPRO\\CustomFields\\Handler\\Choice","Application\\DeskPRO\\CustomFields\\Handler\\Toggle","Application\\DeskPRO\\CustomFields\\Handler\\Date","Application\\DeskPRO\\CustomFields\\Handler\\DateTime","Application\\DeskPRO\\CustomFields\\Handler\\Display","Application\\DeskPRO\\CustomFields\\Handler\\Hidden","Application\\DeskPRO\\CustomFields\\Handler\\Data","Application\\DeskPRO\\CustomFields\\Handler\\DataJson","Application\\DeskPRO\\CustomFields\\Handler\\Javascript","Application\\DeskPRO\\CustomFields\\Handler\\DataList","Application\\DeskPRO\\CustomFields\\Handler\\Url","Application\\DeskPRO\\CustomFields\\Handler\\Number","Application\\DeskPRO\\CustomFields\\Handler\\Currency","Application\\DeskPRO\\CustomFields\\Handler\\File","Application\\DeskPRO\\CustomFields\\Handler\\ExternalUniqueKey"]

Parameter	Type	Versions	Description
data.title		*
data.parent	object (CustomDefChat)	*
data.parent[parent]	object (CustomDefChat)	*
data.parent[children][]	array of objects (CustomDefChat)	*	Field children.
data.parent[title]		*
data.children[]	array of objects (CustomDefChat)	*	Field children.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

DELETE /api/v2/user_chat_custom_fields/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chat_custom_fields.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/user_chat_custom_fields/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chat_custom_fields.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.title		*
data.parent	object (CustomDefChat)	*
data.parent[parent]	object (CustomDefChat)	*
data.parent[children][]	array of objects (CustomDefChat)	*	Field children.
data.parent[title]		*
data.children[]	array of objects (CustomDefChat)	*	Field children.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/user_chat_custom_fields/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chat_custom_fields.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format	Description
handler_class	choice	false	["Application\\DeskPRO\\CustomFields\\Handler\\Text","Application\\DeskPRO\\CustomFields\\Handler\\Textarea","Application\\DeskPRO\\CustomFields\\Handler\\Choice","Application\\DeskPRO\\CustomFields\\Handler\\Toggle","Application\\DeskPRO\\CustomFields\\Handler\\Date","Application\\DeskPRO\\CustomFields\\Handler\\DateTime","Application\\DeskPRO\\CustomFields\\Handler\\Display","Application\\DeskPRO\\CustomFields\\Handler\\Hidden","Application\\DeskPRO\\CustomFields\\Handler\\Data","Application\\DeskPRO\\CustomFields\\Handler\\DataJson","Application\\DeskPRO\\CustomFields\\Handler\\Javascript","Application\\DeskPRO\\CustomFields\\Handler\\DataList","Application\\DeskPRO\\CustomFields\\Handler\\Url","Application\\DeskPRO\\CustomFields\\Handler\\Number","Application\\DeskPRO\\CustomFields\\Handler\\Currency","Application\\DeskPRO\\CustomFields\\Handler\\File","Application\\DeskPRO\\CustomFields\\Handler\\ExternalUniqueKey"]

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/user_chat_custom_fields/{parentId}/options CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chat_custom_field_options.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (CustomDefChat)	*
data[][title]		*
data[][parent]	object (CustomDefChat)	*
data[][parent][parent]	object (CustomDefChat)	*
data[][parent][children][]	array of objects (CustomDefChat)	*	Field children.
data[][children][]	array of objects (CustomDefChat)	*	Field children.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/user_chat_custom_fields/{parentId}/options CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chat_custom_field_options.post

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Required?	Format	Description
title	string	true
display_order	integer	false

Parameter	Type	Versions	Description
data.title		*
data.parent	object (CustomDefChat)	*
data.parent[parent]	object (CustomDefChat)	*
data.parent[children][]	array of objects (CustomDefChat)	*	Field children.
data.parent[title]		*
data.children[]	array of objects (CustomDefChat)	*	Field children.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/user_chat_custom_fields/{parentId}/options/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chat_custom_field_options.count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/user_chat_custom_fields/{parentId}/options/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chat_custom_field_options.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/user_chat_custom_fields/{parentId}/options/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chat_custom_field_options.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Versions	Description
data.title		*
data.parent	object (CustomDefChat)	*
data.parent[parent]	object (CustomDefChat)	*
data.parent[children][]	array of objects (CustomDefChat)	*	Field children.
data.parent[title]		*
data.children[]	array of objects (CustomDefChat)	*	Field children.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/user_chat_custom_fields/{parentId}/options/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chat_custom_field_options.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Required?	Format	Description
title	string	false
display_order	integer	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/user_chat_queues CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chat_queues.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (UserChatQueue)	*
data[][name]	string	*
data[][routingModel]		*
data[][id]	integer	*	The unique ID.
data[][routing_model]	string	*
data[][answer_timeout]	integer	*
data[][is_all_agents]	boolean	*
data[][departments][]	array of objects (Department)	*
data[][departments][][id]	integer	*
data[][departments][][parent]	object (Department)	*
data[][departments][][children][]	array of objects (Department)	*
data[][departments][][title]	string	*
data[][departments][][user_title]	string	*
data[][departments][][is_tickets_enabled]	boolean	*
data[][departments][][is_chat_enabled]	boolean	*
data[][departments][][display_order]	integer	*
data[][departments][][avatar]	object (Blob)	*
data[][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data[][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data[][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data[][departments][][avatar][authcode]	string	*
data[][departments][][avatar][blob_hash]	string	*
data[][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][departments][][avatar][date_created]	DateTime	*
data[][departments][][avatar][is_temp]	boolean	*
data[][departments][][avatar][source_ref]	string	*
data[][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data[][departments][][avatar][labels][][blob]	object (Blob)	*
data[][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][departments][][brands][]	array of objects (Brand)	*
data[][departments][][brands][][id]	integer	*	The unique ID.
data[][departments][][brands][][name]	string	*	The brand name.
data[][departments][][brands][][slug]	string	*
data[][departments][][brands][][url]	string	*	The brand url.
data[][departments][][brands][][theme_set]	object (ThemeSet)	*
data[][departments][][brands][][theme_set][id]	integer	*
data[][departments][][brands][][theme_set][theme_id]	string	*
data[][departments][][brands][][theme_set][title]	string	*
data[][departments][][brands][][edit_theme_set]	object (ThemeSet)	*
data[][departments][][brands][][departments][]	array of objects (Department)	*
data[][departments][][brands][][theme_sets][]	array of objects (ThemeSet)	*
data[][departments][][permissions][]	array of objects (DepartmentPermission)	*
data[][departments][][permissions][][department]	integer id (Department)	*
data[][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][departments][][permissions][][name]	string	*	The name of the permission.
data[][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][departments][][permissions][][is_active]	boolean	*
data[][departments][][chat_queue]	object (UserChatQueue)	*
data[][departments][][chat_queue][id]	integer	*	The unique ID.
data[][departments][][chat_queue][name]	string	*
data[][departments][][chat_queue][routing_model]	string	*
data[][departments][][chat_queue][answer_timeout]	integer	*
data[][departments][][chat_queue][is_all_agents]	boolean	*
data[][departments][][chat_queue][departments][]	array of objects (Department)	*
data[][departments][][chat_queue][max_queue_size]	integer	*
data[][max_queue_size]	integer	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/user_chat_queues CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chat_queues.post

Parameters
Response
Status Codes

Parameter	Type	Required?	Format
name	string	true
routing_model	choice	true	["round_robin","round_robin_optional","least_utilized","simulring"]
max_queue_size	integer	true
answer_timeout	integer	true
is_all_agents	boolean	true

Parameter	Type	Versions	Description
data.name	string	*
data.routingModel		*
data.id	integer	*	The unique ID.
data.routing_model	string	*
data.answer_timeout	integer	*
data.is_all_agents	boolean	*
data.departments[]	array of objects (Department)	*
data.departments[][id]	integer	*
data.departments[][parent]	object (Department)	*
data.departments[][children][]	array of objects (Department)	*
data.departments[][title]	string	*
data.departments[][user_title]	string	*
data.departments[][is_tickets_enabled]	boolean	*
data.departments[][is_chat_enabled]	boolean	*
data.departments[][display_order]	integer	*
data.departments[][avatar]	object (Blob)	*
data.departments[][avatar][sys_name]	string	*	A unique system name for the blob.
data.departments[][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.departments[][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.departments[][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.departments[][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.departments[][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.departments[][avatar][file_url]	string	*	The HTTP link to download the file.
data.departments[][avatar][authcode]	string	*
data.departments[][avatar][blob_hash]	string	*
data.departments[][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.departments[][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.departments[][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.departments[][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.departments[][avatar][date_created]	DateTime	*
data.departments[][avatar][is_temp]	boolean	*
data.departments[][avatar][source_ref]	string	*
data.departments[][avatar][labels][]	array of objects (LabelBlob)	*
data.departments[][avatar][labels][][blob]	object (Blob)	*
data.departments[][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.departments[][brands][]	array of objects (Brand)	*
data.departments[][brands][][id]	integer	*	The unique ID.
data.departments[][brands][][name]	string	*	The brand name.
data.departments[][brands][][slug]	string	*
data.departments[][brands][][url]	string	*	The brand url.
data.departments[][brands][][theme_set]	object (ThemeSet)	*
data.departments[][brands][][theme_set][id]	integer	*
data.departments[][brands][][theme_set][theme_id]	string	*
data.departments[][brands][][theme_set][title]	string	*
data.departments[][brands][][theme_set][options]		*
data.departments[][brands][][edit_theme_set]	object (ThemeSet)	*
data.departments[][brands][][departments][]	array of objects (Department)	*
data.departments[][brands][][theme_sets][]	array of objects (ThemeSet)	*
data.departments[][permissions][]	array of objects (DepartmentPermission)	*
data.departments[][permissions][][department]	integer id (Department)	*
data.departments[][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.departments[][permissions][][name]	string	*	The name of the permission.
data.departments[][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.departments[][permissions][][is_active]	boolean	*
data.departments[][chat_queue]	object (UserChatQueue)	*
data.departments[][chat_queue][id]	integer	*	The unique ID.
data.departments[][chat_queue][name]	string	*
data.departments[][chat_queue][routing_model]	string	*
data.departments[][chat_queue][answer_timeout]	integer	*
data.departments[][chat_queue][is_all_agents]	boolean	*
data.departments[][chat_queue][departments][]	array of objects (Department)	*
data.departments[][chat_queue][max_queue_size]	integer	*
data.departments[][chat_queue][routingModel]		*
data.max_queue_size	integer	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/user_chat_queues/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chat_queues.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/user_chat_queues/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chat_queues.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/user_chat_queues/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chat_queues.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.name	string	*
data.routingModel		*
data.id	integer	*	The unique ID.
data.routing_model	string	*
data.answer_timeout	integer	*
data.is_all_agents	boolean	*
data.departments[]	array of objects (Department)	*
data.departments[][id]	integer	*
data.departments[][parent]	object (Department)	*
data.departments[][children][]	array of objects (Department)	*
data.departments[][title]	string	*
data.departments[][user_title]	string	*
data.departments[][is_tickets_enabled]	boolean	*
data.departments[][is_chat_enabled]	boolean	*
data.departments[][display_order]	integer	*
data.departments[][avatar]	object (Blob)	*
data.departments[][avatar][sys_name]	string	*	A unique system name for the blob.
data.departments[][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.departments[][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.departments[][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.departments[][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.departments[][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.departments[][avatar][file_url]	string	*	The HTTP link to download the file.
data.departments[][avatar][authcode]	string	*
data.departments[][avatar][blob_hash]	string	*
data.departments[][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.departments[][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.departments[][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.departments[][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.departments[][avatar][date_created]	DateTime	*
data.departments[][avatar][is_temp]	boolean	*
data.departments[][avatar][source_ref]	string	*
data.departments[][avatar][labels][]	array of objects (LabelBlob)	*
data.departments[][avatar][labels][][blob]	object (Blob)	*
data.departments[][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.departments[][brands][]	array of objects (Brand)	*
data.departments[][brands][][id]	integer	*	The unique ID.
data.departments[][brands][][name]	string	*	The brand name.
data.departments[][brands][][slug]	string	*
data.departments[][brands][][url]	string	*	The brand url.
data.departments[][brands][][theme_set]	object (ThemeSet)	*
data.departments[][brands][][theme_set][id]	integer	*
data.departments[][brands][][theme_set][theme_id]	string	*
data.departments[][brands][][theme_set][title]	string	*
data.departments[][brands][][theme_set][options]		*
data.departments[][brands][][edit_theme_set]	object (ThemeSet)	*
data.departments[][brands][][departments][]	array of objects (Department)	*
data.departments[][brands][][theme_sets][]	array of objects (ThemeSet)	*
data.departments[][permissions][]	array of objects (DepartmentPermission)	*
data.departments[][permissions][][department]	integer id (Department)	*
data.departments[][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.departments[][permissions][][name]	string	*	The name of the permission.
data.departments[][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.departments[][permissions][][is_active]	boolean	*
data.departments[][chat_queue]	object (UserChatQueue)	*
data.departments[][chat_queue][id]	integer	*	The unique ID.
data.departments[][chat_queue][name]	string	*
data.departments[][chat_queue][routing_model]	string	*
data.departments[][chat_queue][answer_timeout]	integer	*
data.departments[][chat_queue][is_all_agents]	boolean	*
data.departments[][chat_queue][departments][]	array of objects (Department)	*
data.departments[][chat_queue][max_queue_size]	integer	*
data.departments[][chat_queue][routingModel]		*
data.max_queue_size	integer	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/user_chat_queues/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chat_queues.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format
name	string	false
routing_model	choice	false	["round_robin","round_robin_optional","least_utilized","simulring"]
max_queue_size	integer	false
answer_timeout	integer	false
is_all_agents	boolean	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/user_chats CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chats.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

status

Description	status filter
Datatype	string
Pattern	open\|ended

date_created

Datatype	string
Pattern	Y-m-d:Y-m-d

date_period

Datatype	string
Pattern	today\|yesterday\|etc

person

Datatype	integer
Pattern	\d+

agent

Datatype	integer
Pattern	\d+

department

Datatype	integer
Pattern	\d+

brand

Datatype	integer
Pattern	\d+

label

Description	labels filter option
Datatype	array
Pattern	[\w+,]+

chat_field.{id}

Description	\n * Custom chat field filter. To filter by a custom field with ID=1 you need to add\n * ?chat_field.1=value to the query string
Datatype	string
Pattern	\d+\|\w

Parameter	Type	Versions	Description
data[]	array of objects (ChatConversation)	*
data[][department]	object (Department)	*	Department which chat was assigned.
data[][department][id]	integer	*
data[][department][parent]	object (Department)	*
data[][department][children][]	array of objects (Department)	*
data[][department][title]	string	*
data[][department][user_title]	string	*
data[][department][is_tickets_enabled]	boolean	*
data[][department][is_chat_enabled]	boolean	*
data[][department][display_order]	integer	*
data[][department][avatar]	object (Blob)	*
data[][department][avatar][sys_name]	string	*	A unique system name for the blob.
data[][department][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][department][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][department][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][department][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][department][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data[][department][avatar][file_url]	string	*	The HTTP link to download the file.
data[][department][avatar][authcode]	string	*
data[][department][avatar][blob_hash]	string	*
data[][department][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][department][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][department][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][department][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][department][avatar][date_created]	DateTime	*
data[][department][avatar][is_temp]	boolean	*
data[][department][avatar][source_ref]	string	*
data[][department][avatar][labels][]	array of objects (LabelBlob)	*
data[][department][avatar][labels][][blob]	object (Blob)	*
data[][department][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][department][brands][]	array of objects (Brand)	*
data[][department][brands][][id]	integer	*	The unique ID.
data[][department][brands][][name]	string	*	The brand name.
data[][department][brands][][slug]	string	*
data[][department][brands][][url]	string	*	The brand url.
data[][department][brands][][theme_set]	object (ThemeSet)	*
data[][department][brands][][theme_set][id]	integer	*
data[][department][brands][][theme_set][theme_id]	string	*
data[][department][brands][][theme_set][title]	string	*
data[][department][brands][][edit_theme_set]	object (ThemeSet)	*
data[][department][brands][][departments][]	array of objects (Department)	*
data[][department][brands][][theme_sets][]	array of objects (ThemeSet)	*
data[][department][permissions][]	array of objects (DepartmentPermission)	*
data[][department][permissions][][department]	integer id (Department)	*
data[][department][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][department][permissions][][name]	string	*	The name of the permission.
data[][department][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][department][permissions][][is_active]	boolean	*
data[][department][chat_queue]	object (UserChatQueue)	*
data[][department][chat_queue][id]	integer	*	The unique ID.
data[][department][chat_queue][name]	string	*
data[][department][chat_queue][routing_model]	string	*
data[][department][chat_queue][answer_timeout]	integer	*
data[][department][chat_queue][is_all_agents]	boolean	*
data[][department][chat_queue][departments][]	array of objects (Department)	*
data[][department][chat_queue][max_queue_size]	integer	*
data[][labels][]	array of objects (LabelChatConversation)	*
data[][labels][][chat]	object (ChatConversation)	*
data[][labels][][chat][id]	integer	*	The unique id of chat conversation.
data[][labels][][chat][department]	object (Department)	*	Department which chat was assigned.
data[][labels][][chat][brand]	object (Brand)	*	Department which chat was assigned.
data[][labels][][chat][task_id]	integer	*
data[][labels][][chat][ticket]	object (Ticket)	*
data[][labels][][chat][labels][]	array of objects (LabelChatConversation)	*
data[][labels][][chat][subject]	string	*	Subject of the chat conversation.
data[][labels][][chat][status]	string	*	Status of the chat conversation.
data[][labels][][chat][agent]	object (Person)	*	If this is a user conversation, this is the agent assigned.
data[][labels][][chat][agent_team]	object (AgentTeam)	*	If this is a team chat, the team it is.
data[][labels][][chat][agent_team][id]	integer	*	The unique ID.
data[][labels][][chat][agent_team][name]	string	*	The name of agent team.
data[][labels][][chat][agent_team][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][labels][][chat][person]	object (Person)	*	If this is a user conversation, this is the user who started the chat.
data[][labels][][chat][session]	object (Session)	*	If this is a user convo, this is the users session.
data[][labels][][chat][session][id]	integer	*	The unique ID.
data[][labels][][chat][session][auth]	string	*	The authcode for the session to verify an id.
data[][labels][][chat][session][interface]	string	*	The Interface the session is for.
data[][labels][][chat][session][person]	object (Person)	*
data[][labels][][chat][session][user_agent]	string	*	The users user agent string.
data[][labels][][chat][session][visitor_id]	string	*
data[][labels][][chat][session][ip_address]	string	*	The users IP address.
data[][labels][][chat][session][data]	string	*
data[][labels][][chat][session][is_person]	boolean	*
data[][labels][][chat][session][is_bot]	boolean	*
data[][labels][][chat][session][is_helpdesk]	boolean	*
data[][labels][][chat][session][active_status]	string	*	(Agents) Status (available or away).
data[][labels][][chat][session][is_chat_available]	boolean	*	(Agents) Wehn status is available, if they are available for chat.
data[][labels][][chat][session][date_created]	DateTime	*
data[][labels][][chat][session][date_last]	DateTime	*
data[][labels][][chat][session][date_last_page]	DateTime	*
data[][labels][][chat][visitor_id]	string	*
data[][labels][][chat][person_name]	string	*	User chat: The users name, if they arent a person.
data[][labels][][chat][person_email]	string	*	User chat: The users email, if they aren`t a person.
data[][labels][][chat][participants][]	array of objects (Person)	*
data[][labels][][chat][messages][]	array of objects (ChatMessage)	*
data[][labels][][chat][messages][][id]	integer	*	The unique ID.
data[][labels][][chat][messages][][author_id]	integer	*	Author id (legacy).
data[][labels][][chat][messages][][author_type]	string	*	Author type (legacy).
data[][labels][][chat][messages][][conversation_id]	integer	*	Conversation id (legacy).
data[][labels][][chat][messages][][author]	integer id (Person)	*	Person who created the message.
data[][labels][][chat][messages][][content]	string	*	The message.
data[][labels][][chat][messages][][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data[][labels][][chat][messages][][is_user]	boolean	*	Is this an user's message? (send from the widget).
data[][labels][][chat][messages][][is_html]	boolean	*	Is the content an HTML message?
data[][labels][][chat][messages][][metadata]	array	*	Additional data.
data[][labels][][chat][messages][][date_created]	DateTime	*	Date message was created.
data[][labels][][chat][messages][][date_received]	DateTime	*	Date message was received.
data[][labels][][chat][custom_data][]	array of objects (CustomDataChat)	*
data[][labels][][chat][custom_data][][conversation]	object (ChatConversation)	*	The conversation the message belongs to.
data[][labels][][chat][custom_data][][field]	object (CustomDefChat)	*
data[][labels][][chat][custom_data][][field][parent]	object (CustomDefChat)	*
data[][labels][][chat][custom_data][][field][children][]	array of objects (CustomDefChat)	*	Field children.
data[][labels][][chat][custom_data][][root_field]	object (CustomDefChat)	*
data[][labels][][chat][rating_response_time]	integer	*
data[][labels][][chat][rating_overall]	integer	*
data[][labels][][chat][rating_comment]	string	*
data[][labels][][chat][is_agent]	boolean	*	Is this an agent chat.
data[][labels][][chat][is_window]	boolean	*	If the chat is popped out into a window. This is used to make sure the JS widget on pages doesn't load again.
data[][labels][][chat][date_created]	DateTime	*	Date when chat was started.
data[][labels][][chat][date_user_waiting]	DateTime	*	Since when the user has started waiting (i.e., time the assignment was 0).
data[][labels][][chat][date_assigned]	DateTime	*
data[][labels][][chat][date_agent_typing]	DateTime	*	Date when agent typed last time.
data[][labels][][chat][date_first_agent_message]	DateTime	*
data[][labels][][chat][date_ended]	DateTime	*	Date when chat was ended.
data[][labels][][chat][total_to_ended]	integer	*
data[][labels][][chat][ended_by]	string	*	Who ended the chat.
data[][labels][][chat][should_send_transcript]	boolean	*	True if transcript should be send.
data[][labels][][chat][date_transcript_sent]	DateTime	*	Date when transcript was sent.
data[][labels][][chat][email_validation_code]	string	*
data[][labels][][chat][email_validated]	boolean	*
data[][labels][][chat][access_token]	string	*
data[][ended_by]	string	*	Who ended the chat.
data[][id]	integer	*	The unique id of chat conversation.
data[][brand]	object (Brand)	*	Department which chat was assigned.
data[][brand][id]	integer	*	The unique ID.
data[][brand][name]	string	*	The brand name.
data[][brand][slug]	string	*
data[][brand][url]	string	*	The brand url.
data[][brand][theme_set]	object (ThemeSet)	*
data[][brand][theme_set][id]	integer	*
data[][brand][theme_set][theme_id]	string	*
data[][brand][theme_set][title]	string	*
data[][brand][edit_theme_set]	object (ThemeSet)	*
data[][brand][departments][]	array of objects (Department)	*
data[][brand][theme_sets][]	array of objects (ThemeSet)	*
data[][task_id]	integer	*
data[][ticket]	object (Ticket)	*
data[][ticket][id]	integer	*
data[][ticket][ref]	string	*
data[][ticket][auth]	string	*
data[][ticket][parent_ticket]	object (Ticket)	*	Parent ticket.
data[][ticket][children_tickets][]	array of objects (Ticket)	*
data[][ticket][language]	object (Language)	*	The language the ticket is in.
data[][ticket][language][id]	integer	*	The unique ID.
data[][ticket][language][sys_name]	string	*	The unique sys name assigned to the language.
data[][ticket][language][title]	string	*	Title of the language.
data[][ticket][language][title_local]	string	*	Title of the language.
data[][ticket][language][base_filepath]	string	*	The base filepath for default phrases for this lang.
data[][ticket][language][locale]	string	*	The locale code.
data[][ticket][language][flag_image]	string	*	String path to image.
data[][ticket][language][is_rtl]	boolean	*	True if this is a right-to-left language.
data[][ticket][language][has_user]	boolean	*	True if has user.
data[][ticket][language][has_agent]	boolean	*	True if has agent.
data[][ticket][language][has_admin]	boolean	*	True if has admin.
data[][ticket][language][plural_categories][]	array of strings	*
data[][ticket][language][plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data[][ticket][language][flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`
data[][ticket][brand]	object (Brand)	*
data[][ticket][department]	object (Department)	*
data[][ticket][category]	object (TicketCategory)	*
data[][ticket][category][id]	integer	*	The unique ID.
data[][ticket][category][parent]	integer id (TicketCategory)	*	This category parent.
data[][ticket][category][title]	string	*	Category title.
data[][ticket][category][display_order]	integer	*	Obviously it's display order for lists.
data[][ticket][priority]	object (TicketPriority)	*
data[][ticket][priority][id]	integer	*	The unique ID.
data[][ticket][priority][title]	string	*	Priority title.
data[][ticket][priority][priority]	integer	*	The priority itself.
data[][ticket][workflow]	object (TicketWorkflow)	*
data[][ticket][workflow][id]	integer	*	The unique ID.
data[][ticket][workflow][title]	string	*	Workflow title.
data[][ticket][workflow][display_order]	integer	*	Workflow display order.
data[][ticket][product]	object (Product)	*
data[][ticket][product][parent]	integer id (Product)	*	Parent of the product.
data[][ticket][person]	object (Person)	*
data[][ticket][person_email]	object (PersonEmail)	*
data[][ticket][person_email][id]	integer	*	The unique ID.
data[][ticket][person_email][person]	integer id (Person)	*	Person owner of email.
data[][ticket][person_email][email]	string	*	The email address.
data[][ticket][person_email][email_domain]	string	*	The email address domain.
data[][ticket][person_email][is_validated]	boolean	*	True if validation passed.
data[][ticket][person_email][date_created]	DateTime	*	The original time the email was created.
data[][ticket][agent]	object (Person)	*
data[][ticket][agent_team]	object (AgentTeam)	*
data[][ticket][agent_team][id]	integer	*	The unique ID.
data[][ticket][agent_team][name]	string	*	The name of agent team.
data[][ticket][agent_team][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][ticket][organization]	object (Organization)	*
data[][ticket][organization][id]	integer	*	The unique ID.
data[][ticket][organization][picture_blob]	object (Blob)	*	The org picture.
data[][ticket][organization][picture_blob][sys_name]	string	*	A unique system name for the blob.
data[][ticket][organization][picture_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][ticket][organization][picture_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][ticket][organization][picture_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][ticket][organization][picture_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][ticket][organization][picture_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][ticket][organization][picture_blob][file_url]	string	*	The HTTP link to download the file.
data[][ticket][organization][picture_blob][authcode]	string	*
data[][ticket][organization][picture_blob][blob_hash]	string	*
data[][ticket][organization][picture_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][ticket][organization][picture_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][ticket][organization][picture_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][ticket][organization][picture_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][ticket][organization][picture_blob][date_created]	DateTime	*
data[][ticket][organization][picture_blob][is_temp]	boolean	*
data[][ticket][organization][picture_blob][source_ref]	string	*
data[][ticket][organization][picture_blob][labels][]	array of objects (LabelBlob)	*
data[][ticket][organization][picture_blob][labels][][blob]	object (Blob)	*
data[][ticket][organization][icon_property]	object (IconProperty)	*
data[][ticket][organization][icon_property][urn]	string	*
data[][ticket][organization][icon_property][options]	array	*
data[][ticket][organization][name]	string	*	The organization name.
data[][ticket][organization][summary]	string	*	The summary field as filled in by agents.
data[][ticket][organization][importance]	integer	*	The org importance.
data[][ticket][organization][custom_data][]	array of objects (CustomDataOrganization)	*
data[][ticket][organization][custom_data][][organization]	object (Organization)	*
data[][ticket][organization][custom_data][][field]	object (CustomDefOrganization)	*
data[][ticket][organization][custom_data][][field][parent]	object (CustomDefOrganization)	*	Field`s parent.
data[][ticket][organization][custom_data][][field][children][]	array of objects (CustomDefOrganization)	*	Field children.
data[][ticket][organization][custom_data][][root_field]	object (CustomDefOrganization)	*
data[][ticket][organization][usergroups][]	array of objects (Usergroup)	*	Usergroups the user belongs to.
data[][ticket][organization][usergroups][][id]	integer	*	The unique ID, DB-generated.
data[][ticket][organization][usergroups][][title]	string	*	Title of the usergroup.
data[][ticket][organization][usergroups][][note]	string	*	A note or description about the usergroup.
data[][ticket][organization][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data[][ticket][organization][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data[][ticket][organization][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data[][ticket][organization][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data[][ticket][organization][usergroups][][permissions][][id]	integer	*	The unique ID.
data[][ticket][organization][usergroups][][permissions][][name]	string	*	The name of the permission.
data[][ticket][organization][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][ticket][organization][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data[][ticket][organization][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data[][ticket][organization][usergroups][][department_permissions][][department]	integer id (Department)	*
data[][ticket][organization][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][ticket][organization][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data[][ticket][organization][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][ticket][organization][usergroups][][department_permissions][][is_active]	boolean	*
data[][ticket][organization][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data[][ticket][organization][auto_cc_people][]	array of objects (Person)	*	Users who are set to automatically be added to tickets and other org things.
data[][ticket][organization][labels][]	array of objects (LabelOrganization)	*
data[][ticket][organization][labels][][organization]	object (Organization)	*
data[][ticket][organization][contact_data][]	array of objects (OrganizationContactData)	*
data[][ticket][organization][emails][]	array of objects (OrganizationEmail)	*
data[][ticket][organization][emails][][id]	integer	*	The unique log id.
data[][ticket][organization][emails][][organization]	object (Organization)	*
data[][ticket][organization][emails][][email]	string	*
data[][ticket][organization][emails][][date_created]	DateTime	*
data[][ticket][organization][email_domains][]	array of objects (OrganizationEmailDomain)	*
data[][ticket][organization][email_domains][][domain]	string	*	The email domain.
data[][ticket][organization][email_domains][][organization]	object (Organization)	*	The users organization.
data[][ticket][organization][date_created]	DateTime	*	The date the org was inserted into the system.
data[][ticket][organization][members][]	array of objects (Person)	*
data[][ticket][organization][parent]	object (Organization)	*
data[][ticket][organization][children][]	array of objects (Organization)	*
data[][ticket][organization][tickets][]	array of objects (Ticket)	*
data[][ticket][organization][organization_members][]	array of objects (OrganizationMember)	*
data[][ticket][organization][organization_members][][id]	integer	*
data[][ticket][organization][organization_members][][person]	integer id (Person)	*
data[][ticket][organization][organization_members][][organization]	integer id (Organization)	*
data[][ticket][organization][organization_members][][is_manager]	boolean	*
data[][ticket][organization][organization_members][][position]	string	*
data[][ticket][organization][organization_members][][created_at]	DateTime	*
data[][ticket][organization][organization_members][][updated_at]	DateTime	*
data[][ticket][linked_chat]	object (ChatConversation)	*
data[][ticket][linked_chat][id]	integer	*	The unique id of chat conversation.
data[][ticket][linked_chat][department]	object (Department)	*	Department which chat was assigned.
data[][ticket][linked_chat][brand]	object (Brand)	*	Department which chat was assigned.
data[][ticket][linked_chat][task_id]	integer	*
data[][ticket][linked_chat][ticket]	object (Ticket)	*
data[][ticket][linked_chat][labels][]	array of objects (LabelChatConversation)	*
data[][ticket][linked_chat][labels][][chat]	object (ChatConversation)	*
data[][ticket][linked_chat][subject]	string	*	Subject of the chat conversation.
data[][ticket][linked_chat][status]	string	*	Status of the chat conversation.
data[][ticket][linked_chat][agent]	object (Person)	*	If this is a user conversation, this is the agent assigned.
data[][ticket][linked_chat][agent_team]	object (AgentTeam)	*	If this is a team chat, the team it is.
data[][ticket][linked_chat][person]	object (Person)	*	If this is a user conversation, this is the user who started the chat.
data[][ticket][linked_chat][session]	object (Session)	*	If this is a user convo, this is the users session.
data[][ticket][linked_chat][session][id]	integer	*	The unique ID.
data[][ticket][linked_chat][session][auth]	string	*	The authcode for the session to verify an id.
data[][ticket][linked_chat][session][interface]	string	*	The Interface the session is for.
data[][ticket][linked_chat][session][person]	object (Person)	*
data[][ticket][linked_chat][session][user_agent]	string	*	The users user agent string.
data[][ticket][linked_chat][session][visitor_id]	string	*
data[][ticket][linked_chat][session][ip_address]	string	*	The users IP address.
data[][ticket][linked_chat][session][data]	string	*
data[][ticket][linked_chat][session][is_person]	boolean	*
data[][ticket][linked_chat][session][is_bot]	boolean	*
data[][ticket][linked_chat][session][is_helpdesk]	boolean	*
data[][ticket][linked_chat][session][active_status]	string	*	(Agents) Status (available or away).
data[][ticket][linked_chat][session][is_chat_available]	boolean	*	(Agents) Wehn status is available, if they are available for chat.
data[][ticket][linked_chat][session][date_created]	DateTime	*
data[][ticket][linked_chat][session][date_last]	DateTime	*
data[][ticket][linked_chat][session][date_last_page]	DateTime	*
data[][ticket][linked_chat][visitor_id]	string	*
data[][ticket][linked_chat][person_name]	string	*	User chat: The users name, if they arent a person.
data[][ticket][linked_chat][person_email]	string	*	User chat: The users email, if they aren`t a person.
data[][ticket][linked_chat][participants][]	array of objects (Person)	*
data[][ticket][linked_chat][messages][]	array of objects (ChatMessage)	*
data[][ticket][linked_chat][messages][][id]	integer	*	The unique ID.
data[][ticket][linked_chat][messages][][author_id]	integer	*	Author id (legacy).
data[][ticket][linked_chat][messages][][author_type]	string	*	Author type (legacy).
data[][ticket][linked_chat][messages][][conversation_id]	integer	*	Conversation id (legacy).
data[][ticket][linked_chat][messages][][author]	integer id (Person)	*	Person who created the message.
data[][ticket][linked_chat][messages][][content]	string	*	The message.
data[][ticket][linked_chat][messages][][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data[][ticket][linked_chat][messages][][is_user]	boolean	*	Is this an user's message? (send from the widget).
data[][ticket][linked_chat][messages][][is_html]	boolean	*	Is the content an HTML message?
data[][ticket][linked_chat][messages][][metadata]	array	*	Additional data.
data[][ticket][linked_chat][messages][][date_created]	DateTime	*	Date message was created.
data[][ticket][linked_chat][messages][][date_received]	DateTime	*	Date message was received.
data[][ticket][linked_chat][custom_data][]	array of objects (CustomDataChat)	*
data[][ticket][linked_chat][custom_data][][conversation]	object (ChatConversation)	*	The conversation the message belongs to.
data[][ticket][linked_chat][custom_data][][field]	object (CustomDefChat)	*
data[][ticket][linked_chat][custom_data][][field][parent]	object (CustomDefChat)	*
data[][ticket][linked_chat][custom_data][][field][children][]	array of objects (CustomDefChat)	*	Field children.
data[][ticket][linked_chat][custom_data][][root_field]	object (CustomDefChat)	*
data[][ticket][linked_chat][rating_response_time]	integer	*
data[][ticket][linked_chat][rating_overall]	integer	*
data[][ticket][linked_chat][rating_comment]	string	*
data[][ticket][linked_chat][is_agent]	boolean	*	Is this an agent chat.
data[][ticket][linked_chat][is_window]	boolean	*	If the chat is popped out into a window. This is used to make sure the JS widget on pages doesn't load again.
data[][ticket][linked_chat][date_created]	DateTime	*	Date when chat was started.
data[][ticket][linked_chat][date_user_waiting]	DateTime	*	Since when the user has started waiting (i.e., time the assignment was 0).
data[][ticket][linked_chat][date_assigned]	DateTime	*
data[][ticket][linked_chat][date_agent_typing]	DateTime	*	Date when agent typed last time.
data[][ticket][linked_chat][date_first_agent_message]	DateTime	*
data[][ticket][linked_chat][date_ended]	DateTime	*	Date when chat was ended.
data[][ticket][linked_chat][total_to_ended]	integer	*
data[][ticket][linked_chat][ended_by]	string	*	Who ended the chat.
data[][ticket][linked_chat][should_send_transcript]	boolean	*	True if transcript should be send.
data[][ticket][linked_chat][date_transcript_sent]	DateTime	*	Date when transcript was sent.
data[][ticket][linked_chat][email_validation_code]	string	*
data[][ticket][linked_chat][email_validated]	boolean	*
data[][ticket][linked_chat][access_token]	string	*
data[][ticket][attachments][]	array of objects (TicketAttachment)	*
data[][ticket][attachments][][id]	integer	*	The unique ID.
data[][ticket][attachments][][ticket]	integer id (Ticket)	*	Ticket this attachment belongs to.
data[][ticket][attachments][][person]	integer id (Person)	*	Who created the attachment.
data[][ticket][attachments][][blob]	object (Blob)	*	Actual attachment.
data[][ticket][attachments][][blob][sys_name]	string	*	A unique system name for the blob.
data[][ticket][attachments][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][ticket][attachments][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][ticket][attachments][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][ticket][attachments][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][ticket][attachments][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][ticket][attachments][][blob][file_url]	string	*	The HTTP link to download the file.
data[][ticket][attachments][][blob][authcode]	string	*
data[][ticket][attachments][][blob][blob_hash]	string	*
data[][ticket][attachments][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][ticket][attachments][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][ticket][attachments][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][ticket][attachments][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][ticket][attachments][][blob][date_created]	DateTime	*
data[][ticket][attachments][][blob][is_temp]	boolean	*
data[][ticket][attachments][][blob][source_ref]	string	*
data[][ticket][attachments][][blob][labels][]	array of objects (LabelBlob)	*
data[][ticket][attachments][][blob][labels][][blob]	object (Blob)	*
data[][ticket][attachments][][message]	integer id (TicketMessage)	*	Message - holder of this attachment.
data[][ticket][attachments][][is_agent_note]	boolean	*	True if this attachmen just a note.
data[][ticket][attachments][][is_inline]	boolean	*	Is this attachment is embed in message.
data[][ticket][access_codes][]	array of objects (TicketAccessCode)	*
data[][ticket][access_codes][][id]	integer	*
data[][ticket][access_codes][][ticket]	object (Ticket)	*
data[][ticket][access_codes][][person]	object (Person)	*
data[][ticket][access_codes][][auth]	string	*
data[][ticket][messages][]	array of objects (TicketMessage)	*
data[][ticket][messages][][id]	integer	*	The unique id of message.
data[][ticket][messages][][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data[][ticket][messages][][person]	object (Person)	*	Person this message was sent by.
data[][ticket][messages][][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data[][ticket][messages][][email_source][id]	integer	*
data[][ticket][messages][][email_source][uuid]	string	*
data[][ticket][messages][][email_source][blob]	object (Blob)	*
data[][ticket][messages][][email_source][blob][sys_name]	string	*	A unique system name for the blob.
data[][ticket][messages][][email_source][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][ticket][messages][][email_source][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][ticket][messages][][email_source][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][ticket][messages][][email_source][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][ticket][messages][][email_source][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][ticket][messages][][email_source][blob][file_url]	string	*	The HTTP link to download the file.
data[][ticket][messages][][email_source][blob][authcode]	string	*
data[][ticket][messages][][email_source][blob][blob_hash]	string	*
data[][ticket][messages][][email_source][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][ticket][messages][][email_source][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][ticket][messages][][email_source][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][ticket][messages][][email_source][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][ticket][messages][][email_source][blob][date_created]	DateTime	*
data[][ticket][messages][][email_source][blob][is_temp]	boolean	*
data[][ticket][messages][][email_source][blob][source_ref]	string	*
data[][ticket][messages][][email_source][blob][labels][]	array of objects (LabelBlob)	*
data[][ticket][messages][][email_source][blob][labels][][blob]	object (Blob)	*
data[][ticket][messages][][email_source][object_type]	string	*	The type of object this is attached to (should be the table name of the super type, eg: tickets, people, organizations). This typically is not set until after the email is processed (ie the status is 'processed').
data[][ticket][messages][][email_source][object_id]	integer	*	The ID of the object this is attached to.
data[][ticket][messages][][email_source][from_email]	string	*
data[][ticket][messages][][email_source][status]	string	*	The current status of the message: - inserted: Only inserted - processing: Currently processing - complete: Fully processed - error: Tried to process but there was some kind of error (see error_code).
data[][ticket][messages][][email_source][date_status]	DateTime	*
data[][ticket][messages][][email_source][error_code]	string	*	When status is error, this is the code that describes the error.
data[][ticket][messages][][email_source][date_created]	DateTime	*
data[][ticket][messages][][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data[][ticket][messages][][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data[][ticket][messages][][snippet_use_logs][][id]	integer	*	The unique ID.
data[][ticket][messages][][snippet_use_logs][][snippet]	object (SnippetV2)	*	Snippet used.
data[][ticket][messages][][snippet_use_logs][][snippet][id]	integer	*
data[][ticket][messages][][snippet_use_logs][][snippet][title]	string	*
data[][ticket][messages][][snippet_use_logs][][snippet][author]	object (Person)	*
data[][ticket][messages][][snippet_use_logs][][snippet][is_private]	boolean	*
data[][ticket][messages][][snippet_use_logs][][snippet][avatar]	object (Blob)	*
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][sys_name]	string	*	A unique system name for the blob.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][file_url]	string	*	The HTTP link to download the file.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][authcode]	string	*
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][blob_hash]	string	*
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][date_created]	DateTime	*
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][is_temp]	boolean	*
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][source_ref]	string	*
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][labels][]	array of objects (LabelBlob)	*
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][labels][][blob]	object (Blob)	*
data[][ticket][messages][][snippet_use_logs][][snippet][status]	string	*
data[][ticket][messages][][snippet_use_logs][][snippet][shortcut_codes]	array	*
data[][ticket][messages][][snippet_use_logs][][snippet][inline_translations]	array	*
data[][ticket][messages][][snippet_use_logs][][snippet][translations][]	array of objects (SnippetV2Translation)	*
data[][ticket][messages][][snippet_use_logs][][snippet][translations][][id]	integer	*	The unique ID.
data[][ticket][messages][][snippet_use_logs][][snippet][translations][][snippet]	object (SnippetV2)	*	Snippet translated.
data[][ticket][messages][][snippet_use_logs][][snippet][translations][][language]	object (Language)	*
data[][ticket][messages][][snippet_use_logs][][snippet][translations][][content]	array	*	Snippet content.
data[][ticket][messages][][snippet_use_logs][][snippet][translations][][blobs][]	array of objects (Blob)	*
data[][ticket][messages][][snippet_use_logs][][snippet][categories][]	array of objects (SnippetV2Category)	*
data[][ticket][messages][][snippet_use_logs][][snippet][categories][][id]	integer	*
data[][ticket][messages][][snippet_use_logs][][snippet][categories][][title]	string	*
data[][ticket][messages][][snippet_use_logs][][snippet][categories][][is_global]	boolean	*
data[][ticket][messages][][snippet_use_logs][][snippet][categories][][display_order]	integer	*
data[][ticket][messages][][snippet_use_logs][][snippet][categories][][parent]	object (SnippetV2Category)	*
data[][ticket][messages][][snippet_use_logs][][snippet][categories][][agent_teams][]	array of objects (AgentTeam)	*
data[][ticket][messages][][snippet_use_logs][][snippet][display_order]	integer	*
data[][ticket][messages][][snippet_use_logs][][snippet][date_created]	DateTime	*
data[][ticket][messages][][snippet_use_logs][][ticket_message]	object (TicketMessage)	*	Ticket Message where the snippet was used.
data[][ticket][messages][][snippet_use_logs][][chat_message]	object (ChatMessage)	*	Chat Message where the snippet was used.
data[][ticket][messages][][snippet_use_logs][][chat_message][id]	integer	*	The unique ID.
data[][ticket][messages][][snippet_use_logs][][chat_message][author_id]	integer	*	Author id (legacy).
data[][ticket][messages][][snippet_use_logs][][chat_message][author_type]	string	*	Author type (legacy).
data[][ticket][messages][][snippet_use_logs][][chat_message][conversation_id]	integer	*	Conversation id (legacy).
data[][ticket][messages][][snippet_use_logs][][chat_message][author]	integer id (Person)	*	Person who created the message.
data[][ticket][messages][][snippet_use_logs][][chat_message][content]	string	*	The message.
data[][ticket][messages][][snippet_use_logs][][chat_message][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data[][ticket][messages][][snippet_use_logs][][chat_message][is_user]	boolean	*	Is this an user's message? (send from the widget).
data[][ticket][messages][][snippet_use_logs][][chat_message][is_html]	boolean	*	Is the content an HTML message?
data[][ticket][messages][][snippet_use_logs][][chat_message][metadata]	array	*	Additional data.
data[][ticket][messages][][snippet_use_logs][][chat_message][date_created]	DateTime	*	Date message was created.
data[][ticket][messages][][snippet_use_logs][][chat_message][date_received]	DateTime	*	Date message was received.
data[][ticket][messages][][snippet_use_logs][][language]	object (Language)	*	Snippet translated.
data[][ticket][messages][][snippet_use_logs][][person]	object (Person)	*
data[][ticket][messages][][snippet_use_logs][][rating]	integer	*
data[][ticket][messages][][snippet_use_logs][][rating_person]	object (Person)	*
data[][ticket][messages][][snippet_use_logs][][rating_message]	string	*
data[][ticket][messages][][snippet_use_logs][][date_created]	DateTime	*
data[][ticket][messages][][date_created]	DateTime	*	Date when message was created.
data[][ticket][messages][][is_agent_note]	boolean	*	Is this message agent note?
data[][ticket][messages][][is_hidden]	boolean	*	Is this message hidden?
data[][ticket][messages][][creation_system]	string	*	How this message was created.
data[][ticket][messages][][ip_address]	string	*	An ip address from which message was sent.
data[][ticket][messages][][visitor_id]	string	*	Unique ID of visitor left this message.
data[][ticket][messages][][hostname]	string	*	Host from which message was left.
data[][ticket][messages][][geo_country]	string	*	Country message is from (deprecated).
data[][ticket][messages][][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data[][ticket][messages][][message_hash]	string	*	An unique hash of message.
data[][ticket][messages][][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data[][ticket][messages][][primary_translation][id]	integer	*
data[][ticket][messages][][primary_translation][ticket]	object (Ticket)	*
data[][ticket][messages][][primary_translation][ticket_message]	object (TicketMessage)	*
data[][ticket][messages][][primary_translation][from_lang_code]	string	*
data[][ticket][messages][][primary_translation][lang_code]	string	*
data[][ticket][messages][][primary_translation][message]	string	*
data[][ticket][messages][][primary_translation][date_created]	DateTime	*
data[][ticket][messages][][message]	string	*	The message, will be in HTML!
data[][ticket][messages][][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data[][ticket][messages][][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data[][ticket][messages][][message_source]	string	*	The message source.
data[][ticket][messages][][message_source_type]	string	*	The message source type.
data[][ticket][messages][][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data[][ticket][messages][][lang_code]	string	*	The set/detected lang code.
data[][ticket][messages][][email_message_id][]	array of objects (TicketMessageEmailId)	*
data[][ticket][messages][][email_message_id][][id]	integer	*
data[][ticket][messages][][email_message_id][][message]	object (TicketMessage)	*
data[][ticket][messages][][email_message_id][][email_id]	string	*
data[][ticket][messages][][ticket_feedback][]	array of objects (TicketFeedback)	*
data[][ticket][messages][][ticket_feedback][][id]	integer	*
data[][ticket][messages][][ticket_feedback][][ticket]	object (Ticket)	*
data[][ticket][messages][][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data[][ticket][messages][][ticket_feedback][][person]	object (Person)	*
data[][ticket][messages][][ticket_feedback][][rating]	integer	*
data[][ticket][messages][][ticket_feedback][][message]	string	*
data[][ticket][messages][][ticket_feedback][][date_created]	DateTime	*
data[][ticket][messages][][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data[][ticket][messages][][ticket_message_forwards][][id]	integer	*
data[][ticket][messages][][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data[][ticket][messages][][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data[][ticket][messages][][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data[][ticket][messages][][ticket_message_forwards][][subject]	string	*
data[][ticket][messages][][ticket_message_forwards][][from_email]	string	*
data[][ticket][messages][][ticket_message_forwards][][tos]	array	*
data[][ticket][messages][][ticket_message_forwards][][ccs]	array	*
data[][ticket][messages][][ticket_message_forwards][][bccs]	array	*
data[][ticket][messages][][ticket_message_forwards][][message]	string	*
data[][ticket][messages][][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data[][ticket][messages][][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data[][ticket][messages][][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][ticket][messages][][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][ticket][messages][][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][ticket][messages][][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][ticket][messages][][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data[][ticket][messages][][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data[][ticket][messages][][ticket_message_forwards][][blobs][][authcode]	string	*
data[][ticket][messages][][ticket_message_forwards][][blobs][][blob_hash]	string	*
data[][ticket][messages][][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][ticket][messages][][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][ticket][messages][][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][ticket][messages][][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][ticket][messages][][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data[][ticket][messages][][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data[][ticket][messages][][ticket_message_forwards][][blobs][][source_ref]	string	*
data[][ticket][messages][][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data[][ticket][messages][][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data[][ticket][messages][][ticket_message_forwards][][date_created]	DateTime	*
data[][ticket][messages][][channel_message]	object (TicketMessageChannelMessage)	*
data[][ticket][messages][][channel_message][id]	integer	*	@var int The unique id of message.
data[][ticket][messages][][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data[][ticket][messages][][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data[][ticket][messages][][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data[][ticket][messages][][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data[][ticket][messages][][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data[][ticket][messages][][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data[][ticket][messages][][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data[][ticket][messages][][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data[][ticket][messages][][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data[][ticket][sms_messages][]	array of objects (TicketSms)	*
data[][ticket][sms_messages][][id]	integer	*
data[][ticket][sms_messages][][ticket]	object (Ticket)	*
data[][ticket][sms_messages][][person]	object (Person)	*
data[][ticket][sms_messages][][sms_account]	object (SmsAccount)	*
data[][ticket][sms_messages][][sms_account][id]	integer	*	The unique ID.
data[][ticket][sms_messages][][sms_account][type]	string	*
data[][ticket][sms_messages][][sms_account][params]	array	*
data[][ticket][sms_messages][][sms_account][identifier]	string	*
data[][ticket][sms_messages][][sms_account][is_enabled]	boolean	*
data[][ticket][sms_messages][][sms_account][is_connected]	boolean	*
data[][ticket][sms_messages][][sms_account][is_tested]	boolean	*
data[][ticket][sms_messages][][sms_account][test_code]	string	*
data[][ticket][sms_messages][][job]	object (Job)	*
data[][ticket][sms_messages][][job][id]	integer	*	The unique job id.
data[][ticket][sms_messages][][job][type]	string	*	The job type, used by the Job Router to find the right Job Processor.
data[][ticket][sms_messages][][job][status]	string	*	The status of the job.
data[][ticket][sms_messages][][job][status_code]	string	*	Any code to further classify the status.
data[][ticket][sms_messages][][job][date_touch]	DateTime	*	Date the last time a process "touched" this ticket.
data[][ticket][sms_messages][][job][date_created]	DateTime	*	Date this job entered the "jobs" table.
data[][ticket][sms_messages][][job][date_last_try]	DateTime	*	Last time we processed this job.
data[][ticket][sms_messages][][job][date_next_try]	DateTime	*	If this DateTime is in the future, it won't be selected for execution.
data[][ticket][sms_messages][][job][num_tries]	integer	*	The number of times this job has been executed Job Processor (usually indicated failures if > 1).
data[][ticket][sms_messages][][job][log_summary]	string	*	A human readable summary of the job's execution.
data[][ticket][sms_messages][][job][log]	string	*	A more verbose log.
data[][ticket][sms_messages][][job][data]	array	*	An array of data, or payload, that the job processor needs to execute this job (stored in the db as json). This MUST always be an array, even if its an empty array
data[][ticket][sms_messages][][job][original_job]	integer	*	Null unless the job was created as a retry - if so, the originating job ID is stored here so we can query it later. Note: You MUST specify the originating job, do not create a linked list of failed jobs.
data[][ticket][sms_messages][][date_created]	DateTime	*
data[][ticket][sms_messages][][from_number]	string	*	Permanent record of the phone number that sent this SMS. (Won't change even if Person changes their phone number).
data[][ticket][sms_messages][][to_number]	string	*	Permanent record of the phone number that this SMS was sent to.
data[][ticket][sms_messages][][message]	string	*	The SMS message.
data[][ticket][sms_messages][][direction]	string	*	Just a system flag for reporting.
data[][ticket][topic_links][]	array of objects (TicketCommunityTopicLink)	*
data[][ticket][topic_links][][id]	integer	*	The unique filter ID.
data[][ticket][topic_links][][ticket]	integer id (Ticket)	*
data[][ticket][topic_links][][topic]	integer id (CommunityTopic)	*
data[][ticket][topic_links][][person]	integer id (Person)	*
data[][ticket][topic_links][][date_created]	DateTime	*
data[][ticket][custom_data][]	array of objects (CustomDataTicket)	*
data[][ticket][custom_data][][ticket]	object (Ticket)	*
data[][ticket][custom_data][][field]	object (CustomDefTicket)	*
data[][ticket][custom_data][][field][parent]	object (CustomDefTicket)	*
data[][ticket][custom_data][][field][children][]	array of objects (CustomDefTicket)	*	Field children.
data[][ticket][custom_data][][root_field]	object (CustomDefTicket)	*
data[][ticket][labels][]	array of objects (LabelTicket)	*
data[][ticket][labels][][ticket]	object (Ticket)	*
data[][ticket][sent_to_address]	string	*	The email address the ticket was sent to if it came in via a gateway. This is a full string (e.g., including CC's) of the original.
data[][ticket][email_account]	object (EmailAccount)	*	The gateway this ticket originated from.
data[][ticket][email_account][id]	integer	*
data[][ticket][email_account][account_type]	string	*
data[][ticket][email_account][is_enabled]	boolean	*
data[][ticket][email_account][address]	string	*
data[][ticket][email_account][cert_blob]	object (Blob)	*
data[][ticket][email_account][cert_blob][sys_name]	string	*	A unique system name for the blob.
data[][ticket][email_account][cert_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][ticket][email_account][cert_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][ticket][email_account][cert_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][ticket][email_account][cert_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][ticket][email_account][cert_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][ticket][email_account][cert_blob][file_url]	string	*	The HTTP link to download the file.
data[][ticket][email_account][cert_blob][authcode]	string	*
data[][ticket][email_account][cert_blob][blob_hash]	string	*
data[][ticket][email_account][cert_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][ticket][email_account][cert_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][ticket][email_account][cert_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][ticket][email_account][cert_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][ticket][email_account][cert_blob][date_created]	DateTime	*
data[][ticket][email_account][cert_blob][is_temp]	boolean	*
data[][ticket][email_account][cert_blob][source_ref]	string	*
data[][ticket][email_account][cert_blob][labels][]	array of objects (LabelBlob)	*
data[][ticket][email_account][cert_blob][labels][][blob]	object (Blob)	*
data[][ticket][email_account][key_blob]	object (Blob)	*
data[][ticket][email_account_address]	string	*	The email address (from list of to/cc) that matched with the email account.
data[][ticket][creation_system]	string	*
data[][ticket][creation_system_option]	string	*	Optional information about the creation system. For example, source URL the ticket came from.
data[][ticket][ticket_hash]	string	*
data[][ticket][status]	string	*
data[][ticket][ticket_status]	object (TicketStatus)	*
data[][ticket][ticket_status][id]	integer	*
data[][ticket][ticket_status][status_type]	string	*
data[][ticket][ticket_status][status_code]	string	*
data[][ticket][ticket_status][sys_id]	string	*
data[][ticket][ticket_status][title]	string	*
data[][ticket][ticket_status][display_order]	integer	*
data[][ticket][ticket_status][pending_waiting_time_mode]	string	*	Where to count time spending in pending status. Check PENDING_WAITING_TIME_MODE_ constants
data[][ticket][ticket_status][children][]	array of objects (TicketStatus)	*
data[][ticket][ticket_status][options]	array	*
data[][ticket][urgency]	integer	*
data[][ticket][feedback_rating]	integer	*
data[][ticket][date_feedback_rating]	DateTime	*
data[][ticket][date_created]	DateTime	*
data[][ticket][date_resolved]	DateTime	*
data[][ticket][date_archived]	DateTime	*
data[][ticket][date_first_agent_assign]	DateTime	*
data[][ticket][date_first_agent_reply]	DateTime	*
data[][ticket][date_last_agent_reply]	DateTime	*
data[][ticket][date_last_user_reply]	DateTime	*
data[][ticket][date_agent_waiting]	DateTime	*
data[][ticket][date_user_waiting]	DateTime	*
data[][ticket][date_status]	DateTime	*
data[][ticket][date_on_hold]	DateTime	*
data[][ticket][total_user_waiting]	integer	*
data[][ticket][total_to_first_reply]	integer	*
data[][ticket][total_user_waiting_wh_start]	DateTime	*
data[][ticket][total_user_waiting_wh]	integer	*
data[][ticket][total_to_first_reply_wh]	integer	*
data[][ticket][locked_by_agent]	object (Person)	*
data[][ticket][date_locked]	DateTime	*
data[][ticket][has_attachments]	boolean	*
data[][ticket][subject]	string	*
data[][ticket][original_subject]	string	*
data[][ticket][properties]	array	*
data[][ticket][count_agent_replies]	integer	*
data[][ticket][count_user_replies]	integer	*
data[][ticket][worst_sla_status]	string	*
data[][ticket][waiting_times]	array	*	Used to track ticket status changes and how much time ticket was in status Add new item every time status changed This is optimisation over TicketLog.
data[][ticket][participants][]	array of objects (TicketParticipant)	*
data[][ticket][participants][][id]	integer	*
data[][ticket][participants][][ticket]	object (Ticket)	*
data[][ticket][participants][][person]	object (Person)	*
data[][ticket][participants][][access_code]	object (TicketAccessCode)	*
data[][ticket][participants][][person_email]	object (PersonEmail)	*
data[][ticket][participants][][default_on]	boolean	*	Default checkbox status of the user.
data[][ticket][charges][]	array of objects (TicketCharge)	*
data[][ticket][charges][][id]	integer	*
data[][ticket][charges][][charge_time]	integer	*
data[][ticket][charges][][amount]	float	*
data[][ticket][charges][][date_created]	DateTime	*
data[][ticket][charges][][ticket]	object (Ticket)	*
data[][ticket][charges][][person]	object (Person)	*
data[][ticket][charges][][organization]	object (Organization)	*
data[][ticket][charges][][agent]	object (Person)	*
data[][ticket][charges][][custom_data][]	array of objects (CustomDataBilling)	*
data[][ticket][charges][][custom_data][][ticket_charge]	object (TicketCharge)	*
data[][ticket][charges][][custom_data][][field]	object (CustomDefBilling)	*
data[][ticket][charges][][custom_data][][field][parent]	object (CustomDefBilling)	*
data[][ticket][charges][][custom_data][][field][children][]	array of objects (CustomDefBilling)	*	Field children.
data[][ticket][charges][][custom_data][][root_field]	object (CustomDefBilling)	*
data[][ticket][ticket_slas][]	array of objects (TicketSla)	*
data[][ticket][ticket_slas][][id]	integer	*	The unique ID.
data[][ticket][ticket_slas][][sla_status]	string	*	The SLA status.
data[][ticket][ticket_slas][][warn_date]	DateTime	*	The SLA warn date.
data[][ticket][ticket_slas][][fail_date]	DateTime	*	The SLA fail date.
data[][ticket][ticket_slas][][is_completed]	boolean	*	Is the SLA completed?
data[][ticket][ticket_slas][][is_completed_set]	boolean	*	Completed by automated action.
data[][ticket][ticket_slas][][completed_time_taken]	integer	*	Time taken.
data[][ticket][ticket_slas][][ticket]	integer id (Ticket)	*	Ticket.
data[][ticket][ticket_slas][][sla]	integer id (Sla)	*	SLA.
data[][ticket][ticket_slas][][date_applied]	DateTime	*	time and date when SLA was applied to the ticket.
data[][ticket][ticket_slas][][date_completed]	DateTime	*	time when SLA status became OK.
data[][ticket][jira_issues][]	array of objects (JiraIssue)	*	linked jira issues.
data[][ticket][jira_issues][][id]	integer	*	The unique ID.
data[][ticket][jira_issues][][ticket]	object (Ticket)	*	The associated DeskPRO ticket.
data[][ticket][jira_issues][][issue_id]	integer	*
data[][ticket][jira_issues][][status_id]	integer	*
data[][ticket][jira_issues][][created]	DateTime	*	Export time.
data[][ticket][problems][]	array of objects (Problem)	*
data[][ticket][problems][][id]	integer	*	The unique ID.
data[][ticket][problems][][title]	string	*	Problem title.
data[][ticket][problems][][creator]	integer id (Person)	*	Person who created the problem.
data[][ticket][problems][][created]	DateTime	*	Date when the problem was created.
data[][ticket][problems][][is_open]	boolean	*	Is problem still has no solution?
data[][ticket][problems][][tickets][]	array of integer ids (Ticket)	*	Tickets associated with problem.
data[][ticket][stars][]	array of objects (TicketFlagged)	*
data[][ticket][stars][][ticket]	object (Ticket)	*
data[][ticket][stars][][person_id]	integer	*
data[][ticket][stars][][color]	string	*
data[][ticket][follow_ups][]	array of objects (TicketFollowUp)	*
data[][ticket][follow_ups][][id]	integer	*	The unique ID.
data[][ticket][follow_ups][][person]	integer id (Person)	*
data[][ticket][follow_ups][][actions]	array	*
data[][ticket][follow_ups][][cancel_if_user_reply]	boolean	*
data[][ticket][follow_ups][][cancel_if_agent_reply]	boolean	*
data[][ticket][follow_ups][][status]	string	*
data[][ticket][follow_ups][][date_created]	DateTime	*
data[][ticket][follow_ups][][date_to_run]	DateTime	*
data[][ticket][follow_ups][][date_did_run]	DateTime	*
data[][ticket][logs][]	array of objects (TicketLog)	*
data[][ticket][logs][][id]	integer	*
data[][ticket][logs][][parent]	object (TicketLog)	*
data[][ticket][logs][][ticket]	object (Ticket)	*
data[][ticket][logs][][person]	object (Person)	*
data[][ticket][logs][][action_type]	string	*
data[][ticket][logs][][id_object]	integer	*	If the log involves a specific thing in a ticket (eg a message that was moved), then that is this id.
data[][ticket][logs][][id_before]	integer	*	The ID of the previous entity changed, or any other numeric value.
data[][ticket][logs][][id_after]	integer	*	The ID of the new entity, or any other numeric value.
data[][ticket][logs][][trigger_id]	integer	*	If the change was caused by a trigger, the trigger id. Note this is the integer ID (not a FK relation) so the record is kept even if the trigger itself is deleted.
data[][ticket][logs][][escalation_id]	integer	*	If the change was caused by an escalation Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data[][ticket][logs][][macro_id]	integer	*	If the change was caused by an v2 macro Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data[][ticket][logs][][sla]	object (Sla)	*	If the change was caused by an SLA, the SLA.
data[][ticket][logs][][sla][id]	integer	*	The unique ID.
data[][ticket][logs][][sla][title]	string	*	SLA title.
data[][ticket][logs][][sla][sla_type]	string	*	Type of SLA - first_response, resolution, waiting_time.
data[][ticket][logs][][sla][active_time]	string	*	Whether active all the time (all) or during work hours only (work_hours) or use the default ticket-wide settings (default).
data[][ticket][logs][][sla][work_start]	integer	*	When the work day starts. This is stored as the number of seconds after 00:00:00.
data[][ticket][logs][][sla][work_end]	integer	*	When the work day ends. This is stored as the number of seconds after 00:00:00.
data[][ticket][logs][][sla][work_days]	array	*	Array of work days, stored with keys corresponding to day numbers. Values are true. 0 = Sunday, 6 = Saturday (same as PHP, easy to convert to MySQL which is 1 = Sunday, 7 = Saturday).
data[][ticket][logs][][sla][work_timezone]	string	*	Timezone for work hours/days to be considered in.
data[][ticket][logs][][sla][work_holidays]	array	*	List of work holidays.
data[][ticket][logs][][sla][apply_type]	string	*	Controls how the SLA is applied to tickets: all, terms, terms_before_triggers, manual.
data[][ticket][logs][][sla][apply_terms]	object (TriggerTerms)	*	Conditions to apply.
data[][ticket][logs][][sla][apply_terms][version]	integer	*	Terms version.
data[][ticket][logs][][sla][apply_terms][terms]	array	*	Terms themselves.
data[][ticket][logs][][sla][trigger_terms]	object (TriggerTerms)	*	Conditions to consider sla completed.
data[][ticket][logs][][sla][warn_time]	integer	*	Warn time integer.
data[][ticket][logs][][sla][warn_time_unit]	string	*	And it's unit (see warn time).
data[][ticket][logs][][sla][warn_actions]	object (TriggerActions)	*	How to warn about SLA will fail.
data[][ticket][logs][][sla][warn_actions][version]	integer	*	Actions version.
data[][ticket][logs][][sla][warn_actions][actions]	array	*	Actions array representation.
data[][ticket][logs][][sla][fail_time]	integer	*	Fail time integer.
data[][ticket][logs][][sla][fail_time_unit]	string	*	And it's measuring unit (see fail_time).
data[][ticket][logs][][sla][fail_actions]	object (TriggerActions)	*	What to do if SLA failed.
data[][ticket][logs][][sla][exclude_ticket_statuses]	array	*	This SLA will not apply while tickets are in these pending statuses.
data[][ticket][logs][][sla_status]	string	*
data[][ticket][logs][][details]	array	*
data[][ticket][logs][][date_created]	DateTime	*
data[][ticket][chats][]	array of objects (ChatConversation)	*
data[][ticket][created_with_channel]	string	*
data[][ticket][last_channel_used]	string	*
data[][ticket][channels]	array	*
data[][ticket][pending_articles][]	array of objects (ArticlePendingCreate)	*
data[][ticket][pending_articles][][id]	integer	*
data[][ticket][pending_articles][][person]	integer id (Person)	*
data[][ticket][pending_articles][][assigned_person]	integer id (Person)	*
data[][ticket][pending_articles][][ticket]	integer id (Ticket)	*
data[][ticket][pending_articles][][message]	integer id (TicketMessage)	*
data[][ticket][pending_articles][][comment]	string	*
data[][ticket][pending_articles][][date_created]	DateTime	*
data[][ticket][summary]	object (TicketSummary)	*
data[][ticket][summary][id]	integer	*
data[][ticket][summary][ticket]	object (Ticket)	*
data[][ticket][summary][summary]	string	*
data[][ticket][summary][summary_input]	string	*
data[][ticket][summary][date_created]	DateTime	*
data[][subject]	string	*	Subject of the chat conversation.
data[][status]	string	*	Status of the chat conversation.
data[][agent]	object (Person)	*	If this is a user conversation, this is the agent assigned.
data[][agent_team]	object (AgentTeam)	*	If this is a team chat, the team it is.
data[][agent_team][id]	integer	*	The unique ID.
data[][agent_team][name]	string	*	The name of agent team.
data[][agent_team][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][person]	object (Person)	*	If this is a user conversation, this is the user who started the chat.
data[][session]	object (Session)	*	If this is a user convo, this is the users session.
data[][session][id]	integer	*	The unique ID.
data[][session][auth]	string	*	The authcode for the session to verify an id.
data[][session][interface]	string	*	The Interface the session is for.
data[][session][person]	object (Person)	*
data[][session][user_agent]	string	*	The users user agent string.
data[][session][visitor_id]	string	*
data[][session][ip_address]	string	*	The users IP address.
data[][session][data]	string	*
data[][session][is_person]	boolean	*
data[][session][is_bot]	boolean	*
data[][session][is_helpdesk]	boolean	*
data[][session][active_status]	string	*	(Agents) Status (available or away).
data[][session][is_chat_available]	boolean	*	(Agents) Wehn status is available, if they are available for chat.
data[][session][date_created]	DateTime	*
data[][session][date_last]	DateTime	*
data[][session][date_last_page]	DateTime	*
data[][visitor_id]	string	*
data[][person_name]	string	*	User chat: The users name, if they arent a person.
data[][person_email]	string	*	User chat: The users email, if they aren`t a person.
data[][participants][]	array of objects (Person)	*
data[][messages][]	array of objects (ChatMessage)	*
data[][messages][][id]	integer	*	The unique ID.
data[][messages][][author_id]	integer	*	Author id (legacy).
data[][messages][][author_type]	string	*	Author type (legacy).
data[][messages][][conversation_id]	integer	*	Conversation id (legacy).
data[][messages][][author]	integer id (Person)	*	Person who created the message.
data[][messages][][content]	string	*	The message.
data[][messages][][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data[][messages][][is_user]	boolean	*	Is this an user's message? (send from the widget).
data[][messages][][is_html]	boolean	*	Is the content an HTML message?
data[][messages][][metadata]	array	*	Additional data.
data[][messages][][date_created]	DateTime	*	Date message was created.
data[][messages][][date_received]	DateTime	*	Date message was received.
data[][custom_data][]	array of objects (CustomDataChat)	*
data[][custom_data][][conversation]	object (ChatConversation)	*	The conversation the message belongs to.
data[][custom_data][][conversation][id]	integer	*	The unique id of chat conversation.
data[][custom_data][][conversation][department]	object (Department)	*	Department which chat was assigned.
data[][custom_data][][conversation][brand]	object (Brand)	*	Department which chat was assigned.
data[][custom_data][][conversation][task_id]	integer	*
data[][custom_data][][conversation][ticket]	object (Ticket)	*
data[][custom_data][][conversation][labels][]	array of objects (LabelChatConversation)	*
data[][custom_data][][conversation][subject]	string	*	Subject of the chat conversation.
data[][custom_data][][conversation][status]	string	*	Status of the chat conversation.
data[][custom_data][][conversation][agent]	object (Person)	*	If this is a user conversation, this is the agent assigned.
data[][custom_data][][conversation][agent_team]	object (AgentTeam)	*	If this is a team chat, the team it is.
data[][custom_data][][conversation][person]	object (Person)	*	If this is a user conversation, this is the user who started the chat.
data[][custom_data][][conversation][session]	object (Session)	*	If this is a user convo, this is the users session.
data[][custom_data][][conversation][visitor_id]	string	*
data[][custom_data][][conversation][person_name]	string	*	User chat: The users name, if they arent a person.
data[][custom_data][][conversation][person_email]	string	*	User chat: The users email, if they aren`t a person.
data[][custom_data][][conversation][participants][]	array of objects (Person)	*
data[][custom_data][][conversation][messages][]	array of objects (ChatMessage)	*
data[][custom_data][][conversation][custom_data][]	array of objects (CustomDataChat)	*
data[][custom_data][][conversation][rating_response_time]	integer	*
data[][custom_data][][conversation][rating_overall]	integer	*
data[][custom_data][][conversation][rating_comment]	string	*
data[][custom_data][][conversation][is_agent]	boolean	*	Is this an agent chat.
data[][custom_data][][conversation][is_window]	boolean	*	If the chat is popped out into a window. This is used to make sure the JS widget on pages doesn't load again.
data[][custom_data][][conversation][date_created]	DateTime	*	Date when chat was started.
data[][custom_data][][conversation][date_user_waiting]	DateTime	*	Since when the user has started waiting (i.e., time the assignment was 0).
data[][custom_data][][conversation][date_assigned]	DateTime	*
data[][custom_data][][conversation][date_agent_typing]	DateTime	*	Date when agent typed last time.
data[][custom_data][][conversation][date_first_agent_message]	DateTime	*
data[][custom_data][][conversation][date_ended]	DateTime	*	Date when chat was ended.
data[][custom_data][][conversation][total_to_ended]	integer	*
data[][custom_data][][conversation][ended_by]	string	*	Who ended the chat.
data[][custom_data][][conversation][should_send_transcript]	boolean	*	True if transcript should be send.
data[][custom_data][][conversation][date_transcript_sent]	DateTime	*	Date when transcript was sent.
data[][custom_data][][conversation][email_validation_code]	string	*
data[][custom_data][][conversation][email_validated]	boolean	*
data[][custom_data][][conversation][access_token]	string	*
data[][custom_data][][field]	object (CustomDefChat)	*
data[][custom_data][][field][parent]	object (CustomDefChat)	*
data[][custom_data][][field][children][]	array of objects (CustomDefChat)	*	Field children.
data[][custom_data][][root_field]	object (CustomDefChat)	*
data[][rating_response_time]	integer	*
data[][rating_overall]	integer	*
data[][rating_comment]	string	*
data[][is_agent]	boolean	*	Is this an agent chat.
data[][is_window]	boolean	*	If the chat is popped out into a window. This is used to make sure the JS widget on pages doesn't load again.
data[][date_created]	DateTime	*	Date when chat was started.
data[][date_user_waiting]	DateTime	*	Since when the user has started waiting (i.e., time the assignment was 0).
data[][date_assigned]	DateTime	*
data[][date_agent_typing]	DateTime	*	Date when agent typed last time.
data[][date_first_agent_message]	DateTime	*
data[][date_ended]	DateTime	*	Date when chat was ended.
data[][total_to_ended]	integer	*
data[][should_send_transcript]	boolean	*	True if transcript should be send.
data[][date_transcript_sent]	DateTime	*	Date when transcript was sent.
data[][email_validation_code]	string	*
data[][email_validated]	boolean	*
data[][access_token]	string	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/user_chats CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chats.post

Parameters
Response
Status Codes

Parameter	Type	Required?	Format
subject	string	false
person[id]	string	false
person[name]	string	false
person[email]	string	false
person[fieldId]	string	false
person[key]	string	false
person_email	string	false
agent[id]	string	false
agent[name]	string	false
agent[email]	string	false
agent[fieldId]	string	false
agent[key]	string	false
email_validated	boolean	false
fields[2][mode]	string	false
fields[2][criteria]	string	false
fields[2][data]	string	true
fields[3][mode]	string	false
fields[3][criteria]	string	false
fields[3][data]	choice	true
fields[7][mode]	string	false
fields[7][criteria]	string	false
fields[7][data]	boolean	true
fields[8][mode]	string	false
fields[8][criteria]	string	false
fields[8][data]	date	true	yyyy-MM-dd
fields[9][mode]	string	false
fields[9][criteria]	string	false
fields[9][data]	datetime	true	yyyy-MM-dd'T'HH:mm:ss
chat_department	choice	true
rating_comment	string	false
rating_overall	boolean	false

Parameter	Type	Versions	Description
data.department	object (Department)	*	Department which chat was assigned.
data.department[id]	integer	*
data.department[parent]	object (Department)	*
data.department[children][]	array of objects (Department)	*
data.department[title]	string	*
data.department[user_title]	string	*
data.department[is_tickets_enabled]	boolean	*
data.department[is_chat_enabled]	boolean	*
data.department[display_order]	integer	*
data.department[avatar]	object (Blob)	*
data.department[avatar][sys_name]	string	*	A unique system name for the blob.
data.department[avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.department[avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.department[avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.department[avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.department[avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.department[avatar][file_url]	string	*	The HTTP link to download the file.
data.department[avatar][authcode]	string	*
data.department[avatar][blob_hash]	string	*
data.department[avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.department[avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.department[avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.department[avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.department[avatar][date_created]	DateTime	*
data.department[avatar][is_temp]	boolean	*
data.department[avatar][source_ref]	string	*
data.department[avatar][labels][]	array of objects (LabelBlob)	*
data.department[avatar][labels][][blob]	object (Blob)	*
data.department[avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.department[brands][]	array of objects (Brand)	*
data.department[brands][][id]	integer	*	The unique ID.
data.department[brands][][name]	string	*	The brand name.
data.department[brands][][slug]	string	*
data.department[brands][][url]	string	*	The brand url.
data.department[brands][][theme_set]	object (ThemeSet)	*
data.department[brands][][theme_set][id]	integer	*
data.department[brands][][theme_set][theme_id]	string	*
data.department[brands][][theme_set][title]	string	*
data.department[brands][][theme_set][options]		*
data.department[brands][][edit_theme_set]	object (ThemeSet)	*
data.department[brands][][departments][]	array of objects (Department)	*
data.department[brands][][theme_sets][]	array of objects (ThemeSet)	*
data.department[permissions][]	array of objects (DepartmentPermission)	*
data.department[permissions][][department]	integer id (Department)	*
data.department[permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.department[permissions][][name]	string	*	The name of the permission.
data.department[permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.department[permissions][][is_active]	boolean	*
data.department[chat_queue]	object (UserChatQueue)	*
data.department[chat_queue][id]	integer	*	The unique ID.
data.department[chat_queue][name]	string	*
data.department[chat_queue][routing_model]	string	*
data.department[chat_queue][answer_timeout]	integer	*
data.department[chat_queue][is_all_agents]	boolean	*
data.department[chat_queue][departments][]	array of objects (Department)	*
data.department[chat_queue][max_queue_size]	integer	*
data.department[chat_queue][routingModel]		*
data.labels[]	array of objects (LabelChatConversation)	*
data.labels[][chat]	object (ChatConversation)	*
data.labels[][chat][id]	integer	*	The unique id of chat conversation.
data.labels[][chat][department]	object (Department)	*	Department which chat was assigned.
data.labels[][chat][brand]	object (Brand)	*	Department which chat was assigned.
data.labels[][chat][brand][id]	integer	*	The unique ID.
data.labels[][chat][brand][name]	string	*	The brand name.
data.labels[][chat][brand][slug]	string	*
data.labels[][chat][brand][url]	string	*	The brand url.
data.labels[][chat][brand][theme_set]	object (ThemeSet)	*
data.labels[][chat][brand][theme_set][id]	integer	*
data.labels[][chat][brand][theme_set][theme_id]	string	*
data.labels[][chat][brand][theme_set][title]	string	*
data.labels[][chat][brand][edit_theme_set]	object (ThemeSet)	*
data.labels[][chat][brand][departments][]	array of objects (Department)	*
data.labels[][chat][brand][theme_sets][]	array of objects (ThemeSet)	*
data.labels[][chat][task_id]	integer	*
data.labels[][chat][ticket]	object (Ticket)	*
data.labels[][chat][ticket][id]	integer	*
data.labels[][chat][ticket][ref]	string	*
data.labels[][chat][ticket][auth]	string	*
data.labels[][chat][ticket][parent_ticket]	object (Ticket)	*	Parent ticket.
data.labels[][chat][ticket][children_tickets][]	array of objects (Ticket)	*
data.labels[][chat][ticket][language]	object (Language)	*	The language the ticket is in.
data.labels[][chat][ticket][language][id]	integer	*	The unique ID.
data.labels[][chat][ticket][language][sys_name]	string	*	The unique sys name assigned to the language.
data.labels[][chat][ticket][language][title]	string	*	Title of the language.
data.labels[][chat][ticket][language][title_local]	string	*	Title of the language.
data.labels[][chat][ticket][language][base_filepath]	string	*	The base filepath for default phrases for this lang.
data.labels[][chat][ticket][language][locale]	string	*	The locale code.
data.labels[][chat][ticket][language][flag_image]	string	*	String path to image.
data.labels[][chat][ticket][language][is_rtl]	boolean	*	True if this is a right-to-left language.
data.labels[][chat][ticket][language][has_user]	boolean	*	True if has user.
data.labels[][chat][ticket][language][has_agent]	boolean	*	True if has agent.
data.labels[][chat][ticket][language][has_admin]	boolean	*	True if has admin.
data.labels[][chat][ticket][language][plural_categories][]	array of strings	*
data.labels[][chat][ticket][language][plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data.labels[][chat][ticket][language][flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`
data.labels[][chat][ticket][brand]	object (Brand)	*
data.labels[][chat][ticket][department]	object (Department)	*
data.labels[][chat][ticket][category]	object (TicketCategory)	*
data.labels[][chat][ticket][category][id]	integer	*	The unique ID.
data.labels[][chat][ticket][category][parent]	integer id (TicketCategory)	*	This category parent.
data.labels[][chat][ticket][category][title]	string	*	Category title.
data.labels[][chat][ticket][category][display_order]	integer	*	Obviously it's display order for lists.
data.labels[][chat][ticket][priority]	object (TicketPriority)	*
data.labels[][chat][ticket][priority][id]	integer	*	The unique ID.
data.labels[][chat][ticket][priority][title]	string	*	Priority title.
data.labels[][chat][ticket][priority][priority]	integer	*	The priority itself.
data.labels[][chat][ticket][workflow]	object (TicketWorkflow)	*
data.labels[][chat][ticket][workflow][id]	integer	*	The unique ID.
data.labels[][chat][ticket][workflow][title]	string	*	Workflow title.
data.labels[][chat][ticket][workflow][display_order]	integer	*	Workflow display order.
data.labels[][chat][ticket][product]	object (Product)	*
data.labels[][chat][ticket][product][parent]	integer id (Product)	*	Parent of the product.
data.labels[][chat][ticket][person]	object (Person)	*
data.labels[][chat][ticket][person_email]	object (PersonEmail)	*
data.labels[][chat][ticket][person_email][id]	integer	*	The unique ID.
data.labels[][chat][ticket][person_email][person]	integer id (Person)	*	Person owner of email.
data.labels[][chat][ticket][person_email][email]	string	*	The email address.
data.labels[][chat][ticket][person_email][email_domain]	string	*	The email address domain.
data.labels[][chat][ticket][person_email][is_validated]	boolean	*	True if validation passed.
data.labels[][chat][ticket][person_email][date_created]	DateTime	*	The original time the email was created.
data.labels[][chat][ticket][agent]	object (Person)	*
data.labels[][chat][ticket][agent_team]	object (AgentTeam)	*
data.labels[][chat][ticket][agent_team][id]	integer	*	The unique ID.
data.labels[][chat][ticket][agent_team][name]	string	*	The name of agent team.
data.labels[][chat][ticket][agent_team][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.labels[][chat][ticket][organization]	object (Organization)	*
data.labels[][chat][ticket][organization][id]	integer	*	The unique ID.
data.labels[][chat][ticket][organization][picture_blob]	object (Blob)	*	The org picture.
data.labels[][chat][ticket][organization][picture_blob][sys_name]	string	*	A unique system name for the blob.
data.labels[][chat][ticket][organization][picture_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][chat][ticket][organization][picture_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][chat][ticket][organization][picture_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][chat][ticket][organization][picture_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][chat][ticket][organization][picture_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][chat][ticket][organization][picture_blob][file_url]	string	*	The HTTP link to download the file.
data.labels[][chat][ticket][organization][picture_blob][authcode]	string	*
data.labels[][chat][ticket][organization][picture_blob][blob_hash]	string	*
data.labels[][chat][ticket][organization][picture_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][chat][ticket][organization][picture_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][chat][ticket][organization][picture_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][chat][ticket][organization][picture_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][chat][ticket][organization][picture_blob][date_created]	DateTime	*
data.labels[][chat][ticket][organization][picture_blob][is_temp]	boolean	*
data.labels[][chat][ticket][organization][picture_blob][source_ref]	string	*
data.labels[][chat][ticket][organization][picture_blob][labels][]	array of objects (LabelBlob)	*
data.labels[][chat][ticket][organization][picture_blob][labels][][blob]	object (Blob)	*
data.labels[][chat][ticket][organization][icon_property]	object (IconProperty)	*
data.labels[][chat][ticket][organization][icon_property][urn]	string	*
data.labels[][chat][ticket][organization][icon_property][options]	array	*
data.labels[][chat][ticket][organization][name]	string	*	The organization name.
data.labels[][chat][ticket][organization][summary]	string	*	The summary field as filled in by agents.
data.labels[][chat][ticket][organization][importance]	integer	*	The org importance.
data.labels[][chat][ticket][organization][custom_data][]	array of objects (CustomDataOrganization)	*
data.labels[][chat][ticket][organization][custom_data][][organization]	object (Organization)	*
data.labels[][chat][ticket][organization][custom_data][][field]	object (CustomDefOrganization)	*
data.labels[][chat][ticket][organization][custom_data][][field][parent]	object (CustomDefOrganization)	*	Field`s parent.
data.labels[][chat][ticket][organization][custom_data][][field][children][]	array of objects (CustomDefOrganization)	*	Field children.
data.labels[][chat][ticket][organization][custom_data][][root_field]	object (CustomDefOrganization)	*
data.labels[][chat][ticket][organization][usergroups][]	array of objects (Usergroup)	*	Usergroups the user belongs to.
data.labels[][chat][ticket][organization][usergroups][][id]	integer	*	The unique ID, DB-generated.
data.labels[][chat][ticket][organization][usergroups][][title]	string	*	Title of the usergroup.
data.labels[][chat][ticket][organization][usergroups][][note]	string	*	A note or description about the usergroup.
data.labels[][chat][ticket][organization][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.labels[][chat][ticket][organization][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.labels[][chat][ticket][organization][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.labels[][chat][ticket][organization][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.labels[][chat][ticket][organization][usergroups][][permissions][][id]	integer	*	The unique ID.
data.labels[][chat][ticket][organization][usergroups][][permissions][][name]	string	*	The name of the permission.
data.labels[][chat][ticket][organization][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.labels[][chat][ticket][organization][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.labels[][chat][ticket][organization][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.labels[][chat][ticket][organization][usergroups][][department_permissions][][department]	integer id (Department)	*
data.labels[][chat][ticket][organization][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.labels[][chat][ticket][organization][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.labels[][chat][ticket][organization][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.labels[][chat][ticket][organization][usergroups][][department_permissions][][is_active]	boolean	*
data.labels[][chat][ticket][organization][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.labels[][chat][ticket][organization][auto_cc_people][]	array of objects (Person)	*	Users who are set to automatically be added to tickets and other org things.
data.labels[][chat][ticket][organization][labels][]	array of objects (LabelOrganization)	*
data.labels[][chat][ticket][organization][labels][][organization]	object (Organization)	*
data.labels[][chat][ticket][organization][contact_data][]	array of objects (OrganizationContactData)	*
data.labels[][chat][ticket][organization][emails][]	array of objects (OrganizationEmail)	*
data.labels[][chat][ticket][organization][emails][][id]	integer	*	The unique log id.
data.labels[][chat][ticket][organization][emails][][organization]	object (Organization)	*
data.labels[][chat][ticket][organization][emails][][email]	string	*
data.labels[][chat][ticket][organization][emails][][date_created]	DateTime	*
data.labels[][chat][ticket][organization][email_domains][]	array of objects (OrganizationEmailDomain)	*
data.labels[][chat][ticket][organization][email_domains][][domain]	string	*	The email domain.
data.labels[][chat][ticket][organization][email_domains][][organization]	object (Organization)	*	The users organization.
data.labels[][chat][ticket][organization][date_created]	DateTime	*	The date the org was inserted into the system.
data.labels[][chat][ticket][organization][members][]	array of objects (Person)	*
data.labels[][chat][ticket][organization][parent]	object (Organization)	*
data.labels[][chat][ticket][organization][children][]	array of objects (Organization)	*
data.labels[][chat][ticket][organization][tickets][]	array of objects (Ticket)	*
data.labels[][chat][ticket][organization][organization_members][]	array of objects (OrganizationMember)	*
data.labels[][chat][ticket][organization][organization_members][][id]	integer	*
data.labels[][chat][ticket][organization][organization_members][][person]	integer id (Person)	*
data.labels[][chat][ticket][organization][organization_members][][organization]	integer id (Organization)	*
data.labels[][chat][ticket][organization][organization_members][][is_manager]	boolean	*
data.labels[][chat][ticket][organization][organization_members][][position]	string	*
data.labels[][chat][ticket][organization][organization_members][][created_at]	DateTime	*
data.labels[][chat][ticket][organization][organization_members][][updated_at]	DateTime	*
data.labels[][chat][ticket][linked_chat]	object (ChatConversation)	*
data.labels[][chat][ticket][attachments][]	array of objects (TicketAttachment)	*
data.labels[][chat][ticket][attachments][][id]	integer	*	The unique ID.
data.labels[][chat][ticket][attachments][][ticket]	integer id (Ticket)	*	Ticket this attachment belongs to.
data.labels[][chat][ticket][attachments][][person]	integer id (Person)	*	Who created the attachment.
data.labels[][chat][ticket][attachments][][blob]	object (Blob)	*	Actual attachment.
data.labels[][chat][ticket][attachments][][blob][sys_name]	string	*	A unique system name for the blob.
data.labels[][chat][ticket][attachments][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][chat][ticket][attachments][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][chat][ticket][attachments][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][chat][ticket][attachments][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][chat][ticket][attachments][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][chat][ticket][attachments][][blob][file_url]	string	*	The HTTP link to download the file.
data.labels[][chat][ticket][attachments][][blob][authcode]	string	*
data.labels[][chat][ticket][attachments][][blob][blob_hash]	string	*
data.labels[][chat][ticket][attachments][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][chat][ticket][attachments][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][chat][ticket][attachments][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][chat][ticket][attachments][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][chat][ticket][attachments][][blob][date_created]	DateTime	*
data.labels[][chat][ticket][attachments][][blob][is_temp]	boolean	*
data.labels[][chat][ticket][attachments][][blob][source_ref]	string	*
data.labels[][chat][ticket][attachments][][blob][labels][]	array of objects (LabelBlob)	*
data.labels[][chat][ticket][attachments][][blob][labels][][blob]	object (Blob)	*
data.labels[][chat][ticket][attachments][][message]	integer id (TicketMessage)	*	Message - holder of this attachment.
data.labels[][chat][ticket][attachments][][is_agent_note]	boolean	*	True if this attachmen just a note.
data.labels[][chat][ticket][attachments][][is_inline]	boolean	*	Is this attachment is embed in message.
data.labels[][chat][ticket][access_codes][]	array of objects (TicketAccessCode)	*
data.labels[][chat][ticket][access_codes][][id]	integer	*
data.labels[][chat][ticket][access_codes][][ticket]	object (Ticket)	*
data.labels[][chat][ticket][access_codes][][person]	object (Person)	*
data.labels[][chat][ticket][access_codes][][auth]	string	*
data.labels[][chat][ticket][messages][]	array of objects (TicketMessage)	*
data.labels[][chat][ticket][messages][][id]	integer	*	The unique id of message.
data.labels[][chat][ticket][messages][][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data.labels[][chat][ticket][messages][][person]	object (Person)	*	Person this message was sent by.
data.labels[][chat][ticket][messages][][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data.labels[][chat][ticket][messages][][email_source][id]	integer	*
data.labels[][chat][ticket][messages][][email_source][uuid]	string	*
data.labels[][chat][ticket][messages][][email_source][blob]	object (Blob)	*
data.labels[][chat][ticket][messages][][email_source][blob][sys_name]	string	*	A unique system name for the blob.
data.labels[][chat][ticket][messages][][email_source][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][chat][ticket][messages][][email_source][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][chat][ticket][messages][][email_source][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][chat][ticket][messages][][email_source][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][chat][ticket][messages][][email_source][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][chat][ticket][messages][][email_source][blob][file_url]	string	*	The HTTP link to download the file.
data.labels[][chat][ticket][messages][][email_source][blob][authcode]	string	*
data.labels[][chat][ticket][messages][][email_source][blob][blob_hash]	string	*
data.labels[][chat][ticket][messages][][email_source][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][chat][ticket][messages][][email_source][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][chat][ticket][messages][][email_source][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][chat][ticket][messages][][email_source][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][chat][ticket][messages][][email_source][blob][date_created]	DateTime	*
data.labels[][chat][ticket][messages][][email_source][blob][is_temp]	boolean	*
data.labels[][chat][ticket][messages][][email_source][blob][source_ref]	string	*
data.labels[][chat][ticket][messages][][email_source][blob][labels][]	array of objects (LabelBlob)	*
data.labels[][chat][ticket][messages][][email_source][blob][labels][][blob]	object (Blob)	*
data.labels[][chat][ticket][messages][][email_source][object_type]	string	*	The type of object this is attached to (should be the table name of the super type, eg: tickets, people, organizations). This typically is not set until after the email is processed (ie the status is 'processed').
data.labels[][chat][ticket][messages][][email_source][object_id]	integer	*	The ID of the object this is attached to.
data.labels[][chat][ticket][messages][][email_source][from_email]	string	*
data.labels[][chat][ticket][messages][][email_source][status]	string	*	The current status of the message: - inserted: Only inserted - processing: Currently processing - complete: Fully processed - error: Tried to process but there was some kind of error (see error_code).
data.labels[][chat][ticket][messages][][email_source][date_status]	DateTime	*
data.labels[][chat][ticket][messages][][email_source][error_code]	string	*	When status is error, this is the code that describes the error.
data.labels[][chat][ticket][messages][][email_source][date_created]	DateTime	*
data.labels[][chat][ticket][messages][][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.labels[][chat][ticket][messages][][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.labels[][chat][ticket][messages][][snippet_use_logs][][id]	integer	*	The unique ID.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet]	object (SnippetV2)	*	Snippet used.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][id]	integer	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][title]	string	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][author]	object (Person)	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][is_private]	boolean	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar]	object (Blob)	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][sys_name]	string	*	A unique system name for the blob.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][file_url]	string	*	The HTTP link to download the file.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][authcode]	string	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][blob_hash]	string	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][date_created]	DateTime	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][is_temp]	boolean	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][source_ref]	string	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][labels][]	array of objects (LabelBlob)	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][labels][][blob]	object (Blob)	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][status]	string	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][shortcut_codes]	array	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][inline_translations]	array	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][translations][]	array of objects (SnippetV2Translation)	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][translations][][id]	integer	*	The unique ID.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][translations][][snippet]	object (SnippetV2)	*	Snippet translated.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][translations][][language]	object (Language)	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][translations][][content]	array	*	Snippet content.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][translations][][blobs][]	array of objects (Blob)	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][categories][]	array of objects (SnippetV2Category)	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][categories][][id]	integer	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][categories][][title]	string	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][categories][][is_global]	boolean	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][categories][][display_order]	integer	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][categories][][parent]	object (SnippetV2Category)	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][categories][][agent_teams][]	array of objects (AgentTeam)	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][display_order]	integer	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][date_created]	DateTime	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][ticket_message]	object (TicketMessage)	*	Ticket Message where the snippet was used.
data.labels[][chat][ticket][messages][][snippet_use_logs][][chat_message]	object (ChatMessage)	*	Chat Message where the snippet was used.
data.labels[][chat][ticket][messages][][snippet_use_logs][][chat_message][id]	integer	*	The unique ID.
data.labels[][chat][ticket][messages][][snippet_use_logs][][chat_message][author_id]	integer	*	Author id (legacy).
data.labels[][chat][ticket][messages][][snippet_use_logs][][chat_message][author_type]	string	*	Author type (legacy).
data.labels[][chat][ticket][messages][][snippet_use_logs][][chat_message][conversation_id]	integer	*	Conversation id (legacy).
data.labels[][chat][ticket][messages][][snippet_use_logs][][chat_message][author]	integer id (Person)	*	Person who created the message.
data.labels[][chat][ticket][messages][][snippet_use_logs][][chat_message][content]	string	*	The message.
data.labels[][chat][ticket][messages][][snippet_use_logs][][chat_message][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.labels[][chat][ticket][messages][][snippet_use_logs][][chat_message][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.labels[][chat][ticket][messages][][snippet_use_logs][][chat_message][is_html]	boolean	*	Is the content an HTML message?
data.labels[][chat][ticket][messages][][snippet_use_logs][][chat_message][metadata]	array	*	Additional data.
data.labels[][chat][ticket][messages][][snippet_use_logs][][chat_message][date_created]	DateTime	*	Date message was created.
data.labels[][chat][ticket][messages][][snippet_use_logs][][chat_message][date_received]	DateTime	*	Date message was received.
data.labels[][chat][ticket][messages][][snippet_use_logs][][language]	object (Language)	*	Snippet translated.
data.labels[][chat][ticket][messages][][snippet_use_logs][][person]	object (Person)	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][rating]	integer	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][rating_person]	object (Person)	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][rating_message]	string	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][date_created]	DateTime	*
data.labels[][chat][ticket][messages][][date_created]	DateTime	*	Date when message was created.
data.labels[][chat][ticket][messages][][is_agent_note]	boolean	*	Is this message agent note?
data.labels[][chat][ticket][messages][][is_hidden]	boolean	*	Is this message hidden?
data.labels[][chat][ticket][messages][][creation_system]	string	*	How this message was created.
data.labels[][chat][ticket][messages][][ip_address]	string	*	An ip address from which message was sent.
data.labels[][chat][ticket][messages][][visitor_id]	string	*	Unique ID of visitor left this message.
data.labels[][chat][ticket][messages][][hostname]	string	*	Host from which message was left.
data.labels[][chat][ticket][messages][][geo_country]	string	*	Country message is from (deprecated).
data.labels[][chat][ticket][messages][][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.labels[][chat][ticket][messages][][message_hash]	string	*	An unique hash of message.
data.labels[][chat][ticket][messages][][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.labels[][chat][ticket][messages][][primary_translation][id]	integer	*
data.labels[][chat][ticket][messages][][primary_translation][ticket]	object (Ticket)	*
data.labels[][chat][ticket][messages][][primary_translation][ticket_message]	object (TicketMessage)	*
data.labels[][chat][ticket][messages][][primary_translation][from_lang_code]	string	*
data.labels[][chat][ticket][messages][][primary_translation][lang_code]	string	*
data.labels[][chat][ticket][messages][][primary_translation][message]	string	*
data.labels[][chat][ticket][messages][][primary_translation][date_created]	DateTime	*
data.labels[][chat][ticket][messages][][message]	string	*	The message, will be in HTML!
data.labels[][chat][ticket][messages][][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.labels[][chat][ticket][messages][][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.labels[][chat][ticket][messages][][message_source]	string	*	The message source.
data.labels[][chat][ticket][messages][][message_source_type]	string	*	The message source type.
data.labels[][chat][ticket][messages][][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.labels[][chat][ticket][messages][][lang_code]	string	*	The set/detected lang code.
data.labels[][chat][ticket][messages][][email_message_id][]	array of objects (TicketMessageEmailId)	*
data.labels[][chat][ticket][messages][][email_message_id][][id]	integer	*
data.labels[][chat][ticket][messages][][email_message_id][][message]	object (TicketMessage)	*
data.labels[][chat][ticket][messages][][email_message_id][][email_id]	string	*
data.labels[][chat][ticket][messages][][ticket_feedback][]	array of objects (TicketFeedback)	*
data.labels[][chat][ticket][messages][][ticket_feedback][][id]	integer	*
data.labels[][chat][ticket][messages][][ticket_feedback][][ticket]	object (Ticket)	*
data.labels[][chat][ticket][messages][][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data.labels[][chat][ticket][messages][][ticket_feedback][][person]	object (Person)	*
data.labels[][chat][ticket][messages][][ticket_feedback][][rating]	integer	*
data.labels[][chat][ticket][messages][][ticket_feedback][][message]	string	*
data.labels[][chat][ticket][messages][][ticket_feedback][][date_created]	DateTime	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][id]	integer	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][subject]	string	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][from_email]	string	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][tos]	array	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][ccs]	array	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][bccs]	array	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][message]	string	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][authcode]	string	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][blob_hash]	string	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][source_ref]	string	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][date_created]	DateTime	*
data.labels[][chat][ticket][messages][][channel_message]	object (TicketMessageChannelMessage)	*
data.labels[][chat][ticket][messages][][channel_message][id]	integer	*	@var int The unique id of message.
data.labels[][chat][ticket][messages][][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data.labels[][chat][ticket][messages][][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data.labels[][chat][ticket][messages][][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data.labels[][chat][ticket][messages][][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data.labels[][chat][ticket][messages][][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data.labels[][chat][ticket][messages][][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data.labels[][chat][ticket][messages][][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data.labels[][chat][ticket][messages][][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data.labels[][chat][ticket][messages][][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data.labels[][chat][ticket][sms_messages][]	array of objects (TicketSms)	*
data.labels[][chat][ticket][sms_messages][][id]	integer	*
data.labels[][chat][ticket][sms_messages][][ticket]	object (Ticket)	*
data.labels[][chat][ticket][sms_messages][][person]	object (Person)	*
data.labels[][chat][ticket][sms_messages][][sms_account]	object (SmsAccount)	*
data.labels[][chat][ticket][sms_messages][][sms_account][id]	integer	*	The unique ID.
data.labels[][chat][ticket][sms_messages][][sms_account][type]	string	*
data.labels[][chat][ticket][sms_messages][][sms_account][params]	array	*
data.labels[][chat][ticket][sms_messages][][sms_account][identifier]	string	*
data.labels[][chat][ticket][sms_messages][][sms_account][is_enabled]	boolean	*
data.labels[][chat][ticket][sms_messages][][sms_account][is_connected]	boolean	*
data.labels[][chat][ticket][sms_messages][][sms_account][is_tested]	boolean	*
data.labels[][chat][ticket][sms_messages][][sms_account][test_code]	string	*
data.labels[][chat][ticket][sms_messages][][job]	object (Job)	*
data.labels[][chat][ticket][sms_messages][][job][id]	integer	*	The unique job id.
data.labels[][chat][ticket][sms_messages][][job][type]	string	*	The job type, used by the Job Router to find the right Job Processor.
data.labels[][chat][ticket][sms_messages][][job][status]	string	*	The status of the job.
data.labels[][chat][ticket][sms_messages][][job][status_code]	string	*	Any code to further classify the status.
data.labels[][chat][ticket][sms_messages][][job][date_touch]	DateTime	*	Date the last time a process "touched" this ticket.
data.labels[][chat][ticket][sms_messages][][job][date_created]	DateTime	*	Date this job entered the "jobs" table.
data.labels[][chat][ticket][sms_messages][][job][date_last_try]	DateTime	*	Last time we processed this job.
data.labels[][chat][ticket][sms_messages][][job][date_next_try]	DateTime	*	If this DateTime is in the future, it won't be selected for execution.
data.labels[][chat][ticket][sms_messages][][job][num_tries]	integer	*	The number of times this job has been executed Job Processor (usually indicated failures if > 1).
data.labels[][chat][ticket][sms_messages][][job][log_summary]	string	*	A human readable summary of the job's execution.
data.labels[][chat][ticket][sms_messages][][job][log]	string	*	A more verbose log.
data.labels[][chat][ticket][sms_messages][][job][data]	array	*	An array of data, or payload, that the job processor needs to execute this job (stored in the db as json). This MUST always be an array, even if its an empty array
data.labels[][chat][ticket][sms_messages][][job][original_job]	integer	*	Null unless the job was created as a retry - if so, the originating job ID is stored here so we can query it later. Note: You MUST specify the originating job, do not create a linked list of failed jobs.
data.labels[][chat][ticket][sms_messages][][date_created]	DateTime	*
data.labels[][chat][ticket][sms_messages][][from_number]	string	*	Permanent record of the phone number that sent this SMS. (Won't change even if Person changes their phone number).
data.labels[][chat][ticket][sms_messages][][to_number]	string	*	Permanent record of the phone number that this SMS was sent to.
data.labels[][chat][ticket][sms_messages][][message]	string	*	The SMS message.
data.labels[][chat][ticket][sms_messages][][direction]	string	*	Just a system flag for reporting.
data.labels[][chat][ticket][topic_links][]	array of objects (TicketCommunityTopicLink)	*
data.labels[][chat][ticket][topic_links][][id]	integer	*	The unique filter ID.
data.labels[][chat][ticket][topic_links][][ticket]	integer id (Ticket)	*
data.labels[][chat][ticket][topic_links][][topic]	integer id (CommunityTopic)	*
data.labels[][chat][ticket][topic_links][][person]	integer id (Person)	*
data.labels[][chat][ticket][topic_links][][date_created]	DateTime	*
data.labels[][chat][ticket][custom_data][]	array of objects (CustomDataTicket)	*
data.labels[][chat][ticket][custom_data][][ticket]	object (Ticket)	*
data.labels[][chat][ticket][custom_data][][field]	object (CustomDefTicket)	*
data.labels[][chat][ticket][custom_data][][field][parent]	object (CustomDefTicket)	*
data.labels[][chat][ticket][custom_data][][field][children][]	array of objects (CustomDefTicket)	*	Field children.
data.labels[][chat][ticket][custom_data][][root_field]	object (CustomDefTicket)	*
data.labels[][chat][ticket][labels][]	array of objects (LabelTicket)	*
data.labels[][chat][ticket][labels][][ticket]	object (Ticket)	*
data.labels[][chat][ticket][sent_to_address]	string	*	The email address the ticket was sent to if it came in via a gateway. This is a full string (e.g., including CC's) of the original.
data.labels[][chat][ticket][email_account]	object (EmailAccount)	*	The gateway this ticket originated from.
data.labels[][chat][ticket][email_account][id]	integer	*
data.labels[][chat][ticket][email_account][account_type]	string	*
data.labels[][chat][ticket][email_account][is_enabled]	boolean	*
data.labels[][chat][ticket][email_account][address]	string	*
data.labels[][chat][ticket][email_account][cert_blob]	object (Blob)	*
data.labels[][chat][ticket][email_account][cert_blob][sys_name]	string	*	A unique system name for the blob.
data.labels[][chat][ticket][email_account][cert_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][chat][ticket][email_account][cert_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][chat][ticket][email_account][cert_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][chat][ticket][email_account][cert_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][chat][ticket][email_account][cert_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][chat][ticket][email_account][cert_blob][file_url]	string	*	The HTTP link to download the file.
data.labels[][chat][ticket][email_account][cert_blob][authcode]	string	*
data.labels[][chat][ticket][email_account][cert_blob][blob_hash]	string	*
data.labels[][chat][ticket][email_account][cert_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][chat][ticket][email_account][cert_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][chat][ticket][email_account][cert_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][chat][ticket][email_account][cert_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][chat][ticket][email_account][cert_blob][date_created]	DateTime	*
data.labels[][chat][ticket][email_account][cert_blob][is_temp]	boolean	*
data.labels[][chat][ticket][email_account][cert_blob][source_ref]	string	*
data.labels[][chat][ticket][email_account][cert_blob][labels][]	array of objects (LabelBlob)	*
data.labels[][chat][ticket][email_account][cert_blob][labels][][blob]	object (Blob)	*
data.labels[][chat][ticket][email_account][key_blob]	object (Blob)	*
data.labels[][chat][ticket][email_account_address]	string	*	The email address (from list of to/cc) that matched with the email account.
data.labels[][chat][ticket][creation_system]	string	*
data.labels[][chat][ticket][creation_system_option]	string	*	Optional information about the creation system. For example, source URL the ticket came from.
data.labels[][chat][ticket][ticket_hash]	string	*
data.labels[][chat][ticket][status]	string	*
data.labels[][chat][ticket][ticket_status]	object (TicketStatus)	*
data.labels[][chat][ticket][ticket_status][id]	integer	*
data.labels[][chat][ticket][ticket_status][status_type]	string	*
data.labels[][chat][ticket][ticket_status][status_code]	string	*
data.labels[][chat][ticket][ticket_status][sys_id]	string	*
data.labels[][chat][ticket][ticket_status][title]	string	*
data.labels[][chat][ticket][ticket_status][display_order]	integer	*
data.labels[][chat][ticket][ticket_status][pending_waiting_time_mode]	string	*	Where to count time spending in pending status. Check PENDING_WAITING_TIME_MODE_ constants
data.labels[][chat][ticket][ticket_status][children][]	array of objects (TicketStatus)	*
data.labels[][chat][ticket][ticket_status][options]	array	*
data.labels[][chat][ticket][urgency]	integer	*
data.labels[][chat][ticket][feedback_rating]	integer	*
data.labels[][chat][ticket][date_feedback_rating]	DateTime	*
data.labels[][chat][ticket][date_created]	DateTime	*
data.labels[][chat][ticket][date_resolved]	DateTime	*
data.labels[][chat][ticket][date_archived]	DateTime	*
data.labels[][chat][ticket][date_first_agent_assign]	DateTime	*
data.labels[][chat][ticket][date_first_agent_reply]	DateTime	*
data.labels[][chat][ticket][date_last_agent_reply]	DateTime	*
data.labels[][chat][ticket][date_last_user_reply]	DateTime	*
data.labels[][chat][ticket][date_agent_waiting]	DateTime	*
data.labels[][chat][ticket][date_user_waiting]	DateTime	*
data.labels[][chat][ticket][date_status]	DateTime	*
data.labels[][chat][ticket][date_on_hold]	DateTime	*
data.labels[][chat][ticket][total_user_waiting]	integer	*
data.labels[][chat][ticket][total_to_first_reply]	integer	*
data.labels[][chat][ticket][total_user_waiting_wh_start]	DateTime	*
data.labels[][chat][ticket][total_user_waiting_wh]	integer	*
data.labels[][chat][ticket][total_to_first_reply_wh]	integer	*
data.labels[][chat][ticket][locked_by_agent]	object (Person)	*
data.labels[][chat][ticket][date_locked]	DateTime	*
data.labels[][chat][ticket][has_attachments]	boolean	*
data.labels[][chat][ticket][subject]	string	*
data.labels[][chat][ticket][original_subject]	string	*
data.labels[][chat][ticket][properties]	array	*
data.labels[][chat][ticket][count_agent_replies]	integer	*
data.labels[][chat][ticket][count_user_replies]	integer	*
data.labels[][chat][ticket][worst_sla_status]	string	*
data.labels[][chat][ticket][waiting_times]	array	*	Used to track ticket status changes and how much time ticket was in status Add new item every time status changed This is optimisation over TicketLog.
data.labels[][chat][ticket][participants][]	array of objects (TicketParticipant)	*
data.labels[][chat][ticket][participants][][id]	integer	*
data.labels[][chat][ticket][participants][][ticket]	object (Ticket)	*
data.labels[][chat][ticket][participants][][person]	object (Person)	*
data.labels[][chat][ticket][participants][][access_code]	object (TicketAccessCode)	*
data.labels[][chat][ticket][participants][][person_email]	object (PersonEmail)	*
data.labels[][chat][ticket][participants][][default_on]	boolean	*	Default checkbox status of the user.
data.labels[][chat][ticket][charges][]	array of objects (TicketCharge)	*
data.labels[][chat][ticket][charges][][id]	integer	*
data.labels[][chat][ticket][charges][][charge_time]	integer	*
data.labels[][chat][ticket][charges][][amount]	float	*
data.labels[][chat][ticket][charges][][date_created]	DateTime	*
data.labels[][chat][ticket][charges][][ticket]	object (Ticket)	*
data.labels[][chat][ticket][charges][][person]	object (Person)	*
data.labels[][chat][ticket][charges][][organization]	object (Organization)	*
data.labels[][chat][ticket][charges][][agent]	object (Person)	*
data.labels[][chat][ticket][charges][][custom_data][]	array of objects (CustomDataBilling)	*
data.labels[][chat][ticket][charges][][custom_data][][ticket_charge]	object (TicketCharge)	*
data.labels[][chat][ticket][charges][][custom_data][][field]	object (CustomDefBilling)	*
data.labels[][chat][ticket][charges][][custom_data][][field][parent]	object (CustomDefBilling)	*
data.labels[][chat][ticket][charges][][custom_data][][field][children][]	array of objects (CustomDefBilling)	*	Field children.
data.labels[][chat][ticket][charges][][custom_data][][root_field]	object (CustomDefBilling)	*
data.labels[][chat][ticket][ticket_slas][]	array of objects (TicketSla)	*
data.labels[][chat][ticket][ticket_slas][][id]	integer	*	The unique ID.
data.labels[][chat][ticket][ticket_slas][][sla_status]	string	*	The SLA status.
data.labels[][chat][ticket][ticket_slas][][warn_date]	DateTime	*	The SLA warn date.
data.labels[][chat][ticket][ticket_slas][][fail_date]	DateTime	*	The SLA fail date.
data.labels[][chat][ticket][ticket_slas][][is_completed]	boolean	*	Is the SLA completed?
data.labels[][chat][ticket][ticket_slas][][is_completed_set]	boolean	*	Completed by automated action.
data.labels[][chat][ticket][ticket_slas][][completed_time_taken]	integer	*	Time taken.
data.labels[][chat][ticket][ticket_slas][][ticket]	integer id (Ticket)	*	Ticket.
data.labels[][chat][ticket][ticket_slas][][sla]	integer id (Sla)	*	SLA.
data.labels[][chat][ticket][ticket_slas][][date_applied]	DateTime	*	time and date when SLA was applied to the ticket.
data.labels[][chat][ticket][ticket_slas][][date_completed]	DateTime	*	time when SLA status became OK.
data.labels[][chat][ticket][jira_issues][]	array of objects (JiraIssue)	*	linked jira issues.
data.labels[][chat][ticket][jira_issues][][id]	integer	*	The unique ID.
data.labels[][chat][ticket][jira_issues][][ticket]	object (Ticket)	*	The associated DeskPRO ticket.
data.labels[][chat][ticket][jira_issues][][issue_id]	integer	*
data.labels[][chat][ticket][jira_issues][][status_id]	integer	*
data.labels[][chat][ticket][jira_issues][][created]	DateTime	*	Export time.
data.labels[][chat][ticket][problems][]	array of objects (Problem)	*
data.labels[][chat][ticket][problems][][id]	integer	*	The unique ID.
data.labels[][chat][ticket][problems][][title]	string	*	Problem title.
data.labels[][chat][ticket][problems][][creator]	integer id (Person)	*	Person who created the problem.
data.labels[][chat][ticket][problems][][created]	DateTime	*	Date when the problem was created.
data.labels[][chat][ticket][problems][][is_open]	boolean	*	Is problem still has no solution?
data.labels[][chat][ticket][problems][][tickets][]	array of integer ids (Ticket)	*	Tickets associated with problem.
data.labels[][chat][ticket][stars][]	array of objects (TicketFlagged)	*
data.labels[][chat][ticket][stars][][ticket]	object (Ticket)	*
data.labels[][chat][ticket][stars][][person_id]	integer	*
data.labels[][chat][ticket][stars][][color]	string	*
data.labels[][chat][ticket][follow_ups][]	array of objects (TicketFollowUp)	*
data.labels[][chat][ticket][follow_ups][][id]	integer	*	The unique ID.
data.labels[][chat][ticket][follow_ups][][person]	integer id (Person)	*
data.labels[][chat][ticket][follow_ups][][actions]	array	*
data.labels[][chat][ticket][follow_ups][][cancel_if_user_reply]	boolean	*
data.labels[][chat][ticket][follow_ups][][cancel_if_agent_reply]	boolean	*
data.labels[][chat][ticket][follow_ups][][status]	string	*
data.labels[][chat][ticket][follow_ups][][date_created]	DateTime	*
data.labels[][chat][ticket][follow_ups][][date_to_run]	DateTime	*
data.labels[][chat][ticket][follow_ups][][date_did_run]	DateTime	*
data.labels[][chat][ticket][logs][]	array of objects (TicketLog)	*
data.labels[][chat][ticket][logs][][id]	integer	*
data.labels[][chat][ticket][logs][][parent]	object (TicketLog)	*
data.labels[][chat][ticket][logs][][ticket]	object (Ticket)	*
data.labels[][chat][ticket][logs][][person]	object (Person)	*
data.labels[][chat][ticket][logs][][action_type]	string	*
data.labels[][chat][ticket][logs][][id_object]	integer	*	If the log involves a specific thing in a ticket (eg a message that was moved), then that is this id.
data.labels[][chat][ticket][logs][][id_before]	integer	*	The ID of the previous entity changed, or any other numeric value.
data.labels[][chat][ticket][logs][][id_after]	integer	*	The ID of the new entity, or any other numeric value.
data.labels[][chat][ticket][logs][][trigger_id]	integer	*	If the change was caused by a trigger, the trigger id. Note this is the integer ID (not a FK relation) so the record is kept even if the trigger itself is deleted.
data.labels[][chat][ticket][logs][][escalation_id]	integer	*	If the change was caused by an escalation Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.labels[][chat][ticket][logs][][macro_id]	integer	*	If the change was caused by an v2 macro Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.labels[][chat][ticket][logs][][sla]	object (Sla)	*	If the change was caused by an SLA, the SLA.
data.labels[][chat][ticket][logs][][sla][id]	integer	*	The unique ID.
data.labels[][chat][ticket][logs][][sla][title]	string	*	SLA title.
data.labels[][chat][ticket][logs][][sla][sla_type]	string	*	Type of SLA - first_response, resolution, waiting_time.
data.labels[][chat][ticket][logs][][sla][active_time]	string	*	Whether active all the time (all) or during work hours only (work_hours) or use the default ticket-wide settings (default).
data.labels[][chat][ticket][logs][][sla][work_start]	integer	*	When the work day starts. This is stored as the number of seconds after 00:00:00.
data.labels[][chat][ticket][logs][][sla][work_end]	integer	*	When the work day ends. This is stored as the number of seconds after 00:00:00.
data.labels[][chat][ticket][logs][][sla][work_days]	array	*	Array of work days, stored with keys corresponding to day numbers. Values are true. 0 = Sunday, 6 = Saturday (same as PHP, easy to convert to MySQL which is 1 = Sunday, 7 = Saturday).
data.labels[][chat][ticket][logs][][sla][work_timezone]	string	*	Timezone for work hours/days to be considered in.
data.labels[][chat][ticket][logs][][sla][work_holidays]	array	*	List of work holidays.
data.labels[][chat][ticket][logs][][sla][apply_type]	string	*	Controls how the SLA is applied to tickets: all, terms, terms_before_triggers, manual.
data.labels[][chat][ticket][logs][][sla][apply_terms]	object (TriggerTerms)	*	Conditions to apply.
data.labels[][chat][ticket][logs][][sla][apply_terms][version]	integer	*	Terms version.
data.labels[][chat][ticket][logs][][sla][apply_terms][terms]	array	*	Terms themselves.
data.labels[][chat][ticket][logs][][sla][trigger_terms]	object (TriggerTerms)	*	Conditions to consider sla completed.
data.labels[][chat][ticket][logs][][sla][warn_time]	integer	*	Warn time integer.
data.labels[][chat][ticket][logs][][sla][warn_time_unit]	string	*	And it's unit (see warn time).
data.labels[][chat][ticket][logs][][sla][warn_actions]	object (TriggerActions)	*	How to warn about SLA will fail.
data.labels[][chat][ticket][logs][][sla][warn_actions][version]	integer	*	Actions version.
data.labels[][chat][ticket][logs][][sla][warn_actions][actions]	array	*	Actions array representation.
data.labels[][chat][ticket][logs][][sla][fail_time]	integer	*	Fail time integer.
data.labels[][chat][ticket][logs][][sla][fail_time_unit]	string	*	And it's measuring unit (see fail_time).
data.labels[][chat][ticket][logs][][sla][fail_actions]	object (TriggerActions)	*	What to do if SLA failed.
data.labels[][chat][ticket][logs][][sla][exclude_ticket_statuses]	array	*	This SLA will not apply while tickets are in these pending statuses.
data.labels[][chat][ticket][logs][][sla_status]	string	*
data.labels[][chat][ticket][logs][][details]	array	*
data.labels[][chat][ticket][logs][][date_created]	DateTime	*
data.labels[][chat][ticket][chats][]	array of objects (ChatConversation)	*
data.labels[][chat][ticket][created_with_channel]	string	*
data.labels[][chat][ticket][last_channel_used]	string	*
data.labels[][chat][ticket][channels]	array	*
data.labels[][chat][ticket][pending_articles][]	array of objects (ArticlePendingCreate)	*
data.labels[][chat][ticket][pending_articles][][id]	integer	*
data.labels[][chat][ticket][pending_articles][][person]	integer id (Person)	*
data.labels[][chat][ticket][pending_articles][][assigned_person]	integer id (Person)	*
data.labels[][chat][ticket][pending_articles][][ticket]	integer id (Ticket)	*
data.labels[][chat][ticket][pending_articles][][message]	integer id (TicketMessage)	*
data.labels[][chat][ticket][pending_articles][][comment]	string	*
data.labels[][chat][ticket][pending_articles][][date_created]	DateTime	*
data.labels[][chat][ticket][summary]	object (TicketSummary)	*
data.labels[][chat][ticket][summary][id]	integer	*
data.labels[][chat][ticket][summary][ticket]	object (Ticket)	*
data.labels[][chat][ticket][summary][summary]	string	*
data.labels[][chat][ticket][summary][summary_input]	string	*
data.labels[][chat][ticket][summary][date_created]	DateTime	*
data.labels[][chat][labels][]	array of objects (LabelChatConversation)	*
data.labels[][chat][subject]	string	*	Subject of the chat conversation.
data.labels[][chat][status]	string	*	Status of the chat conversation.
data.labels[][chat][agent]	object (Person)	*	If this is a user conversation, this is the agent assigned.
data.labels[][chat][agent][emails]		*
data.labels[][chat][agent][labels]		*
data.labels[][chat][agent][teams]		*
data.labels[][chat][agent][primary_team]		*
data.labels[][chat][agent][agentData]		*
data.labels[][chat][agent][publicUsergroups]		*
data.labels[][chat][agent][publicAgentgroups]		*
data.labels[][chat][agent_team]	object (AgentTeam)	*	If this is a team chat, the team it is.
data.labels[][chat][agent_team][id]	integer	*	The unique ID.
data.labels[][chat][agent_team][name]	string	*	The name of agent team.
data.labels[][chat][agent_team][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.labels[][chat][agent_team][members]		*
data.labels[][chat][person]	object (Person)	*	If this is a user conversation, this is the user who started the chat.
data.labels[][chat][session]	object (Session)	*	If this is a user convo, this is the users session.
data.labels[][chat][session][id]	integer	*	The unique ID.
data.labels[][chat][session][auth]	string	*	The authcode for the session to verify an id.
data.labels[][chat][session][interface]	string	*	The Interface the session is for.
data.labels[][chat][session][person]	object (Person)	*
data.labels[][chat][session][user_agent]	string	*	The users user agent string.
data.labels[][chat][session][visitor_id]	string	*
data.labels[][chat][session][ip_address]	string	*	The users IP address.
data.labels[][chat][session][data]	string	*
data.labels[][chat][session][is_person]	boolean	*
data.labels[][chat][session][is_bot]	boolean	*
data.labels[][chat][session][is_helpdesk]	boolean	*
data.labels[][chat][session][active_status]	string	*	(Agents) Status (available or away).
data.labels[][chat][session][is_chat_available]	boolean	*	(Agents) Wehn status is available, if they are available for chat.
data.labels[][chat][session][date_created]	DateTime	*
data.labels[][chat][session][date_last]	DateTime	*
data.labels[][chat][session][date_last_page]	DateTime	*
data.labels[][chat][visitor_id]	string	*
data.labels[][chat][person_name]	string	*	User chat: The users name, if they arent a person.
data.labels[][chat][person_email]	string	*	User chat: The users email, if they aren`t a person.
data.labels[][chat][participants][]	array of objects (Person)	*
data.labels[][chat][messages][]	array of objects (ChatMessage)	*
data.labels[][chat][messages][][id]	integer	*	The unique ID.
data.labels[][chat][messages][][author_id]	integer	*	Author id (legacy).
data.labels[][chat][messages][][author_type]	string	*	Author type (legacy).
data.labels[][chat][messages][][conversation_id]	integer	*	Conversation id (legacy).
data.labels[][chat][messages][][author]	integer id (Person)	*	Person who created the message.
data.labels[][chat][messages][][content]	string	*	The message.
data.labels[][chat][messages][][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.labels[][chat][messages][][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.labels[][chat][messages][][is_html]	boolean	*	Is the content an HTML message?
data.labels[][chat][messages][][metadata]	array	*	Additional data.
data.labels[][chat][messages][][date_created]	DateTime	*	Date message was created.
data.labels[][chat][messages][][date_received]	DateTime	*	Date message was received.
data.labels[][chat][custom_data][]	array of objects (CustomDataChat)	*
data.labels[][chat][custom_data][][conversation]	object (ChatConversation)	*	The conversation the message belongs to.
data.labels[][chat][custom_data][][field]	object (CustomDefChat)	*
data.labels[][chat][custom_data][][field][parent]	object (CustomDefChat)	*
data.labels[][chat][custom_data][][field][children][]	array of objects (CustomDefChat)	*	Field children.
data.labels[][chat][custom_data][][field][title]		*
data.labels[][chat][custom_data][][root_field]	object (CustomDefChat)	*
data.labels[][chat][rating_response_time]	integer	*
data.labels[][chat][rating_overall]	integer	*
data.labels[][chat][rating_comment]	string	*
data.labels[][chat][is_agent]	boolean	*	Is this an agent chat.
data.labels[][chat][is_window]	boolean	*	If the chat is popped out into a window. This is used to make sure the JS widget on pages doesn't load again.
data.labels[][chat][date_created]	DateTime	*	Date when chat was started.
data.labels[][chat][date_user_waiting]	DateTime	*	Since when the user has started waiting (i.e., time the assignment was 0).
data.labels[][chat][date_assigned]	DateTime	*
data.labels[][chat][date_agent_typing]	DateTime	*	Date when agent typed last time.
data.labels[][chat][date_first_agent_message]	DateTime	*
data.labels[][chat][date_ended]	DateTime	*	Date when chat was ended.
data.labels[][chat][total_to_ended]	integer	*
data.labels[][chat][ended_by]	string	*	Who ended the chat.
data.labels[][chat][should_send_transcript]	boolean	*	True if transcript should be send.
data.labels[][chat][date_transcript_sent]	DateTime	*	Date when transcript was sent.
data.labels[][chat][email_validation_code]	string	*
data.labels[][chat][email_validated]	boolean	*
data.labels[][chat][access_token]	string	*
data.labels[][label]		*
data.ended_by	string	*	Who ended the chat.
data.id	integer	*	The unique id of chat conversation.
data.brand	object (Brand)	*	Department which chat was assigned.
data.brand[id]	integer	*	The unique ID.
data.brand[name]	string	*	The brand name.
data.brand[slug]	string	*
data.brand[url]	string	*	The brand url.
data.brand[theme_set]	object (ThemeSet)	*
data.brand[theme_set][id]	integer	*
data.brand[theme_set][theme_id]	string	*
data.brand[theme_set][title]	string	*
data.brand[theme_set][options]		*
data.brand[edit_theme_set]	object (ThemeSet)	*
data.brand[departments][]	array of objects (Department)	*
data.brand[theme_sets][]	array of objects (ThemeSet)	*
data.task_id	integer	*
data.ticket	object (Ticket)	*
data.ticket[id]	integer	*
data.ticket[ref]	string	*
data.ticket[auth]	string	*
data.ticket[parent_ticket]	object (Ticket)	*	Parent ticket.
data.ticket[children_tickets][]	array of objects (Ticket)	*
data.ticket[language]	object (Language)	*	The language the ticket is in.
data.ticket[language][id]	integer	*	The unique ID.
data.ticket[language][sys_name]	string	*	The unique sys name assigned to the language.
data.ticket[language][title]	string	*	Title of the language.
data.ticket[language][title_local]	string	*	Title of the language.
data.ticket[language][base_filepath]	string	*	The base filepath for default phrases for this lang.
data.ticket[language][locale]	string	*	The locale code.
data.ticket[language][flag_image]	string	*	String path to image.
data.ticket[language][is_rtl]	boolean	*	True if this is a right-to-left language.
data.ticket[language][has_user]	boolean	*	True if has user.
data.ticket[language][has_agent]	boolean	*	True if has agent.
data.ticket[language][has_admin]	boolean	*	True if has admin.
data.ticket[language][plural_categories][]	array of strings	*
data.ticket[language][plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data.ticket[language][flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`
data.ticket[brand]	object (Brand)	*
data.ticket[department]	object (Department)	*
data.ticket[category]	object (TicketCategory)	*
data.ticket[category][id]	integer	*	The unique ID.
data.ticket[category][parent]	integer id (TicketCategory)	*	This category parent.
data.ticket[category][title]	string	*	Category title.
data.ticket[category][display_order]	integer	*	Obviously it's display order for lists.
data.ticket[priority]	object (TicketPriority)	*
data.ticket[priority][id]	integer	*	The unique ID.
data.ticket[priority][title]	string	*	Priority title.
data.ticket[priority][priority]	integer	*	The priority itself.
data.ticket[workflow]	object (TicketWorkflow)	*
data.ticket[workflow][id]	integer	*	The unique ID.
data.ticket[workflow][title]	string	*	Workflow title.
data.ticket[workflow][display_order]	integer	*	Workflow display order.
data.ticket[product]	object (Product)	*
data.ticket[product][parent]	integer id (Product)	*	Parent of the product.
data.ticket[product][title]		*
data.ticket[person]	object (Person)	*
data.ticket[person_email]	object (PersonEmail)	*
data.ticket[person_email][id]	integer	*	The unique ID.
data.ticket[person_email][person]	integer id (Person)	*	Person owner of email.
data.ticket[person_email][email]	string	*	The email address.
data.ticket[person_email][email_domain]	string	*	The email address domain.
data.ticket[person_email][is_validated]	boolean	*	True if validation passed.
data.ticket[person_email][date_created]	DateTime	*	The original time the email was created.
data.ticket[agent]	object (Person)	*
data.ticket[agent_team]	object (AgentTeam)	*
data.ticket[agent_team][id]	integer	*	The unique ID.
data.ticket[agent_team][name]	string	*	The name of agent team.
data.ticket[agent_team][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.ticket[agent_team][members]		*
data.ticket[organization]	object (Organization)	*
data.ticket[organization][id]	integer	*	The unique ID.
data.ticket[organization][picture_blob]	object (Blob)	*	The org picture.
data.ticket[organization][picture_blob][sys_name]	string	*	A unique system name for the blob.
data.ticket[organization][picture_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[organization][picture_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[organization][picture_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[organization][picture_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[organization][picture_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[organization][picture_blob][file_url]	string	*	The HTTP link to download the file.
data.ticket[organization][picture_blob][authcode]	string	*
data.ticket[organization][picture_blob][blob_hash]	string	*
data.ticket[organization][picture_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[organization][picture_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[organization][picture_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[organization][picture_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[organization][picture_blob][date_created]	DateTime	*
data.ticket[organization][picture_blob][is_temp]	boolean	*
data.ticket[organization][picture_blob][source_ref]	string	*
data.ticket[organization][picture_blob][labels][]	array of objects (LabelBlob)	*
data.ticket[organization][picture_blob][labels][][blob]	object (Blob)	*
data.ticket[organization][icon_property]	object (IconProperty)	*
data.ticket[organization][icon_property][urn]	string	*
data.ticket[organization][icon_property][options]	array	*
data.ticket[organization][name]	string	*	The organization name.
data.ticket[organization][summary]	string	*	The summary field as filled in by agents.
data.ticket[organization][importance]	integer	*	The org importance.
data.ticket[organization][custom_data][]	array of objects (CustomDataOrganization)	*
data.ticket[organization][custom_data][][organization]	object (Organization)	*
data.ticket[organization][custom_data][][field]	object (CustomDefOrganization)	*
data.ticket[organization][custom_data][][field][parent]	object (CustomDefOrganization)	*	Field`s parent.
data.ticket[organization][custom_data][][field][children][]	array of objects (CustomDefOrganization)	*	Field children.
data.ticket[organization][custom_data][][field][title]		*
data.ticket[organization][custom_data][][root_field]	object (CustomDefOrganization)	*
data.ticket[organization][usergroups][]	array of objects (Usergroup)	*	Usergroups the user belongs to.
data.ticket[organization][usergroups][][id]	integer	*	The unique ID, DB-generated.
data.ticket[organization][usergroups][][title]	string	*	Title of the usergroup.
data.ticket[organization][usergroups][][note]	string	*	A note or description about the usergroup.
data.ticket[organization][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.ticket[organization][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.ticket[organization][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.ticket[organization][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.ticket[organization][usergroups][][permissions][][id]	integer	*	The unique ID.
data.ticket[organization][usergroups][][permissions][][name]	string	*	The name of the permission.
data.ticket[organization][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.ticket[organization][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.ticket[organization][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.ticket[organization][usergroups][][department_permissions][][department]	integer id (Department)	*
data.ticket[organization][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.ticket[organization][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.ticket[organization][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.ticket[organization][usergroups][][department_permissions][][is_active]	boolean	*
data.ticket[organization][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.ticket[organization][auto_cc_people][]	array of objects (Person)	*	Users who are set to automatically be added to tickets and other org things.
data.ticket[organization][labels][]	array of objects (LabelOrganization)	*
data.ticket[organization][labels][][organization]	object (Organization)	*
data.ticket[organization][contact_data][]	array of objects (OrganizationContactData)	*
data.ticket[organization][contact_data][][organization]		*
data.ticket[organization][contact_data][][contact_type]		*
data.ticket[organization][contact_data][][comment]		*
data.ticket[organization][contact_data][][field_1]		*
data.ticket[organization][contact_data][][field_2]		*
data.ticket[organization][contact_data][][field_3]		*
data.ticket[organization][contact_data][][field_5]		*
data.ticket[organization][contact_data][][field_9]		*
data.ticket[organization][emails][]	array of objects (OrganizationEmail)	*
data.ticket[organization][emails][][id]	integer	*	The unique log id.
data.ticket[organization][emails][][organization]	object (Organization)	*
data.ticket[organization][emails][][email]	string	*
data.ticket[organization][emails][][date_created]	DateTime	*
data.ticket[organization][email_domains][]	array of objects (OrganizationEmailDomain)	*
data.ticket[organization][email_domains][][domain]	string	*	The email domain.
data.ticket[organization][email_domains][][organization]	object (Organization)	*	The users organization.
data.ticket[organization][date_created]	DateTime	*	The date the org was inserted into the system.
data.ticket[organization][members][]	array of objects (Person)	*
data.ticket[organization][parent]	object (Organization)	*
data.ticket[organization][children][]	array of objects (Organization)	*
data.ticket[organization][tickets][]	array of objects (Ticket)	*
data.ticket[organization][organization_members][]	array of objects (OrganizationMember)	*
data.ticket[organization][organization_members][][id]	integer	*
data.ticket[organization][organization_members][][person]	integer id (Person)	*
data.ticket[organization][organization_members][][organization]	integer id (Organization)	*
data.ticket[organization][organization_members][][is_manager]	boolean	*
data.ticket[organization][organization_members][][position]	string	*
data.ticket[organization][organization_members][][created_at]	DateTime	*
data.ticket[organization][organization_members][][updated_at]	DateTime	*
data.ticket[organization][publicUsergroups]		*
data.ticket[linked_chat]	object (ChatConversation)	*
data.ticket[linked_chat][id]	integer	*	The unique id of chat conversation.
data.ticket[linked_chat][department]	object (Department)	*	Department which chat was assigned.
data.ticket[linked_chat][brand]	object (Brand)	*	Department which chat was assigned.
data.ticket[linked_chat][task_id]	integer	*
data.ticket[linked_chat][ticket]	object (Ticket)	*
data.ticket[linked_chat][labels][]	array of objects (LabelChatConversation)	*
data.ticket[linked_chat][labels][][chat]	object (ChatConversation)	*
data.ticket[linked_chat][subject]	string	*	Subject of the chat conversation.
data.ticket[linked_chat][status]	string	*	Status of the chat conversation.
data.ticket[linked_chat][agent]	object (Person)	*	If this is a user conversation, this is the agent assigned.
data.ticket[linked_chat][agent_team]	object (AgentTeam)	*	If this is a team chat, the team it is.
data.ticket[linked_chat][person]	object (Person)	*	If this is a user conversation, this is the user who started the chat.
data.ticket[linked_chat][session]	object (Session)	*	If this is a user convo, this is the users session.
data.ticket[linked_chat][session][id]	integer	*	The unique ID.
data.ticket[linked_chat][session][auth]	string	*	The authcode for the session to verify an id.
data.ticket[linked_chat][session][interface]	string	*	The Interface the session is for.
data.ticket[linked_chat][session][person]	object (Person)	*
data.ticket[linked_chat][session][user_agent]	string	*	The users user agent string.
data.ticket[linked_chat][session][visitor_id]	string	*
data.ticket[linked_chat][session][ip_address]	string	*	The users IP address.
data.ticket[linked_chat][session][data]	string	*
data.ticket[linked_chat][session][is_person]	boolean	*
data.ticket[linked_chat][session][is_bot]	boolean	*
data.ticket[linked_chat][session][is_helpdesk]	boolean	*
data.ticket[linked_chat][session][active_status]	string	*	(Agents) Status (available or away).
data.ticket[linked_chat][session][is_chat_available]	boolean	*	(Agents) Wehn status is available, if they are available for chat.
data.ticket[linked_chat][session][date_created]	DateTime	*
data.ticket[linked_chat][session][date_last]	DateTime	*
data.ticket[linked_chat][session][date_last_page]	DateTime	*
data.ticket[linked_chat][visitor_id]	string	*
data.ticket[linked_chat][person_name]	string	*	User chat: The users name, if they arent a person.
data.ticket[linked_chat][person_email]	string	*	User chat: The users email, if they aren`t a person.
data.ticket[linked_chat][participants][]	array of objects (Person)	*
data.ticket[linked_chat][messages][]	array of objects (ChatMessage)	*
data.ticket[linked_chat][messages][][id]	integer	*	The unique ID.
data.ticket[linked_chat][messages][][author_id]	integer	*	Author id (legacy).
data.ticket[linked_chat][messages][][author_type]	string	*	Author type (legacy).
data.ticket[linked_chat][messages][][conversation_id]	integer	*	Conversation id (legacy).
data.ticket[linked_chat][messages][][author]	integer id (Person)	*	Person who created the message.
data.ticket[linked_chat][messages][][content]	string	*	The message.
data.ticket[linked_chat][messages][][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.ticket[linked_chat][messages][][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.ticket[linked_chat][messages][][is_html]	boolean	*	Is the content an HTML message?
data.ticket[linked_chat][messages][][metadata]	array	*	Additional data.
data.ticket[linked_chat][messages][][date_created]	DateTime	*	Date message was created.
data.ticket[linked_chat][messages][][date_received]	DateTime	*	Date message was received.
data.ticket[linked_chat][custom_data][]	array of objects (CustomDataChat)	*
data.ticket[linked_chat][custom_data][][conversation]	object (ChatConversation)	*	The conversation the message belongs to.
data.ticket[linked_chat][custom_data][][field]	object (CustomDefChat)	*
data.ticket[linked_chat][custom_data][][field][parent]	object (CustomDefChat)	*
data.ticket[linked_chat][custom_data][][field][children][]	array of objects (CustomDefChat)	*	Field children.
data.ticket[linked_chat][custom_data][][field][title]		*
data.ticket[linked_chat][custom_data][][root_field]	object (CustomDefChat)	*
data.ticket[linked_chat][rating_response_time]	integer	*
data.ticket[linked_chat][rating_overall]	integer	*
data.ticket[linked_chat][rating_comment]	string	*
data.ticket[linked_chat][is_agent]	boolean	*	Is this an agent chat.
data.ticket[linked_chat][is_window]	boolean	*	If the chat is popped out into a window. This is used to make sure the JS widget on pages doesn't load again.
data.ticket[linked_chat][date_created]	DateTime	*	Date when chat was started.
data.ticket[linked_chat][date_user_waiting]	DateTime	*	Since when the user has started waiting (i.e., time the assignment was 0).
data.ticket[linked_chat][date_assigned]	DateTime	*
data.ticket[linked_chat][date_agent_typing]	DateTime	*	Date when agent typed last time.
data.ticket[linked_chat][date_first_agent_message]	DateTime	*
data.ticket[linked_chat][date_ended]	DateTime	*	Date when chat was ended.
data.ticket[linked_chat][total_to_ended]	integer	*
data.ticket[linked_chat][ended_by]	string	*	Who ended the chat.
data.ticket[linked_chat][should_send_transcript]	boolean	*	True if transcript should be send.
data.ticket[linked_chat][date_transcript_sent]	DateTime	*	Date when transcript was sent.
data.ticket[linked_chat][email_validation_code]	string	*
data.ticket[linked_chat][email_validated]	boolean	*
data.ticket[linked_chat][access_token]	string	*
data.ticket[attachments][]	array of objects (TicketAttachment)	*
data.ticket[attachments][][id]	integer	*	The unique ID.
data.ticket[attachments][][ticket]	integer id (Ticket)	*	Ticket this attachment belongs to.
data.ticket[attachments][][person]	integer id (Person)	*	Who created the attachment.
data.ticket[attachments][][blob]	object (Blob)	*	Actual attachment.
data.ticket[attachments][][blob][sys_name]	string	*	A unique system name for the blob.
data.ticket[attachments][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[attachments][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[attachments][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[attachments][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[attachments][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[attachments][][blob][file_url]	string	*	The HTTP link to download the file.
data.ticket[attachments][][blob][authcode]	string	*
data.ticket[attachments][][blob][blob_hash]	string	*
data.ticket[attachments][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[attachments][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[attachments][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[attachments][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[attachments][][blob][date_created]	DateTime	*
data.ticket[attachments][][blob][is_temp]	boolean	*
data.ticket[attachments][][blob][source_ref]	string	*
data.ticket[attachments][][blob][labels][]	array of objects (LabelBlob)	*
data.ticket[attachments][][blob][labels][][blob]	object (Blob)	*
data.ticket[attachments][][message]	integer id (TicketMessage)	*	Message - holder of this attachment.
data.ticket[attachments][][is_agent_note]	boolean	*	True if this attachmen just a note.
data.ticket[attachments][][is_inline]	boolean	*	Is this attachment is embed in message.
data.ticket[access_codes][]	array of objects (TicketAccessCode)	*
data.ticket[access_codes][][id]	integer	*
data.ticket[access_codes][][ticket]	object (Ticket)	*
data.ticket[access_codes][][person]	object (Person)	*
data.ticket[access_codes][][auth]	string	*
data.ticket[messages][]	array of objects (TicketMessage)	*
data.ticket[messages][][id]	integer	*	The unique id of message.
data.ticket[messages][][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data.ticket[messages][][person]	object (Person)	*	Person this message was sent by.
data.ticket[messages][][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data.ticket[messages][][email_source][id]	integer	*
data.ticket[messages][][email_source][uuid]	string	*
data.ticket[messages][][email_source][blob]	object (Blob)	*
data.ticket[messages][][email_source][blob][sys_name]	string	*	A unique system name for the blob.
data.ticket[messages][][email_source][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[messages][][email_source][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[messages][][email_source][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[messages][][email_source][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[messages][][email_source][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[messages][][email_source][blob][file_url]	string	*	The HTTP link to download the file.
data.ticket[messages][][email_source][blob][authcode]	string	*
data.ticket[messages][][email_source][blob][blob_hash]	string	*
data.ticket[messages][][email_source][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[messages][][email_source][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[messages][][email_source][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[messages][][email_source][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[messages][][email_source][blob][date_created]	DateTime	*
data.ticket[messages][][email_source][blob][is_temp]	boolean	*
data.ticket[messages][][email_source][blob][source_ref]	string	*
data.ticket[messages][][email_source][blob][labels][]	array of objects (LabelBlob)	*
data.ticket[messages][][email_source][blob][labels][][blob]	object (Blob)	*
data.ticket[messages][][email_source][object_type]	string	*	The type of object this is attached to (should be the table name of the super type, eg: tickets, people, organizations). This typically is not set until after the email is processed (ie the status is 'processed').
data.ticket[messages][][email_source][object_id]	integer	*	The ID of the object this is attached to.
data.ticket[messages][][email_source][from_email]	string	*
data.ticket[messages][][email_source][status]	string	*	The current status of the message: - inserted: Only inserted - processing: Currently processing - complete: Fully processed - error: Tried to process but there was some kind of error (see error_code).
data.ticket[messages][][email_source][date_status]	DateTime	*
data.ticket[messages][][email_source][error_code]	string	*	When status is error, this is the code that describes the error.
data.ticket[messages][][email_source][date_created]	DateTime	*
data.ticket[messages][][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.ticket[messages][][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.ticket[messages][][snippet_use_logs][][id]	integer	*	The unique ID.
data.ticket[messages][][snippet_use_logs][][snippet]	object (SnippetV2)	*	Snippet used.
data.ticket[messages][][snippet_use_logs][][snippet][id]	integer	*
data.ticket[messages][][snippet_use_logs][][snippet][title]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][author]	object (Person)	*
data.ticket[messages][][snippet_use_logs][][snippet][is_private]	boolean	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar]	object (Blob)	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][sys_name]	string	*	A unique system name for the blob.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][file_url]	string	*	The HTTP link to download the file.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][authcode]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][blob_hash]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][date_created]	DateTime	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][is_temp]	boolean	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][source_ref]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][labels][]	array of objects (LabelBlob)	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][labels][][blob]	object (Blob)	*
data.ticket[messages][][snippet_use_logs][][snippet][status]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][shortcut_codes]	array	*
data.ticket[messages][][snippet_use_logs][][snippet][inline_translations]	array	*
data.ticket[messages][][snippet_use_logs][][snippet][translations][]	array of objects (SnippetV2Translation)	*
data.ticket[messages][][snippet_use_logs][][snippet][translations][][id]	integer	*	The unique ID.
data.ticket[messages][][snippet_use_logs][][snippet][translations][][snippet]	object (SnippetV2)	*	Snippet translated.
data.ticket[messages][][snippet_use_logs][][snippet][translations][][language]	object (Language)	*
data.ticket[messages][][snippet_use_logs][][snippet][translations][][content]	array	*	Snippet content.
data.ticket[messages][][snippet_use_logs][][snippet][translations][][blobs][]	array of objects (Blob)	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][]	array of objects (SnippetV2Category)	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][id]	integer	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][title]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][is_global]	boolean	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][display_order]	integer	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][parent]	object (SnippetV2Category)	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][agent_teams][]	array of objects (AgentTeam)	*
data.ticket[messages][][snippet_use_logs][][snippet][display_order]	integer	*
data.ticket[messages][][snippet_use_logs][][snippet][date_created]	DateTime	*
data.ticket[messages][][snippet_use_logs][][ticket_message]	object (TicketMessage)	*	Ticket Message where the snippet was used.
data.ticket[messages][][snippet_use_logs][][chat_message]	object (ChatMessage)	*	Chat Message where the snippet was used.
data.ticket[messages][][snippet_use_logs][][chat_message][id]	integer	*	The unique ID.
data.ticket[messages][][snippet_use_logs][][chat_message][author_id]	integer	*	Author id (legacy).
data.ticket[messages][][snippet_use_logs][][chat_message][author_type]	string	*	Author type (legacy).
data.ticket[messages][][snippet_use_logs][][chat_message][conversation_id]	integer	*	Conversation id (legacy).
data.ticket[messages][][snippet_use_logs][][chat_message][author]	integer id (Person)	*	Person who created the message.
data.ticket[messages][][snippet_use_logs][][chat_message][content]	string	*	The message.
data.ticket[messages][][snippet_use_logs][][chat_message][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.ticket[messages][][snippet_use_logs][][chat_message][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.ticket[messages][][snippet_use_logs][][chat_message][is_html]	boolean	*	Is the content an HTML message?
data.ticket[messages][][snippet_use_logs][][chat_message][metadata]	array	*	Additional data.
data.ticket[messages][][snippet_use_logs][][chat_message][date_created]	DateTime	*	Date message was created.
data.ticket[messages][][snippet_use_logs][][chat_message][date_received]	DateTime	*	Date message was received.
data.ticket[messages][][snippet_use_logs][][language]	object (Language)	*	Snippet translated.
data.ticket[messages][][snippet_use_logs][][person]	object (Person)	*
data.ticket[messages][][snippet_use_logs][][rating]	integer	*
data.ticket[messages][][snippet_use_logs][][rating_person]	object (Person)	*
data.ticket[messages][][snippet_use_logs][][rating_message]	string	*
data.ticket[messages][][snippet_use_logs][][date_created]	DateTime	*
data.ticket[messages][][date_created]	DateTime	*	Date when message was created.
data.ticket[messages][][is_agent_note]	boolean	*	Is this message agent note?
data.ticket[messages][][is_hidden]	boolean	*	Is this message hidden?
data.ticket[messages][][creation_system]	string	*	How this message was created.
data.ticket[messages][][ip_address]	string	*	An ip address from which message was sent.
data.ticket[messages][][visitor_id]	string	*	Unique ID of visitor left this message.
data.ticket[messages][][hostname]	string	*	Host from which message was left.
data.ticket[messages][][geo_country]	string	*	Country message is from (deprecated).
data.ticket[messages][][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.ticket[messages][][message_hash]	string	*	An unique hash of message.
data.ticket[messages][][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.ticket[messages][][primary_translation][id]	integer	*
data.ticket[messages][][primary_translation][ticket]	object (Ticket)	*
data.ticket[messages][][primary_translation][ticket_message]	object (TicketMessage)	*
data.ticket[messages][][primary_translation][from_lang_code]	string	*
data.ticket[messages][][primary_translation][lang_code]	string	*
data.ticket[messages][][primary_translation][message]	string	*
data.ticket[messages][][primary_translation][date_created]	DateTime	*
data.ticket[messages][][message]	string	*	The message, will be in HTML!
data.ticket[messages][][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.ticket[messages][][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.ticket[messages][][message_source]	string	*	The message source.
data.ticket[messages][][message_source_type]	string	*	The message source type.
data.ticket[messages][][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.ticket[messages][][lang_code]	string	*	The set/detected lang code.
data.ticket[messages][][email_message_id][]	array of objects (TicketMessageEmailId)	*
data.ticket[messages][][email_message_id][][id]	integer	*
data.ticket[messages][][email_message_id][][message]	object (TicketMessage)	*
data.ticket[messages][][email_message_id][][email_id]	string	*
data.ticket[messages][][ticket_feedback][]	array of objects (TicketFeedback)	*
data.ticket[messages][][ticket_feedback][][id]	integer	*
data.ticket[messages][][ticket_feedback][][ticket]	object (Ticket)	*
data.ticket[messages][][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data.ticket[messages][][ticket_feedback][][person]	object (Person)	*
data.ticket[messages][][ticket_feedback][][rating]	integer	*
data.ticket[messages][][ticket_feedback][][message]	string	*
data.ticket[messages][][ticket_feedback][][date_created]	DateTime	*
data.ticket[messages][][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data.ticket[messages][][ticket_message_forwards][][id]	integer	*
data.ticket[messages][][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data.ticket[messages][][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data.ticket[messages][][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data.ticket[messages][][ticket_message_forwards][][subject]	string	*
data.ticket[messages][][ticket_message_forwards][][from_email]	string	*
data.ticket[messages][][ticket_message_forwards][][tos]	array	*
data.ticket[messages][][ticket_message_forwards][][ccs]	array	*
data.ticket[messages][][ticket_message_forwards][][bccs]	array	*
data.ticket[messages][][ticket_message_forwards][][message]	string	*
data.ticket[messages][][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data.ticket[messages][][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data.ticket[messages][][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[messages][][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[messages][][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[messages][][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[messages][][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[messages][][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data.ticket[messages][][ticket_message_forwards][][blobs][][authcode]	string	*
data.ticket[messages][][ticket_message_forwards][][blobs][][blob_hash]	string	*
data.ticket[messages][][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[messages][][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[messages][][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[messages][][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[messages][][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data.ticket[messages][][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data.ticket[messages][][ticket_message_forwards][][blobs][][source_ref]	string	*
data.ticket[messages][][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data.ticket[messages][][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data.ticket[messages][][ticket_message_forwards][][date_created]	DateTime	*
data.ticket[messages][][channel_message]	object (TicketMessageChannelMessage)	*
data.ticket[messages][][channel_message][id]	integer	*	@var int The unique id of message.
data.ticket[messages][][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data.ticket[messages][][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data.ticket[messages][][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data.ticket[messages][][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data.ticket[messages][][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data.ticket[messages][][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data.ticket[messages][][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data.ticket[messages][][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data.ticket[messages][][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data.ticket[sms_messages][]	array of objects (TicketSms)	*
data.ticket[sms_messages][][id]	integer	*
data.ticket[sms_messages][][ticket]	object (Ticket)	*
data.ticket[sms_messages][][person]	object (Person)	*
data.ticket[sms_messages][][sms_account]	object (SmsAccount)	*
data.ticket[sms_messages][][sms_account][id]	integer	*	The unique ID.
data.ticket[sms_messages][][sms_account][type]	string	*
data.ticket[sms_messages][][sms_account][params]	array	*
data.ticket[sms_messages][][sms_account][identifier]	string	*
data.ticket[sms_messages][][sms_account][is_enabled]	boolean	*
data.ticket[sms_messages][][sms_account][is_connected]	boolean	*
data.ticket[sms_messages][][sms_account][is_tested]	boolean	*
data.ticket[sms_messages][][sms_account][test_code]	string	*
data.ticket[sms_messages][][job]	object (Job)	*
data.ticket[sms_messages][][job][id]	integer	*	The unique job id.
data.ticket[sms_messages][][job][type]	string	*	The job type, used by the Job Router to find the right Job Processor.
data.ticket[sms_messages][][job][status]	string	*	The status of the job.
data.ticket[sms_messages][][job][status_code]	string	*	Any code to further classify the status.
data.ticket[sms_messages][][job][date_touch]	DateTime	*	Date the last time a process "touched" this ticket.
data.ticket[sms_messages][][job][date_created]	DateTime	*	Date this job entered the "jobs" table.
data.ticket[sms_messages][][job][date_last_try]	DateTime	*	Last time we processed this job.
data.ticket[sms_messages][][job][date_next_try]	DateTime	*	If this DateTime is in the future, it won't be selected for execution.
data.ticket[sms_messages][][job][num_tries]	integer	*	The number of times this job has been executed Job Processor (usually indicated failures if > 1).
data.ticket[sms_messages][][job][log_summary]	string	*	A human readable summary of the job's execution.
data.ticket[sms_messages][][job][log]	string	*	A more verbose log.
data.ticket[sms_messages][][job][data]	array	*	An array of data, or payload, that the job processor needs to execute this job (stored in the db as json). This MUST always be an array, even if its an empty array
data.ticket[sms_messages][][job][original_job]	integer	*	Null unless the job was created as a retry - if so, the originating job ID is stored here so we can query it later. Note: You MUST specify the originating job, do not create a linked list of failed jobs.
data.ticket[sms_messages][][date_created]	DateTime	*
data.ticket[sms_messages][][from_number]	string	*	Permanent record of the phone number that sent this SMS. (Won't change even if Person changes their phone number).
data.ticket[sms_messages][][to_number]	string	*	Permanent record of the phone number that this SMS was sent to.
data.ticket[sms_messages][][message]	string	*	The SMS message.
data.ticket[sms_messages][][direction]	string	*	Just a system flag for reporting.
data.ticket[topic_links][]	array of objects (TicketCommunityTopicLink)	*
data.ticket[topic_links][][id]	integer	*	The unique filter ID.
data.ticket[topic_links][][ticket]	integer id (Ticket)	*
data.ticket[topic_links][][topic]	integer id (CommunityTopic)	*
data.ticket[topic_links][][person]	integer id (Person)	*
data.ticket[topic_links][][date_created]	DateTime	*
data.ticket[custom_data][]	array of objects (CustomDataTicket)	*
data.ticket[custom_data][][ticket]	object (Ticket)	*
data.ticket[custom_data][][field]	object (CustomDefTicket)	*
data.ticket[custom_data][][field][parent]	object (CustomDefTicket)	*
data.ticket[custom_data][][field][children][]	array of objects (CustomDefTicket)	*	Field children.
data.ticket[custom_data][][field][title]		*
data.ticket[custom_data][][root_field]	object (CustomDefTicket)	*
data.ticket[labels][]	array of objects (LabelTicket)	*
data.ticket[labels][][ticket]	object (Ticket)	*
data.ticket[sent_to_address]	string	*	The email address the ticket was sent to if it came in via a gateway. This is a full string (e.g., including CC's) of the original.
data.ticket[email_account]	object (EmailAccount)	*	The gateway this ticket originated from.
data.ticket[email_account][id]	integer	*
data.ticket[email_account][account_type]	string	*
data.ticket[email_account][is_enabled]	boolean	*
data.ticket[email_account][address]	string	*
data.ticket[email_account][cert_blob]	object (Blob)	*
data.ticket[email_account][cert_blob][sys_name]	string	*	A unique system name for the blob.
data.ticket[email_account][cert_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[email_account][cert_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[email_account][cert_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[email_account][cert_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[email_account][cert_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[email_account][cert_blob][file_url]	string	*	The HTTP link to download the file.
data.ticket[email_account][cert_blob][authcode]	string	*
data.ticket[email_account][cert_blob][blob_hash]	string	*
data.ticket[email_account][cert_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[email_account][cert_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[email_account][cert_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[email_account][cert_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[email_account][cert_blob][date_created]	DateTime	*
data.ticket[email_account][cert_blob][is_temp]	boolean	*
data.ticket[email_account][cert_blob][source_ref]	string	*
data.ticket[email_account][cert_blob][labels][]	array of objects (LabelBlob)	*
data.ticket[email_account][cert_blob][labels][][blob]	object (Blob)	*
data.ticket[email_account][key_blob]	object (Blob)	*
data.ticket[email_account_address]	string	*	The email address (from list of to/cc) that matched with the email account.
data.ticket[creation_system]	string	*
data.ticket[creation_system_option]	string	*	Optional information about the creation system. For example, source URL the ticket came from.
data.ticket[ticket_hash]	string	*
data.ticket[status]	string	*
data.ticket[ticket_status]	object (TicketStatus)	*
data.ticket[ticket_status][id]	integer	*
data.ticket[ticket_status][status_type]	string	*
data.ticket[ticket_status][status_code]	string	*
data.ticket[ticket_status][sys_id]	string	*
data.ticket[ticket_status][title]	string	*
data.ticket[ticket_status][display_order]	integer	*
data.ticket[ticket_status][pending_waiting_time_mode]	string	*	Where to count time spending in pending status. Check PENDING_WAITING_TIME_MODE_ constants
data.ticket[ticket_status][children][]	array of objects (TicketStatus)	*
data.ticket[ticket_status][options]	array	*
data.ticket[ticket_status][statusType]		*
data.ticket[ticket_status][displayOrder]	integer	*
data.ticket[urgency]	integer	*
data.ticket[feedback_rating]	integer	*
data.ticket[date_feedback_rating]	DateTime	*
data.ticket[date_created]	DateTime	*
data.ticket[date_resolved]	DateTime	*
data.ticket[date_archived]	DateTime	*
data.ticket[date_first_agent_assign]	DateTime	*
data.ticket[date_first_agent_reply]	DateTime	*
data.ticket[date_last_agent_reply]	DateTime	*
data.ticket[date_last_user_reply]	DateTime	*
data.ticket[date_agent_waiting]	DateTime	*
data.ticket[date_user_waiting]	DateTime	*
data.ticket[date_status]	DateTime	*
data.ticket[date_on_hold]	DateTime	*
data.ticket[total_user_waiting]	integer	*
data.ticket[total_to_first_reply]	integer	*
data.ticket[total_user_waiting_wh_start]	DateTime	*
data.ticket[total_user_waiting_wh]	integer	*
data.ticket[total_to_first_reply_wh]	integer	*
data.ticket[locked_by_agent]	object (Person)	*
data.ticket[date_locked]	DateTime	*
data.ticket[has_attachments]	boolean	*
data.ticket[subject]	string	*
data.ticket[original_subject]	string	*
data.ticket[properties]	array	*
data.ticket[count_agent_replies]	integer	*
data.ticket[count_user_replies]	integer	*
data.ticket[worst_sla_status]	string	*
data.ticket[waiting_times]	array	*	Used to track ticket status changes and how much time ticket was in status Add new item every time status changed This is optimisation over TicketLog.
data.ticket[participants][]	array of objects (TicketParticipant)	*
data.ticket[participants][][id]	integer	*
data.ticket[participants][][ticket]	object (Ticket)	*
data.ticket[participants][][person]	object (Person)	*
data.ticket[participants][][access_code]	object (TicketAccessCode)	*
data.ticket[participants][][person_email]	object (PersonEmail)	*
data.ticket[participants][][default_on]	boolean	*	Default checkbox status of the user.
data.ticket[charges][]	array of objects (TicketCharge)	*
data.ticket[charges][][id]	integer	*
data.ticket[charges][][charge_time]	integer	*
data.ticket[charges][][amount]	float	*
data.ticket[charges][][date_created]	DateTime	*
data.ticket[charges][][ticket]	object (Ticket)	*
data.ticket[charges][][person]	object (Person)	*
data.ticket[charges][][organization]	object (Organization)	*
data.ticket[charges][][agent]	object (Person)	*
data.ticket[charges][][custom_data][]	array of objects (CustomDataBilling)	*
data.ticket[charges][][custom_data][][ticket_charge]	object (TicketCharge)	*
data.ticket[charges][][custom_data][][field]	object (CustomDefBilling)	*
data.ticket[charges][][custom_data][][field][parent]	object (CustomDefBilling)	*
data.ticket[charges][][custom_data][][field][children][]	array of objects (CustomDefBilling)	*	Field children.
data.ticket[charges][][custom_data][][field][title]		*
data.ticket[charges][][custom_data][][root_field]	object (CustomDefBilling)	*
data.ticket[ticket_slas][]	array of objects (TicketSla)	*
data.ticket[ticket_slas][][id]	integer	*	The unique ID.
data.ticket[ticket_slas][][sla_status]	string	*	The SLA status.
data.ticket[ticket_slas][][warn_date]	DateTime	*	The SLA warn date.
data.ticket[ticket_slas][][fail_date]	DateTime	*	The SLA fail date.
data.ticket[ticket_slas][][is_completed]	boolean	*	Is the SLA completed?
data.ticket[ticket_slas][][is_completed_set]	boolean	*	Completed by automated action.
data.ticket[ticket_slas][][completed_time_taken]	integer	*	Time taken.
data.ticket[ticket_slas][][ticket]	integer id (Ticket)	*	Ticket.
data.ticket[ticket_slas][][sla]	integer id (Sla)	*	SLA.
data.ticket[ticket_slas][][date_applied]	DateTime	*	time and date when SLA was applied to the ticket.
data.ticket[ticket_slas][][date_completed]	DateTime	*	time when SLA status became OK.
data.ticket[jira_issues][]	array of objects (JiraIssue)	*	linked jira issues.
data.ticket[jira_issues][][id]	integer	*	The unique ID.
data.ticket[jira_issues][][ticket]	object (Ticket)	*	The associated DeskPRO ticket.
data.ticket[jira_issues][][issue_id]	integer	*
data.ticket[jira_issues][][status_id]	integer	*
data.ticket[jira_issues][][created]	DateTime	*	Export time.
data.ticket[problems][]	array of objects (Problem)	*
data.ticket[problems][][id]	integer	*	The unique ID.
data.ticket[problems][][title]	string	*	Problem title.
data.ticket[problems][][creator]	integer id (Person)	*	Person who created the problem.
data.ticket[problems][][created]	DateTime	*	Date when the problem was created.
data.ticket[problems][][is_open]	boolean	*	Is problem still has no solution?
data.ticket[problems][][tickets][]	array of integer ids (Ticket)	*	Tickets associated with problem.
data.ticket[stars][]	array of objects (TicketFlagged)	*
data.ticket[stars][][ticket]	object (Ticket)	*
data.ticket[stars][][person_id]	integer	*
data.ticket[stars][][color]	string	*
data.ticket[follow_ups][]	array of objects (TicketFollowUp)	*
data.ticket[follow_ups][][id]	integer	*	The unique ID.
data.ticket[follow_ups][][person]	integer id (Person)	*
data.ticket[follow_ups][][actions]	array	*
data.ticket[follow_ups][][cancel_if_user_reply]	boolean	*
data.ticket[follow_ups][][cancel_if_agent_reply]	boolean	*
data.ticket[follow_ups][][status]	string	*
data.ticket[follow_ups][][date_created]	DateTime	*
data.ticket[follow_ups][][date_to_run]	DateTime	*
data.ticket[follow_ups][][date_did_run]	DateTime	*
data.ticket[follow_ups][][dateToRun]		*
data.ticket[logs][]	array of objects (TicketLog)	*
data.ticket[logs][][id]	integer	*
data.ticket[logs][][parent]	object (TicketLog)	*
data.ticket[logs][][ticket]	object (Ticket)	*
data.ticket[logs][][person]	object (Person)	*
data.ticket[logs][][action_type]	string	*
data.ticket[logs][][id_object]	integer	*	If the log involves a specific thing in a ticket (eg a message that was moved), then that is this id.
data.ticket[logs][][id_before]	integer	*	The ID of the previous entity changed, or any other numeric value.
data.ticket[logs][][id_after]	integer	*	The ID of the new entity, or any other numeric value.
data.ticket[logs][][trigger_id]	integer	*	If the change was caused by a trigger, the trigger id. Note this is the integer ID (not a FK relation) so the record is kept even if the trigger itself is deleted.
data.ticket[logs][][escalation_id]	integer	*	If the change was caused by an escalation Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.ticket[logs][][macro_id]	integer	*	If the change was caused by an v2 macro Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.ticket[logs][][sla]	object (Sla)	*	If the change was caused by an SLA, the SLA.
data.ticket[logs][][sla][id]	integer	*	The unique ID.
data.ticket[logs][][sla][title]	string	*	SLA title.
data.ticket[logs][][sla][sla_type]	string	*	Type of SLA - first_response, resolution, waiting_time.
data.ticket[logs][][sla][active_time]	string	*	Whether active all the time (all) or during work hours only (work_hours) or use the default ticket-wide settings (default).
data.ticket[logs][][sla][work_start]	integer	*	When the work day starts. This is stored as the number of seconds after 00:00:00.
data.ticket[logs][][sla][work_end]	integer	*	When the work day ends. This is stored as the number of seconds after 00:00:00.
data.ticket[logs][][sla][work_days]	array	*	Array of work days, stored with keys corresponding to day numbers. Values are true. 0 = Sunday, 6 = Saturday (same as PHP, easy to convert to MySQL which is 1 = Sunday, 7 = Saturday).
data.ticket[logs][][sla][work_timezone]	string	*	Timezone for work hours/days to be considered in.
data.ticket[logs][][sla][work_holidays]	array	*	List of work holidays.
data.ticket[logs][][sla][apply_type]	string	*	Controls how the SLA is applied to tickets: all, terms, terms_before_triggers, manual.
data.ticket[logs][][sla][apply_terms]	object (TriggerTerms)	*	Conditions to apply.
data.ticket[logs][][sla][apply_terms][version]	integer	*	Terms version.
data.ticket[logs][][sla][apply_terms][terms]	array	*	Terms themselves.
data.ticket[logs][][sla][trigger_terms]	object (TriggerTerms)	*	Conditions to consider sla completed.
data.ticket[logs][][sla][warn_time]	integer	*	Warn time integer.
data.ticket[logs][][sla][warn_time_unit]	string	*	And it's unit (see warn time).
data.ticket[logs][][sla][warn_actions]	object (TriggerActions)	*	How to warn about SLA will fail.
data.ticket[logs][][sla][warn_actions][version]	integer	*	Actions version.
data.ticket[logs][][sla][warn_actions][actions]	array	*	Actions array representation.
data.ticket[logs][][sla][fail_time]	integer	*	Fail time integer.
data.ticket[logs][][sla][fail_time_unit]	string	*	And it's measuring unit (see fail_time).
data.ticket[logs][][sla][fail_actions]	object (TriggerActions)	*	What to do if SLA failed.
data.ticket[logs][][sla][exclude_ticket_statuses]	array	*	This SLA will not apply while tickets are in these pending statuses.
data.ticket[logs][][sla_status]	string	*
data.ticket[logs][][details]	array	*
data.ticket[logs][][date_created]	DateTime	*
data.ticket[chats][]	array of objects (ChatConversation)	*
data.ticket[created_with_channel]	string	*
data.ticket[last_channel_used]	string	*
data.ticket[channels]	array	*
data.ticket[pending_articles][]	array of objects (ArticlePendingCreate)	*
data.ticket[pending_articles][][id]	integer	*
data.ticket[pending_articles][][person]	integer id (Person)	*
data.ticket[pending_articles][][assigned_person]	integer id (Person)	*
data.ticket[pending_articles][][ticket]	integer id (Ticket)	*
data.ticket[pending_articles][][message]	integer id (TicketMessage)	*
data.ticket[pending_articles][][comment]	string	*
data.ticket[pending_articles][][date_created]	DateTime	*
data.ticket[summary]	object (TicketSummary)	*
data.ticket[summary][id]	integer	*
data.ticket[summary][ticket]	object (Ticket)	*
data.ticket[summary][summary]	string	*
data.ticket[summary][summary_input]	string	*
data.ticket[summary][date_created]	DateTime	*
data.subject	string	*	Subject of the chat conversation.
data.status	string	*	Status of the chat conversation.
data.agent	object (Person)	*	If this is a user conversation, this is the agent assigned.
data.agent[emails]		*
data.agent[labels]		*
data.agent[teams]		*
data.agent[primary_team]		*
data.agent[agentData]		*
data.agent[publicUsergroups]		*
data.agent[publicAgentgroups]		*
data.agent_team	object (AgentTeam)	*	If this is a team chat, the team it is.
data.agent_team[id]	integer	*	The unique ID.
data.agent_team[name]	string	*	The name of agent team.
data.agent_team[avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.agent_team[members]		*
data.person	object (Person)	*	If this is a user conversation, this is the user who started the chat.
data.session	object (Session)	*	If this is a user convo, this is the users session.
data.session[id]	integer	*	The unique ID.
data.session[auth]	string	*	The authcode for the session to verify an id.
data.session[interface]	string	*	The Interface the session is for.
data.session[person]	object (Person)	*
data.session[user_agent]	string	*	The users user agent string.
data.session[visitor_id]	string	*
data.session[ip_address]	string	*	The users IP address.
data.session[data]	string	*
data.session[is_person]	boolean	*
data.session[is_bot]	boolean	*
data.session[is_helpdesk]	boolean	*
data.session[active_status]	string	*	(Agents) Status (available or away).
data.session[is_chat_available]	boolean	*	(Agents) Wehn status is available, if they are available for chat.
data.session[date_created]	DateTime	*
data.session[date_last]	DateTime	*
data.session[date_last_page]	DateTime	*
data.visitor_id	string	*
data.person_name	string	*	User chat: The users name, if they arent a person.
data.person_email	string	*	User chat: The users email, if they aren`t a person.
data.participants[]	array of objects (Person)	*
data.messages[]	array of objects (ChatMessage)	*
data.messages[][id]	integer	*	The unique ID.
data.messages[][author_id]	integer	*	Author id (legacy).
data.messages[][author_type]	string	*	Author type (legacy).
data.messages[][conversation_id]	integer	*	Conversation id (legacy).
data.messages[][author]	integer id (Person)	*	Person who created the message.
data.messages[][content]	string	*	The message.
data.messages[][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.messages[][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.messages[][is_html]	boolean	*	Is the content an HTML message?
data.messages[][metadata]	array	*	Additional data.
data.messages[][date_created]	DateTime	*	Date message was created.
data.messages[][date_received]	DateTime	*	Date message was received.
data.custom_data[]	array of objects (CustomDataChat)	*
data.custom_data[][conversation]	object (ChatConversation)	*	The conversation the message belongs to.
data.custom_data[][conversation][id]	integer	*	The unique id of chat conversation.
data.custom_data[][conversation][department]	object (Department)	*	Department which chat was assigned.
data.custom_data[][conversation][brand]	object (Brand)	*	Department which chat was assigned.
data.custom_data[][conversation][task_id]	integer	*
data.custom_data[][conversation][ticket]	object (Ticket)	*
data.custom_data[][conversation][labels][]	array of objects (LabelChatConversation)	*
data.custom_data[][conversation][subject]	string	*	Subject of the chat conversation.
data.custom_data[][conversation][status]	string	*	Status of the chat conversation.
data.custom_data[][conversation][agent]	object (Person)	*	If this is a user conversation, this is the agent assigned.
data.custom_data[][conversation][agent_team]	object (AgentTeam)	*	If this is a team chat, the team it is.
data.custom_data[][conversation][person]	object (Person)	*	If this is a user conversation, this is the user who started the chat.
data.custom_data[][conversation][session]	object (Session)	*	If this is a user convo, this is the users session.
data.custom_data[][conversation][visitor_id]	string	*
data.custom_data[][conversation][person_name]	string	*	User chat: The users name, if they arent a person.
data.custom_data[][conversation][person_email]	string	*	User chat: The users email, if they aren`t a person.
data.custom_data[][conversation][participants][]	array of objects (Person)	*
data.custom_data[][conversation][messages][]	array of objects (ChatMessage)	*
data.custom_data[][conversation][custom_data][]	array of objects (CustomDataChat)	*
data.custom_data[][conversation][rating_response_time]	integer	*
data.custom_data[][conversation][rating_overall]	integer	*
data.custom_data[][conversation][rating_comment]	string	*
data.custom_data[][conversation][is_agent]	boolean	*	Is this an agent chat.
data.custom_data[][conversation][is_window]	boolean	*	If the chat is popped out into a window. This is used to make sure the JS widget on pages doesn't load again.
data.custom_data[][conversation][date_created]	DateTime	*	Date when chat was started.
data.custom_data[][conversation][date_user_waiting]	DateTime	*	Since when the user has started waiting (i.e., time the assignment was 0).
data.custom_data[][conversation][date_assigned]	DateTime	*
data.custom_data[][conversation][date_agent_typing]	DateTime	*	Date when agent typed last time.
data.custom_data[][conversation][date_first_agent_message]	DateTime	*
data.custom_data[][conversation][date_ended]	DateTime	*	Date when chat was ended.
data.custom_data[][conversation][total_to_ended]	integer	*
data.custom_data[][conversation][ended_by]	string	*	Who ended the chat.
data.custom_data[][conversation][should_send_transcript]	boolean	*	True if transcript should be send.
data.custom_data[][conversation][date_transcript_sent]	DateTime	*	Date when transcript was sent.
data.custom_data[][conversation][email_validation_code]	string	*
data.custom_data[][conversation][email_validated]	boolean	*
data.custom_data[][conversation][access_token]	string	*
data.custom_data[][field]	object (CustomDefChat)	*
data.custom_data[][field][parent]	object (CustomDefChat)	*
data.custom_data[][field][children][]	array of objects (CustomDefChat)	*	Field children.
data.custom_data[][field][title]		*
data.custom_data[][root_field]	object (CustomDefChat)	*
data.rating_response_time	integer	*
data.rating_overall	integer	*
data.rating_comment	string	*
data.is_agent	boolean	*	Is this an agent chat.
data.is_window	boolean	*	If the chat is popped out into a window. This is used to make sure the JS widget on pages doesn't load again.
data.date_created	DateTime	*	Date when chat was started.
data.date_user_waiting	DateTime	*	Since when the user has started waiting (i.e., time the assignment was 0).
data.date_assigned	DateTime	*
data.date_agent_typing	DateTime	*	Date when agent typed last time.
data.date_first_agent_message	DateTime	*
data.date_ended	DateTime	*	Date when chat was ended.
data.total_to_ended	integer	*
data.should_send_transcript	boolean	*	True if transcript should be send.
data.date_transcript_sent	DateTime	*	Date when transcript was sent.
data.email_validation_code	string	*
data.email_validated	boolean	*
data.access_token	string	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/user_chats/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chats.count

Filters
Response
Status Codes

Name

Information

status

Description	status filter
Datatype	string
Pattern	open\|ended

date_created

Datatype	string
Pattern	Y-m-d:Y-m-d

date_period

Datatype	string
Pattern	today\|yesterday\|etc

person

Datatype	integer
Pattern	\d+

agent

Datatype	integer
Pattern	\d+

department

Datatype	integer
Pattern	\d+

brand

Datatype	integer
Pattern	\d+

label

Description	labels filter option
Datatype	array
Pattern	[\w+,]+

chat_field.{id}

Description	\n * Custom chat field filter. To filter by a custom field with ID=1 you need to add\n * ?chat_field.1=value to the query string
Datatype	string
Pattern	\d+\|\w

group_by

Pattern	date_created\|date_period\|agent\|department
Description	how to group counts
Datatype	boolean

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

GET /api/v2/user_chats/{conversationId}/messages CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chat_messages.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
conversationId

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

last_message_id

Datatype	integer
Pattern	\d+

agent_only

Datatype	integer
Pattern	\d+

Parameter	Type	Versions	Description
data[]	array of objects (ChatMessage)	*
data[][id]	integer	*	The unique ID.
data[][author_id]	integer	*	Author id (legacy).
data[][author_type]	string	*	Author type (legacy).
data[][conversation_id]	integer	*	Conversation id (legacy).
data[][author]	integer id (Person)	*	Person who created the message.
data[][content]	string	*	The message.
data[][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data[][is_user]	boolean	*	Is this an user's message? (send from the widget).
data[][is_html]	boolean	*	Is the content an HTML message?
data[][metadata]	array	*	Additional data.
data[][date_created]	DateTime	*	Date message was created.
data[][date_received]	DateTime	*	Date message was received.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/user_chats/{conversationId}/messages CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chat_messages.post

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
conversationId

Parameter	Type	Required?	Format	Description
content	string	true
author[id]	string	false
author[name]	string	false
author[email]	string	false
author[fieldId]	string	false
author[key]	string	false
is_user	boolean	false
person_name	string	false
blob	string	false
	string	false	string	Author name

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.author_id	integer	*	Author id (legacy).
data.author_type	string	*	Author type (legacy).
data.conversation_id	integer	*	Conversation id (legacy).
data.author	integer id (Person)	*	Person who created the message.
data.content	string	*	The message.
data.is_sys	boolean	*	Is this a system message? (ended, joined, etc).
data.is_user	boolean	*	Is this an user's message? (send from the widget).
data.is_html	boolean	*	Is the content an HTML message?
data.metadata	array	*	Additional data.
data.date_created	DateTime	*	Date message was created.
data.date_received	DateTime	*	Date message was received.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/user_chats/{conversationId}/messages/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chat_messages.count

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
conversationId

Name

Information

last_message_id

Datatype	integer
Pattern	\d+

agent_only

Datatype	integer
Pattern	\d+

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/user_chats/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chats.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/user_chats/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chats.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.department	object (Department)	*	Department which chat was assigned.
data.department[id]	integer	*
data.department[parent]	object (Department)	*
data.department[children][]	array of objects (Department)	*
data.department[title]	string	*
data.department[user_title]	string	*
data.department[is_tickets_enabled]	boolean	*
data.department[is_chat_enabled]	boolean	*
data.department[display_order]	integer	*
data.department[avatar]	object (Blob)	*
data.department[avatar][sys_name]	string	*	A unique system name for the blob.
data.department[avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.department[avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.department[avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.department[avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.department[avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.department[avatar][file_url]	string	*	The HTTP link to download the file.
data.department[avatar][authcode]	string	*
data.department[avatar][blob_hash]	string	*
data.department[avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.department[avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.department[avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.department[avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.department[avatar][date_created]	DateTime	*
data.department[avatar][is_temp]	boolean	*
data.department[avatar][source_ref]	string	*
data.department[avatar][labels][]	array of objects (LabelBlob)	*
data.department[avatar][labels][][blob]	object (Blob)	*
data.department[avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.department[brands][]	array of objects (Brand)	*
data.department[brands][][id]	integer	*	The unique ID.
data.department[brands][][name]	string	*	The brand name.
data.department[brands][][slug]	string	*
data.department[brands][][url]	string	*	The brand url.
data.department[brands][][theme_set]	object (ThemeSet)	*
data.department[brands][][theme_set][id]	integer	*
data.department[brands][][theme_set][theme_id]	string	*
data.department[brands][][theme_set][title]	string	*
data.department[brands][][theme_set][options]		*
data.department[brands][][edit_theme_set]	object (ThemeSet)	*
data.department[brands][][departments][]	array of objects (Department)	*
data.department[brands][][theme_sets][]	array of objects (ThemeSet)	*
data.department[permissions][]	array of objects (DepartmentPermission)	*
data.department[permissions][][department]	integer id (Department)	*
data.department[permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.department[permissions][][name]	string	*	The name of the permission.
data.department[permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.department[permissions][][is_active]	boolean	*
data.department[chat_queue]	object (UserChatQueue)	*
data.department[chat_queue][id]	integer	*	The unique ID.
data.department[chat_queue][name]	string	*
data.department[chat_queue][routing_model]	string	*
data.department[chat_queue][answer_timeout]	integer	*
data.department[chat_queue][is_all_agents]	boolean	*
data.department[chat_queue][departments][]	array of objects (Department)	*
data.department[chat_queue][max_queue_size]	integer	*
data.department[chat_queue][routingModel]		*
data.labels[]	array of objects (LabelChatConversation)	*
data.labels[][chat]	object (ChatConversation)	*
data.labels[][chat][id]	integer	*	The unique id of chat conversation.
data.labels[][chat][department]	object (Department)	*	Department which chat was assigned.
data.labels[][chat][brand]	object (Brand)	*	Department which chat was assigned.
data.labels[][chat][brand][id]	integer	*	The unique ID.
data.labels[][chat][brand][name]	string	*	The brand name.
data.labels[][chat][brand][slug]	string	*
data.labels[][chat][brand][url]	string	*	The brand url.
data.labels[][chat][brand][theme_set]	object (ThemeSet)	*
data.labels[][chat][brand][theme_set][id]	integer	*
data.labels[][chat][brand][theme_set][theme_id]	string	*
data.labels[][chat][brand][theme_set][title]	string	*
data.labels[][chat][brand][edit_theme_set]	object (ThemeSet)	*
data.labels[][chat][brand][departments][]	array of objects (Department)	*
data.labels[][chat][brand][theme_sets][]	array of objects (ThemeSet)	*
data.labels[][chat][task_id]	integer	*
data.labels[][chat][ticket]	object (Ticket)	*
data.labels[][chat][ticket][id]	integer	*
data.labels[][chat][ticket][ref]	string	*
data.labels[][chat][ticket][auth]	string	*
data.labels[][chat][ticket][parent_ticket]	object (Ticket)	*	Parent ticket.
data.labels[][chat][ticket][children_tickets][]	array of objects (Ticket)	*
data.labels[][chat][ticket][language]	object (Language)	*	The language the ticket is in.
data.labels[][chat][ticket][language][id]	integer	*	The unique ID.
data.labels[][chat][ticket][language][sys_name]	string	*	The unique sys name assigned to the language.
data.labels[][chat][ticket][language][title]	string	*	Title of the language.
data.labels[][chat][ticket][language][title_local]	string	*	Title of the language.
data.labels[][chat][ticket][language][base_filepath]	string	*	The base filepath for default phrases for this lang.
data.labels[][chat][ticket][language][locale]	string	*	The locale code.
data.labels[][chat][ticket][language][flag_image]	string	*	String path to image.
data.labels[][chat][ticket][language][is_rtl]	boolean	*	True if this is a right-to-left language.
data.labels[][chat][ticket][language][has_user]	boolean	*	True if has user.
data.labels[][chat][ticket][language][has_agent]	boolean	*	True if has agent.
data.labels[][chat][ticket][language][has_admin]	boolean	*	True if has admin.
data.labels[][chat][ticket][language][plural_categories][]	array of strings	*
data.labels[][chat][ticket][language][plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data.labels[][chat][ticket][language][flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`
data.labels[][chat][ticket][brand]	object (Brand)	*
data.labels[][chat][ticket][department]	object (Department)	*
data.labels[][chat][ticket][category]	object (TicketCategory)	*
data.labels[][chat][ticket][category][id]	integer	*	The unique ID.
data.labels[][chat][ticket][category][parent]	integer id (TicketCategory)	*	This category parent.
data.labels[][chat][ticket][category][title]	string	*	Category title.
data.labels[][chat][ticket][category][display_order]	integer	*	Obviously it's display order for lists.
data.labels[][chat][ticket][priority]	object (TicketPriority)	*
data.labels[][chat][ticket][priority][id]	integer	*	The unique ID.
data.labels[][chat][ticket][priority][title]	string	*	Priority title.
data.labels[][chat][ticket][priority][priority]	integer	*	The priority itself.
data.labels[][chat][ticket][workflow]	object (TicketWorkflow)	*
data.labels[][chat][ticket][workflow][id]	integer	*	The unique ID.
data.labels[][chat][ticket][workflow][title]	string	*	Workflow title.
data.labels[][chat][ticket][workflow][display_order]	integer	*	Workflow display order.
data.labels[][chat][ticket][product]	object (Product)	*
data.labels[][chat][ticket][product][parent]	integer id (Product)	*	Parent of the product.
data.labels[][chat][ticket][person]	object (Person)	*
data.labels[][chat][ticket][person_email]	object (PersonEmail)	*
data.labels[][chat][ticket][person_email][id]	integer	*	The unique ID.
data.labels[][chat][ticket][person_email][person]	integer id (Person)	*	Person owner of email.
data.labels[][chat][ticket][person_email][email]	string	*	The email address.
data.labels[][chat][ticket][person_email][email_domain]	string	*	The email address domain.
data.labels[][chat][ticket][person_email][is_validated]	boolean	*	True if validation passed.
data.labels[][chat][ticket][person_email][date_created]	DateTime	*	The original time the email was created.
data.labels[][chat][ticket][agent]	object (Person)	*
data.labels[][chat][ticket][agent_team]	object (AgentTeam)	*
data.labels[][chat][ticket][agent_team][id]	integer	*	The unique ID.
data.labels[][chat][ticket][agent_team][name]	string	*	The name of agent team.
data.labels[][chat][ticket][agent_team][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.labels[][chat][ticket][organization]	object (Organization)	*
data.labels[][chat][ticket][organization][id]	integer	*	The unique ID.
data.labels[][chat][ticket][organization][picture_blob]	object (Blob)	*	The org picture.
data.labels[][chat][ticket][organization][picture_blob][sys_name]	string	*	A unique system name for the blob.
data.labels[][chat][ticket][organization][picture_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][chat][ticket][organization][picture_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][chat][ticket][organization][picture_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][chat][ticket][organization][picture_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][chat][ticket][organization][picture_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][chat][ticket][organization][picture_blob][file_url]	string	*	The HTTP link to download the file.
data.labels[][chat][ticket][organization][picture_blob][authcode]	string	*
data.labels[][chat][ticket][organization][picture_blob][blob_hash]	string	*
data.labels[][chat][ticket][organization][picture_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][chat][ticket][organization][picture_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][chat][ticket][organization][picture_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][chat][ticket][organization][picture_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][chat][ticket][organization][picture_blob][date_created]	DateTime	*
data.labels[][chat][ticket][organization][picture_blob][is_temp]	boolean	*
data.labels[][chat][ticket][organization][picture_blob][source_ref]	string	*
data.labels[][chat][ticket][organization][picture_blob][labels][]	array of objects (LabelBlob)	*
data.labels[][chat][ticket][organization][picture_blob][labels][][blob]	object (Blob)	*
data.labels[][chat][ticket][organization][icon_property]	object (IconProperty)	*
data.labels[][chat][ticket][organization][icon_property][urn]	string	*
data.labels[][chat][ticket][organization][icon_property][options]	array	*
data.labels[][chat][ticket][organization][name]	string	*	The organization name.
data.labels[][chat][ticket][organization][summary]	string	*	The summary field as filled in by agents.
data.labels[][chat][ticket][organization][importance]	integer	*	The org importance.
data.labels[][chat][ticket][organization][custom_data][]	array of objects (CustomDataOrganization)	*
data.labels[][chat][ticket][organization][custom_data][][organization]	object (Organization)	*
data.labels[][chat][ticket][organization][custom_data][][field]	object (CustomDefOrganization)	*
data.labels[][chat][ticket][organization][custom_data][][field][parent]	object (CustomDefOrganization)	*	Field`s parent.
data.labels[][chat][ticket][organization][custom_data][][field][children][]	array of objects (CustomDefOrganization)	*	Field children.
data.labels[][chat][ticket][organization][custom_data][][root_field]	object (CustomDefOrganization)	*
data.labels[][chat][ticket][organization][usergroups][]	array of objects (Usergroup)	*	Usergroups the user belongs to.
data.labels[][chat][ticket][organization][usergroups][][id]	integer	*	The unique ID, DB-generated.
data.labels[][chat][ticket][organization][usergroups][][title]	string	*	Title of the usergroup.
data.labels[][chat][ticket][organization][usergroups][][note]	string	*	A note or description about the usergroup.
data.labels[][chat][ticket][organization][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.labels[][chat][ticket][organization][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.labels[][chat][ticket][organization][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.labels[][chat][ticket][organization][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.labels[][chat][ticket][organization][usergroups][][permissions][][id]	integer	*	The unique ID.
data.labels[][chat][ticket][organization][usergroups][][permissions][][name]	string	*	The name of the permission.
data.labels[][chat][ticket][organization][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.labels[][chat][ticket][organization][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.labels[][chat][ticket][organization][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.labels[][chat][ticket][organization][usergroups][][department_permissions][][department]	integer id (Department)	*
data.labels[][chat][ticket][organization][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.labels[][chat][ticket][organization][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.labels[][chat][ticket][organization][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.labels[][chat][ticket][organization][usergroups][][department_permissions][][is_active]	boolean	*
data.labels[][chat][ticket][organization][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.labels[][chat][ticket][organization][auto_cc_people][]	array of objects (Person)	*	Users who are set to automatically be added to tickets and other org things.
data.labels[][chat][ticket][organization][labels][]	array of objects (LabelOrganization)	*
data.labels[][chat][ticket][organization][labels][][organization]	object (Organization)	*
data.labels[][chat][ticket][organization][contact_data][]	array of objects (OrganizationContactData)	*
data.labels[][chat][ticket][organization][emails][]	array of objects (OrganizationEmail)	*
data.labels[][chat][ticket][organization][emails][][id]	integer	*	The unique log id.
data.labels[][chat][ticket][organization][emails][][organization]	object (Organization)	*
data.labels[][chat][ticket][organization][emails][][email]	string	*
data.labels[][chat][ticket][organization][emails][][date_created]	DateTime	*
data.labels[][chat][ticket][organization][email_domains][]	array of objects (OrganizationEmailDomain)	*
data.labels[][chat][ticket][organization][email_domains][][domain]	string	*	The email domain.
data.labels[][chat][ticket][organization][email_domains][][organization]	object (Organization)	*	The users organization.
data.labels[][chat][ticket][organization][date_created]	DateTime	*	The date the org was inserted into the system.
data.labels[][chat][ticket][organization][members][]	array of objects (Person)	*
data.labels[][chat][ticket][organization][parent]	object (Organization)	*
data.labels[][chat][ticket][organization][children][]	array of objects (Organization)	*
data.labels[][chat][ticket][organization][tickets][]	array of objects (Ticket)	*
data.labels[][chat][ticket][organization][organization_members][]	array of objects (OrganizationMember)	*
data.labels[][chat][ticket][organization][organization_members][][id]	integer	*
data.labels[][chat][ticket][organization][organization_members][][person]	integer id (Person)	*
data.labels[][chat][ticket][organization][organization_members][][organization]	integer id (Organization)	*
data.labels[][chat][ticket][organization][organization_members][][is_manager]	boolean	*
data.labels[][chat][ticket][organization][organization_members][][position]	string	*
data.labels[][chat][ticket][organization][organization_members][][created_at]	DateTime	*
data.labels[][chat][ticket][organization][organization_members][][updated_at]	DateTime	*
data.labels[][chat][ticket][linked_chat]	object (ChatConversation)	*
data.labels[][chat][ticket][attachments][]	array of objects (TicketAttachment)	*
data.labels[][chat][ticket][attachments][][id]	integer	*	The unique ID.
data.labels[][chat][ticket][attachments][][ticket]	integer id (Ticket)	*	Ticket this attachment belongs to.
data.labels[][chat][ticket][attachments][][person]	integer id (Person)	*	Who created the attachment.
data.labels[][chat][ticket][attachments][][blob]	object (Blob)	*	Actual attachment.
data.labels[][chat][ticket][attachments][][blob][sys_name]	string	*	A unique system name for the blob.
data.labels[][chat][ticket][attachments][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][chat][ticket][attachments][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][chat][ticket][attachments][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][chat][ticket][attachments][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][chat][ticket][attachments][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][chat][ticket][attachments][][blob][file_url]	string	*	The HTTP link to download the file.
data.labels[][chat][ticket][attachments][][blob][authcode]	string	*
data.labels[][chat][ticket][attachments][][blob][blob_hash]	string	*
data.labels[][chat][ticket][attachments][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][chat][ticket][attachments][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][chat][ticket][attachments][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][chat][ticket][attachments][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][chat][ticket][attachments][][blob][date_created]	DateTime	*
data.labels[][chat][ticket][attachments][][blob][is_temp]	boolean	*
data.labels[][chat][ticket][attachments][][blob][source_ref]	string	*
data.labels[][chat][ticket][attachments][][blob][labels][]	array of objects (LabelBlob)	*
data.labels[][chat][ticket][attachments][][blob][labels][][blob]	object (Blob)	*
data.labels[][chat][ticket][attachments][][message]	integer id (TicketMessage)	*	Message - holder of this attachment.
data.labels[][chat][ticket][attachments][][is_agent_note]	boolean	*	True if this attachmen just a note.
data.labels[][chat][ticket][attachments][][is_inline]	boolean	*	Is this attachment is embed in message.
data.labels[][chat][ticket][access_codes][]	array of objects (TicketAccessCode)	*
data.labels[][chat][ticket][access_codes][][id]	integer	*
data.labels[][chat][ticket][access_codes][][ticket]	object (Ticket)	*
data.labels[][chat][ticket][access_codes][][person]	object (Person)	*
data.labels[][chat][ticket][access_codes][][auth]	string	*
data.labels[][chat][ticket][messages][]	array of objects (TicketMessage)	*
data.labels[][chat][ticket][messages][][id]	integer	*	The unique id of message.
data.labels[][chat][ticket][messages][][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data.labels[][chat][ticket][messages][][person]	object (Person)	*	Person this message was sent by.
data.labels[][chat][ticket][messages][][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data.labels[][chat][ticket][messages][][email_source][id]	integer	*
data.labels[][chat][ticket][messages][][email_source][uuid]	string	*
data.labels[][chat][ticket][messages][][email_source][blob]	object (Blob)	*
data.labels[][chat][ticket][messages][][email_source][blob][sys_name]	string	*	A unique system name for the blob.
data.labels[][chat][ticket][messages][][email_source][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][chat][ticket][messages][][email_source][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][chat][ticket][messages][][email_source][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][chat][ticket][messages][][email_source][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][chat][ticket][messages][][email_source][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][chat][ticket][messages][][email_source][blob][file_url]	string	*	The HTTP link to download the file.
data.labels[][chat][ticket][messages][][email_source][blob][authcode]	string	*
data.labels[][chat][ticket][messages][][email_source][blob][blob_hash]	string	*
data.labels[][chat][ticket][messages][][email_source][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][chat][ticket][messages][][email_source][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][chat][ticket][messages][][email_source][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][chat][ticket][messages][][email_source][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][chat][ticket][messages][][email_source][blob][date_created]	DateTime	*
data.labels[][chat][ticket][messages][][email_source][blob][is_temp]	boolean	*
data.labels[][chat][ticket][messages][][email_source][blob][source_ref]	string	*
data.labels[][chat][ticket][messages][][email_source][blob][labels][]	array of objects (LabelBlob)	*
data.labels[][chat][ticket][messages][][email_source][blob][labels][][blob]	object (Blob)	*
data.labels[][chat][ticket][messages][][email_source][object_type]	string	*	The type of object this is attached to (should be the table name of the super type, eg: tickets, people, organizations). This typically is not set until after the email is processed (ie the status is 'processed').
data.labels[][chat][ticket][messages][][email_source][object_id]	integer	*	The ID of the object this is attached to.
data.labels[][chat][ticket][messages][][email_source][from_email]	string	*
data.labels[][chat][ticket][messages][][email_source][status]	string	*	The current status of the message: - inserted: Only inserted - processing: Currently processing - complete: Fully processed - error: Tried to process but there was some kind of error (see error_code).
data.labels[][chat][ticket][messages][][email_source][date_status]	DateTime	*
data.labels[][chat][ticket][messages][][email_source][error_code]	string	*	When status is error, this is the code that describes the error.
data.labels[][chat][ticket][messages][][email_source][date_created]	DateTime	*
data.labels[][chat][ticket][messages][][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.labels[][chat][ticket][messages][][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.labels[][chat][ticket][messages][][snippet_use_logs][][id]	integer	*	The unique ID.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet]	object (SnippetV2)	*	Snippet used.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][id]	integer	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][title]	string	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][author]	object (Person)	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][is_private]	boolean	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar]	object (Blob)	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][sys_name]	string	*	A unique system name for the blob.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][file_url]	string	*	The HTTP link to download the file.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][authcode]	string	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][blob_hash]	string	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][date_created]	DateTime	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][is_temp]	boolean	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][source_ref]	string	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][labels][]	array of objects (LabelBlob)	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][avatar][labels][][blob]	object (Blob)	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][status]	string	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][shortcut_codes]	array	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][inline_translations]	array	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][translations][]	array of objects (SnippetV2Translation)	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][translations][][id]	integer	*	The unique ID.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][translations][][snippet]	object (SnippetV2)	*	Snippet translated.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][translations][][language]	object (Language)	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][translations][][content]	array	*	Snippet content.
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][translations][][blobs][]	array of objects (Blob)	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][categories][]	array of objects (SnippetV2Category)	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][categories][][id]	integer	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][categories][][title]	string	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][categories][][is_global]	boolean	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][categories][][display_order]	integer	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][categories][][parent]	object (SnippetV2Category)	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][categories][][agent_teams][]	array of objects (AgentTeam)	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][display_order]	integer	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][snippet][date_created]	DateTime	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][ticket_message]	object (TicketMessage)	*	Ticket Message where the snippet was used.
data.labels[][chat][ticket][messages][][snippet_use_logs][][chat_message]	object (ChatMessage)	*	Chat Message where the snippet was used.
data.labels[][chat][ticket][messages][][snippet_use_logs][][chat_message][id]	integer	*	The unique ID.
data.labels[][chat][ticket][messages][][snippet_use_logs][][chat_message][author_id]	integer	*	Author id (legacy).
data.labels[][chat][ticket][messages][][snippet_use_logs][][chat_message][author_type]	string	*	Author type (legacy).
data.labels[][chat][ticket][messages][][snippet_use_logs][][chat_message][conversation_id]	integer	*	Conversation id (legacy).
data.labels[][chat][ticket][messages][][snippet_use_logs][][chat_message][author]	integer id (Person)	*	Person who created the message.
data.labels[][chat][ticket][messages][][snippet_use_logs][][chat_message][content]	string	*	The message.
data.labels[][chat][ticket][messages][][snippet_use_logs][][chat_message][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.labels[][chat][ticket][messages][][snippet_use_logs][][chat_message][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.labels[][chat][ticket][messages][][snippet_use_logs][][chat_message][is_html]	boolean	*	Is the content an HTML message?
data.labels[][chat][ticket][messages][][snippet_use_logs][][chat_message][metadata]	array	*	Additional data.
data.labels[][chat][ticket][messages][][snippet_use_logs][][chat_message][date_created]	DateTime	*	Date message was created.
data.labels[][chat][ticket][messages][][snippet_use_logs][][chat_message][date_received]	DateTime	*	Date message was received.
data.labels[][chat][ticket][messages][][snippet_use_logs][][language]	object (Language)	*	Snippet translated.
data.labels[][chat][ticket][messages][][snippet_use_logs][][person]	object (Person)	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][rating]	integer	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][rating_person]	object (Person)	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][rating_message]	string	*
data.labels[][chat][ticket][messages][][snippet_use_logs][][date_created]	DateTime	*
data.labels[][chat][ticket][messages][][date_created]	DateTime	*	Date when message was created.
data.labels[][chat][ticket][messages][][is_agent_note]	boolean	*	Is this message agent note?
data.labels[][chat][ticket][messages][][is_hidden]	boolean	*	Is this message hidden?
data.labels[][chat][ticket][messages][][creation_system]	string	*	How this message was created.
data.labels[][chat][ticket][messages][][ip_address]	string	*	An ip address from which message was sent.
data.labels[][chat][ticket][messages][][visitor_id]	string	*	Unique ID of visitor left this message.
data.labels[][chat][ticket][messages][][hostname]	string	*	Host from which message was left.
data.labels[][chat][ticket][messages][][geo_country]	string	*	Country message is from (deprecated).
data.labels[][chat][ticket][messages][][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.labels[][chat][ticket][messages][][message_hash]	string	*	An unique hash of message.
data.labels[][chat][ticket][messages][][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.labels[][chat][ticket][messages][][primary_translation][id]	integer	*
data.labels[][chat][ticket][messages][][primary_translation][ticket]	object (Ticket)	*
data.labels[][chat][ticket][messages][][primary_translation][ticket_message]	object (TicketMessage)	*
data.labels[][chat][ticket][messages][][primary_translation][from_lang_code]	string	*
data.labels[][chat][ticket][messages][][primary_translation][lang_code]	string	*
data.labels[][chat][ticket][messages][][primary_translation][message]	string	*
data.labels[][chat][ticket][messages][][primary_translation][date_created]	DateTime	*
data.labels[][chat][ticket][messages][][message]	string	*	The message, will be in HTML!
data.labels[][chat][ticket][messages][][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.labels[][chat][ticket][messages][][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.labels[][chat][ticket][messages][][message_source]	string	*	The message source.
data.labels[][chat][ticket][messages][][message_source_type]	string	*	The message source type.
data.labels[][chat][ticket][messages][][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.labels[][chat][ticket][messages][][lang_code]	string	*	The set/detected lang code.
data.labels[][chat][ticket][messages][][email_message_id][]	array of objects (TicketMessageEmailId)	*
data.labels[][chat][ticket][messages][][email_message_id][][id]	integer	*
data.labels[][chat][ticket][messages][][email_message_id][][message]	object (TicketMessage)	*
data.labels[][chat][ticket][messages][][email_message_id][][email_id]	string	*
data.labels[][chat][ticket][messages][][ticket_feedback][]	array of objects (TicketFeedback)	*
data.labels[][chat][ticket][messages][][ticket_feedback][][id]	integer	*
data.labels[][chat][ticket][messages][][ticket_feedback][][ticket]	object (Ticket)	*
data.labels[][chat][ticket][messages][][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data.labels[][chat][ticket][messages][][ticket_feedback][][person]	object (Person)	*
data.labels[][chat][ticket][messages][][ticket_feedback][][rating]	integer	*
data.labels[][chat][ticket][messages][][ticket_feedback][][message]	string	*
data.labels[][chat][ticket][messages][][ticket_feedback][][date_created]	DateTime	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][id]	integer	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][subject]	string	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][from_email]	string	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][tos]	array	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][ccs]	array	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][bccs]	array	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][message]	string	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][authcode]	string	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][blob_hash]	string	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][source_ref]	string	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data.labels[][chat][ticket][messages][][ticket_message_forwards][][date_created]	DateTime	*
data.labels[][chat][ticket][messages][][channel_message]	object (TicketMessageChannelMessage)	*
data.labels[][chat][ticket][messages][][channel_message][id]	integer	*	@var int The unique id of message.
data.labels[][chat][ticket][messages][][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data.labels[][chat][ticket][messages][][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data.labels[][chat][ticket][messages][][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data.labels[][chat][ticket][messages][][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data.labels[][chat][ticket][messages][][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data.labels[][chat][ticket][messages][][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data.labels[][chat][ticket][messages][][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data.labels[][chat][ticket][messages][][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data.labels[][chat][ticket][messages][][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data.labels[][chat][ticket][sms_messages][]	array of objects (TicketSms)	*
data.labels[][chat][ticket][sms_messages][][id]	integer	*
data.labels[][chat][ticket][sms_messages][][ticket]	object (Ticket)	*
data.labels[][chat][ticket][sms_messages][][person]	object (Person)	*
data.labels[][chat][ticket][sms_messages][][sms_account]	object (SmsAccount)	*
data.labels[][chat][ticket][sms_messages][][sms_account][id]	integer	*	The unique ID.
data.labels[][chat][ticket][sms_messages][][sms_account][type]	string	*
data.labels[][chat][ticket][sms_messages][][sms_account][params]	array	*
data.labels[][chat][ticket][sms_messages][][sms_account][identifier]	string	*
data.labels[][chat][ticket][sms_messages][][sms_account][is_enabled]	boolean	*
data.labels[][chat][ticket][sms_messages][][sms_account][is_connected]	boolean	*
data.labels[][chat][ticket][sms_messages][][sms_account][is_tested]	boolean	*
data.labels[][chat][ticket][sms_messages][][sms_account][test_code]	string	*
data.labels[][chat][ticket][sms_messages][][job]	object (Job)	*
data.labels[][chat][ticket][sms_messages][][job][id]	integer	*	The unique job id.
data.labels[][chat][ticket][sms_messages][][job][type]	string	*	The job type, used by the Job Router to find the right Job Processor.
data.labels[][chat][ticket][sms_messages][][job][status]	string	*	The status of the job.
data.labels[][chat][ticket][sms_messages][][job][status_code]	string	*	Any code to further classify the status.
data.labels[][chat][ticket][sms_messages][][job][date_touch]	DateTime	*	Date the last time a process "touched" this ticket.
data.labels[][chat][ticket][sms_messages][][job][date_created]	DateTime	*	Date this job entered the "jobs" table.
data.labels[][chat][ticket][sms_messages][][job][date_last_try]	DateTime	*	Last time we processed this job.
data.labels[][chat][ticket][sms_messages][][job][date_next_try]	DateTime	*	If this DateTime is in the future, it won't be selected for execution.
data.labels[][chat][ticket][sms_messages][][job][num_tries]	integer	*	The number of times this job has been executed Job Processor (usually indicated failures if > 1).
data.labels[][chat][ticket][sms_messages][][job][log_summary]	string	*	A human readable summary of the job's execution.
data.labels[][chat][ticket][sms_messages][][job][log]	string	*	A more verbose log.
data.labels[][chat][ticket][sms_messages][][job][data]	array	*	An array of data, or payload, that the job processor needs to execute this job (stored in the db as json). This MUST always be an array, even if its an empty array
data.labels[][chat][ticket][sms_messages][][job][original_job]	integer	*	Null unless the job was created as a retry - if so, the originating job ID is stored here so we can query it later. Note: You MUST specify the originating job, do not create a linked list of failed jobs.
data.labels[][chat][ticket][sms_messages][][date_created]	DateTime	*
data.labels[][chat][ticket][sms_messages][][from_number]	string	*	Permanent record of the phone number that sent this SMS. (Won't change even if Person changes their phone number).
data.labels[][chat][ticket][sms_messages][][to_number]	string	*	Permanent record of the phone number that this SMS was sent to.
data.labels[][chat][ticket][sms_messages][][message]	string	*	The SMS message.
data.labels[][chat][ticket][sms_messages][][direction]	string	*	Just a system flag for reporting.
data.labels[][chat][ticket][topic_links][]	array of objects (TicketCommunityTopicLink)	*
data.labels[][chat][ticket][topic_links][][id]	integer	*	The unique filter ID.
data.labels[][chat][ticket][topic_links][][ticket]	integer id (Ticket)	*
data.labels[][chat][ticket][topic_links][][topic]	integer id (CommunityTopic)	*
data.labels[][chat][ticket][topic_links][][person]	integer id (Person)	*
data.labels[][chat][ticket][topic_links][][date_created]	DateTime	*
data.labels[][chat][ticket][custom_data][]	array of objects (CustomDataTicket)	*
data.labels[][chat][ticket][custom_data][][ticket]	object (Ticket)	*
data.labels[][chat][ticket][custom_data][][field]	object (CustomDefTicket)	*
data.labels[][chat][ticket][custom_data][][field][parent]	object (CustomDefTicket)	*
data.labels[][chat][ticket][custom_data][][field][children][]	array of objects (CustomDefTicket)	*	Field children.
data.labels[][chat][ticket][custom_data][][root_field]	object (CustomDefTicket)	*
data.labels[][chat][ticket][labels][]	array of objects (LabelTicket)	*
data.labels[][chat][ticket][labels][][ticket]	object (Ticket)	*
data.labels[][chat][ticket][sent_to_address]	string	*	The email address the ticket was sent to if it came in via a gateway. This is a full string (e.g., including CC's) of the original.
data.labels[][chat][ticket][email_account]	object (EmailAccount)	*	The gateway this ticket originated from.
data.labels[][chat][ticket][email_account][id]	integer	*
data.labels[][chat][ticket][email_account][account_type]	string	*
data.labels[][chat][ticket][email_account][is_enabled]	boolean	*
data.labels[][chat][ticket][email_account][address]	string	*
data.labels[][chat][ticket][email_account][cert_blob]	object (Blob)	*
data.labels[][chat][ticket][email_account][cert_blob][sys_name]	string	*	A unique system name for the blob.
data.labels[][chat][ticket][email_account][cert_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][chat][ticket][email_account][cert_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][chat][ticket][email_account][cert_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][chat][ticket][email_account][cert_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][chat][ticket][email_account][cert_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][chat][ticket][email_account][cert_blob][file_url]	string	*	The HTTP link to download the file.
data.labels[][chat][ticket][email_account][cert_blob][authcode]	string	*
data.labels[][chat][ticket][email_account][cert_blob][blob_hash]	string	*
data.labels[][chat][ticket][email_account][cert_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][chat][ticket][email_account][cert_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][chat][ticket][email_account][cert_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][chat][ticket][email_account][cert_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][chat][ticket][email_account][cert_blob][date_created]	DateTime	*
data.labels[][chat][ticket][email_account][cert_blob][is_temp]	boolean	*
data.labels[][chat][ticket][email_account][cert_blob][source_ref]	string	*
data.labels[][chat][ticket][email_account][cert_blob][labels][]	array of objects (LabelBlob)	*
data.labels[][chat][ticket][email_account][cert_blob][labels][][blob]	object (Blob)	*
data.labels[][chat][ticket][email_account][key_blob]	object (Blob)	*
data.labels[][chat][ticket][email_account_address]	string	*	The email address (from list of to/cc) that matched with the email account.
data.labels[][chat][ticket][creation_system]	string	*
data.labels[][chat][ticket][creation_system_option]	string	*	Optional information about the creation system. For example, source URL the ticket came from.
data.labels[][chat][ticket][ticket_hash]	string	*
data.labels[][chat][ticket][status]	string	*
data.labels[][chat][ticket][ticket_status]	object (TicketStatus)	*
data.labels[][chat][ticket][ticket_status][id]	integer	*
data.labels[][chat][ticket][ticket_status][status_type]	string	*
data.labels[][chat][ticket][ticket_status][status_code]	string	*
data.labels[][chat][ticket][ticket_status][sys_id]	string	*
data.labels[][chat][ticket][ticket_status][title]	string	*
data.labels[][chat][ticket][ticket_status][display_order]	integer	*
data.labels[][chat][ticket][ticket_status][pending_waiting_time_mode]	string	*	Where to count time spending in pending status. Check PENDING_WAITING_TIME_MODE_ constants
data.labels[][chat][ticket][ticket_status][children][]	array of objects (TicketStatus)	*
data.labels[][chat][ticket][ticket_status][options]	array	*
data.labels[][chat][ticket][urgency]	integer	*
data.labels[][chat][ticket][feedback_rating]	integer	*
data.labels[][chat][ticket][date_feedback_rating]	DateTime	*
data.labels[][chat][ticket][date_created]	DateTime	*
data.labels[][chat][ticket][date_resolved]	DateTime	*
data.labels[][chat][ticket][date_archived]	DateTime	*
data.labels[][chat][ticket][date_first_agent_assign]	DateTime	*
data.labels[][chat][ticket][date_first_agent_reply]	DateTime	*
data.labels[][chat][ticket][date_last_agent_reply]	DateTime	*
data.labels[][chat][ticket][date_last_user_reply]	DateTime	*
data.labels[][chat][ticket][date_agent_waiting]	DateTime	*
data.labels[][chat][ticket][date_user_waiting]	DateTime	*
data.labels[][chat][ticket][date_status]	DateTime	*
data.labels[][chat][ticket][date_on_hold]	DateTime	*
data.labels[][chat][ticket][total_user_waiting]	integer	*
data.labels[][chat][ticket][total_to_first_reply]	integer	*
data.labels[][chat][ticket][total_user_waiting_wh_start]	DateTime	*
data.labels[][chat][ticket][total_user_waiting_wh]	integer	*
data.labels[][chat][ticket][total_to_first_reply_wh]	integer	*
data.labels[][chat][ticket][locked_by_agent]	object (Person)	*
data.labels[][chat][ticket][date_locked]	DateTime	*
data.labels[][chat][ticket][has_attachments]	boolean	*
data.labels[][chat][ticket][subject]	string	*
data.labels[][chat][ticket][original_subject]	string	*
data.labels[][chat][ticket][properties]	array	*
data.labels[][chat][ticket][count_agent_replies]	integer	*
data.labels[][chat][ticket][count_user_replies]	integer	*
data.labels[][chat][ticket][worst_sla_status]	string	*
data.labels[][chat][ticket][waiting_times]	array	*	Used to track ticket status changes and how much time ticket was in status Add new item every time status changed This is optimisation over TicketLog.
data.labels[][chat][ticket][participants][]	array of objects (TicketParticipant)	*
data.labels[][chat][ticket][participants][][id]	integer	*
data.labels[][chat][ticket][participants][][ticket]	object (Ticket)	*
data.labels[][chat][ticket][participants][][person]	object (Person)	*
data.labels[][chat][ticket][participants][][access_code]	object (TicketAccessCode)	*
data.labels[][chat][ticket][participants][][person_email]	object (PersonEmail)	*
data.labels[][chat][ticket][participants][][default_on]	boolean	*	Default checkbox status of the user.
data.labels[][chat][ticket][charges][]	array of objects (TicketCharge)	*
data.labels[][chat][ticket][charges][][id]	integer	*
data.labels[][chat][ticket][charges][][charge_time]	integer	*
data.labels[][chat][ticket][charges][][amount]	float	*
data.labels[][chat][ticket][charges][][date_created]	DateTime	*
data.labels[][chat][ticket][charges][][ticket]	object (Ticket)	*
data.labels[][chat][ticket][charges][][person]	object (Person)	*
data.labels[][chat][ticket][charges][][organization]	object (Organization)	*
data.labels[][chat][ticket][charges][][agent]	object (Person)	*
data.labels[][chat][ticket][charges][][custom_data][]	array of objects (CustomDataBilling)	*
data.labels[][chat][ticket][charges][][custom_data][][ticket_charge]	object (TicketCharge)	*
data.labels[][chat][ticket][charges][][custom_data][][field]	object (CustomDefBilling)	*
data.labels[][chat][ticket][charges][][custom_data][][field][parent]	object (CustomDefBilling)	*
data.labels[][chat][ticket][charges][][custom_data][][field][children][]	array of objects (CustomDefBilling)	*	Field children.
data.labels[][chat][ticket][charges][][custom_data][][root_field]	object (CustomDefBilling)	*
data.labels[][chat][ticket][ticket_slas][]	array of objects (TicketSla)	*
data.labels[][chat][ticket][ticket_slas][][id]	integer	*	The unique ID.
data.labels[][chat][ticket][ticket_slas][][sla_status]	string	*	The SLA status.
data.labels[][chat][ticket][ticket_slas][][warn_date]	DateTime	*	The SLA warn date.
data.labels[][chat][ticket][ticket_slas][][fail_date]	DateTime	*	The SLA fail date.
data.labels[][chat][ticket][ticket_slas][][is_completed]	boolean	*	Is the SLA completed?
data.labels[][chat][ticket][ticket_slas][][is_completed_set]	boolean	*	Completed by automated action.
data.labels[][chat][ticket][ticket_slas][][completed_time_taken]	integer	*	Time taken.
data.labels[][chat][ticket][ticket_slas][][ticket]	integer id (Ticket)	*	Ticket.
data.labels[][chat][ticket][ticket_slas][][sla]	integer id (Sla)	*	SLA.
data.labels[][chat][ticket][ticket_slas][][date_applied]	DateTime	*	time and date when SLA was applied to the ticket.
data.labels[][chat][ticket][ticket_slas][][date_completed]	DateTime	*	time when SLA status became OK.
data.labels[][chat][ticket][jira_issues][]	array of objects (JiraIssue)	*	linked jira issues.
data.labels[][chat][ticket][jira_issues][][id]	integer	*	The unique ID.
data.labels[][chat][ticket][jira_issues][][ticket]	object (Ticket)	*	The associated DeskPRO ticket.
data.labels[][chat][ticket][jira_issues][][issue_id]	integer	*
data.labels[][chat][ticket][jira_issues][][status_id]	integer	*
data.labels[][chat][ticket][jira_issues][][created]	DateTime	*	Export time.
data.labels[][chat][ticket][problems][]	array of objects (Problem)	*
data.labels[][chat][ticket][problems][][id]	integer	*	The unique ID.
data.labels[][chat][ticket][problems][][title]	string	*	Problem title.
data.labels[][chat][ticket][problems][][creator]	integer id (Person)	*	Person who created the problem.
data.labels[][chat][ticket][problems][][created]	DateTime	*	Date when the problem was created.
data.labels[][chat][ticket][problems][][is_open]	boolean	*	Is problem still has no solution?
data.labels[][chat][ticket][problems][][tickets][]	array of integer ids (Ticket)	*	Tickets associated with problem.
data.labels[][chat][ticket][stars][]	array of objects (TicketFlagged)	*
data.labels[][chat][ticket][stars][][ticket]	object (Ticket)	*
data.labels[][chat][ticket][stars][][person_id]	integer	*
data.labels[][chat][ticket][stars][][color]	string	*
data.labels[][chat][ticket][follow_ups][]	array of objects (TicketFollowUp)	*
data.labels[][chat][ticket][follow_ups][][id]	integer	*	The unique ID.
data.labels[][chat][ticket][follow_ups][][person]	integer id (Person)	*
data.labels[][chat][ticket][follow_ups][][actions]	array	*
data.labels[][chat][ticket][follow_ups][][cancel_if_user_reply]	boolean	*
data.labels[][chat][ticket][follow_ups][][cancel_if_agent_reply]	boolean	*
data.labels[][chat][ticket][follow_ups][][status]	string	*
data.labels[][chat][ticket][follow_ups][][date_created]	DateTime	*
data.labels[][chat][ticket][follow_ups][][date_to_run]	DateTime	*
data.labels[][chat][ticket][follow_ups][][date_did_run]	DateTime	*
data.labels[][chat][ticket][logs][]	array of objects (TicketLog)	*
data.labels[][chat][ticket][logs][][id]	integer	*
data.labels[][chat][ticket][logs][][parent]	object (TicketLog)	*
data.labels[][chat][ticket][logs][][ticket]	object (Ticket)	*
data.labels[][chat][ticket][logs][][person]	object (Person)	*
data.labels[][chat][ticket][logs][][action_type]	string	*
data.labels[][chat][ticket][logs][][id_object]	integer	*	If the log involves a specific thing in a ticket (eg a message that was moved), then that is this id.
data.labels[][chat][ticket][logs][][id_before]	integer	*	The ID of the previous entity changed, or any other numeric value.
data.labels[][chat][ticket][logs][][id_after]	integer	*	The ID of the new entity, or any other numeric value.
data.labels[][chat][ticket][logs][][trigger_id]	integer	*	If the change was caused by a trigger, the trigger id. Note this is the integer ID (not a FK relation) so the record is kept even if the trigger itself is deleted.
data.labels[][chat][ticket][logs][][escalation_id]	integer	*	If the change was caused by an escalation Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.labels[][chat][ticket][logs][][macro_id]	integer	*	If the change was caused by an v2 macro Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.labels[][chat][ticket][logs][][sla]	object (Sla)	*	If the change was caused by an SLA, the SLA.
data.labels[][chat][ticket][logs][][sla][id]	integer	*	The unique ID.
data.labels[][chat][ticket][logs][][sla][title]	string	*	SLA title.
data.labels[][chat][ticket][logs][][sla][sla_type]	string	*	Type of SLA - first_response, resolution, waiting_time.
data.labels[][chat][ticket][logs][][sla][active_time]	string	*	Whether active all the time (all) or during work hours only (work_hours) or use the default ticket-wide settings (default).
data.labels[][chat][ticket][logs][][sla][work_start]	integer	*	When the work day starts. This is stored as the number of seconds after 00:00:00.
data.labels[][chat][ticket][logs][][sla][work_end]	integer	*	When the work day ends. This is stored as the number of seconds after 00:00:00.
data.labels[][chat][ticket][logs][][sla][work_days]	array	*	Array of work days, stored with keys corresponding to day numbers. Values are true. 0 = Sunday, 6 = Saturday (same as PHP, easy to convert to MySQL which is 1 = Sunday, 7 = Saturday).
data.labels[][chat][ticket][logs][][sla][work_timezone]	string	*	Timezone for work hours/days to be considered in.
data.labels[][chat][ticket][logs][][sla][work_holidays]	array	*	List of work holidays.
data.labels[][chat][ticket][logs][][sla][apply_type]	string	*	Controls how the SLA is applied to tickets: all, terms, terms_before_triggers, manual.
data.labels[][chat][ticket][logs][][sla][apply_terms]	object (TriggerTerms)	*	Conditions to apply.
data.labels[][chat][ticket][logs][][sla][apply_terms][version]	integer	*	Terms version.
data.labels[][chat][ticket][logs][][sla][apply_terms][terms]	array	*	Terms themselves.
data.labels[][chat][ticket][logs][][sla][trigger_terms]	object (TriggerTerms)	*	Conditions to consider sla completed.
data.labels[][chat][ticket][logs][][sla][warn_time]	integer	*	Warn time integer.
data.labels[][chat][ticket][logs][][sla][warn_time_unit]	string	*	And it's unit (see warn time).
data.labels[][chat][ticket][logs][][sla][warn_actions]	object (TriggerActions)	*	How to warn about SLA will fail.
data.labels[][chat][ticket][logs][][sla][warn_actions][version]	integer	*	Actions version.
data.labels[][chat][ticket][logs][][sla][warn_actions][actions]	array	*	Actions array representation.
data.labels[][chat][ticket][logs][][sla][fail_time]	integer	*	Fail time integer.
data.labels[][chat][ticket][logs][][sla][fail_time_unit]	string	*	And it's measuring unit (see fail_time).
data.labels[][chat][ticket][logs][][sla][fail_actions]	object (TriggerActions)	*	What to do if SLA failed.
data.labels[][chat][ticket][logs][][sla][exclude_ticket_statuses]	array	*	This SLA will not apply while tickets are in these pending statuses.
data.labels[][chat][ticket][logs][][sla_status]	string	*
data.labels[][chat][ticket][logs][][details]	array	*
data.labels[][chat][ticket][logs][][date_created]	DateTime	*
data.labels[][chat][ticket][chats][]	array of objects (ChatConversation)	*
data.labels[][chat][ticket][created_with_channel]	string	*
data.labels[][chat][ticket][last_channel_used]	string	*
data.labels[][chat][ticket][channels]	array	*
data.labels[][chat][ticket][pending_articles][]	array of objects (ArticlePendingCreate)	*
data.labels[][chat][ticket][pending_articles][][id]	integer	*
data.labels[][chat][ticket][pending_articles][][person]	integer id (Person)	*
data.labels[][chat][ticket][pending_articles][][assigned_person]	integer id (Person)	*
data.labels[][chat][ticket][pending_articles][][ticket]	integer id (Ticket)	*
data.labels[][chat][ticket][pending_articles][][message]	integer id (TicketMessage)	*
data.labels[][chat][ticket][pending_articles][][comment]	string	*
data.labels[][chat][ticket][pending_articles][][date_created]	DateTime	*
data.labels[][chat][ticket][summary]	object (TicketSummary)	*
data.labels[][chat][ticket][summary][id]	integer	*
data.labels[][chat][ticket][summary][ticket]	object (Ticket)	*
data.labels[][chat][ticket][summary][summary]	string	*
data.labels[][chat][ticket][summary][summary_input]	string	*
data.labels[][chat][ticket][summary][date_created]	DateTime	*
data.labels[][chat][labels][]	array of objects (LabelChatConversation)	*
data.labels[][chat][subject]	string	*	Subject of the chat conversation.
data.labels[][chat][status]	string	*	Status of the chat conversation.
data.labels[][chat][agent]	object (Person)	*	If this is a user conversation, this is the agent assigned.
data.labels[][chat][agent][emails]		*
data.labels[][chat][agent][labels]		*
data.labels[][chat][agent][teams]		*
data.labels[][chat][agent][primary_team]		*
data.labels[][chat][agent][agentData]		*
data.labels[][chat][agent][publicUsergroups]		*
data.labels[][chat][agent][publicAgentgroups]		*
data.labels[][chat][agent_team]	object (AgentTeam)	*	If this is a team chat, the team it is.
data.labels[][chat][agent_team][id]	integer	*	The unique ID.
data.labels[][chat][agent_team][name]	string	*	The name of agent team.
data.labels[][chat][agent_team][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.labels[][chat][agent_team][members]		*
data.labels[][chat][person]	object (Person)	*	If this is a user conversation, this is the user who started the chat.
data.labels[][chat][session]	object (Session)	*	If this is a user convo, this is the users session.
data.labels[][chat][session][id]	integer	*	The unique ID.
data.labels[][chat][session][auth]	string	*	The authcode for the session to verify an id.
data.labels[][chat][session][interface]	string	*	The Interface the session is for.
data.labels[][chat][session][person]	object (Person)	*
data.labels[][chat][session][user_agent]	string	*	The users user agent string.
data.labels[][chat][session][visitor_id]	string	*
data.labels[][chat][session][ip_address]	string	*	The users IP address.
data.labels[][chat][session][data]	string	*
data.labels[][chat][session][is_person]	boolean	*
data.labels[][chat][session][is_bot]	boolean	*
data.labels[][chat][session][is_helpdesk]	boolean	*
data.labels[][chat][session][active_status]	string	*	(Agents) Status (available or away).
data.labels[][chat][session][is_chat_available]	boolean	*	(Agents) Wehn status is available, if they are available for chat.
data.labels[][chat][session][date_created]	DateTime	*
data.labels[][chat][session][date_last]	DateTime	*
data.labels[][chat][session][date_last_page]	DateTime	*
data.labels[][chat][visitor_id]	string	*
data.labels[][chat][person_name]	string	*	User chat: The users name, if they arent a person.
data.labels[][chat][person_email]	string	*	User chat: The users email, if they aren`t a person.
data.labels[][chat][participants][]	array of objects (Person)	*
data.labels[][chat][messages][]	array of objects (ChatMessage)	*
data.labels[][chat][messages][][id]	integer	*	The unique ID.
data.labels[][chat][messages][][author_id]	integer	*	Author id (legacy).
data.labels[][chat][messages][][author_type]	string	*	Author type (legacy).
data.labels[][chat][messages][][conversation_id]	integer	*	Conversation id (legacy).
data.labels[][chat][messages][][author]	integer id (Person)	*	Person who created the message.
data.labels[][chat][messages][][content]	string	*	The message.
data.labels[][chat][messages][][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.labels[][chat][messages][][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.labels[][chat][messages][][is_html]	boolean	*	Is the content an HTML message?
data.labels[][chat][messages][][metadata]	array	*	Additional data.
data.labels[][chat][messages][][date_created]	DateTime	*	Date message was created.
data.labels[][chat][messages][][date_received]	DateTime	*	Date message was received.
data.labels[][chat][custom_data][]	array of objects (CustomDataChat)	*
data.labels[][chat][custom_data][][conversation]	object (ChatConversation)	*	The conversation the message belongs to.
data.labels[][chat][custom_data][][field]	object (CustomDefChat)	*
data.labels[][chat][custom_data][][field][parent]	object (CustomDefChat)	*
data.labels[][chat][custom_data][][field][children][]	array of objects (CustomDefChat)	*	Field children.
data.labels[][chat][custom_data][][field][title]		*
data.labels[][chat][custom_data][][root_field]	object (CustomDefChat)	*
data.labels[][chat][rating_response_time]	integer	*
data.labels[][chat][rating_overall]	integer	*
data.labels[][chat][rating_comment]	string	*
data.labels[][chat][is_agent]	boolean	*	Is this an agent chat.
data.labels[][chat][is_window]	boolean	*	If the chat is popped out into a window. This is used to make sure the JS widget on pages doesn't load again.
data.labels[][chat][date_created]	DateTime	*	Date when chat was started.
data.labels[][chat][date_user_waiting]	DateTime	*	Since when the user has started waiting (i.e., time the assignment was 0).
data.labels[][chat][date_assigned]	DateTime	*
data.labels[][chat][date_agent_typing]	DateTime	*	Date when agent typed last time.
data.labels[][chat][date_first_agent_message]	DateTime	*
data.labels[][chat][date_ended]	DateTime	*	Date when chat was ended.
data.labels[][chat][total_to_ended]	integer	*
data.labels[][chat][ended_by]	string	*	Who ended the chat.
data.labels[][chat][should_send_transcript]	boolean	*	True if transcript should be send.
data.labels[][chat][date_transcript_sent]	DateTime	*	Date when transcript was sent.
data.labels[][chat][email_validation_code]	string	*
data.labels[][chat][email_validated]	boolean	*
data.labels[][chat][access_token]	string	*
data.labels[][label]		*
data.ended_by	string	*	Who ended the chat.
data.id	integer	*	The unique id of chat conversation.
data.brand	object (Brand)	*	Department which chat was assigned.
data.brand[id]	integer	*	The unique ID.
data.brand[name]	string	*	The brand name.
data.brand[slug]	string	*
data.brand[url]	string	*	The brand url.
data.brand[theme_set]	object (ThemeSet)	*
data.brand[theme_set][id]	integer	*
data.brand[theme_set][theme_id]	string	*
data.brand[theme_set][title]	string	*
data.brand[theme_set][options]		*
data.brand[edit_theme_set]	object (ThemeSet)	*
data.brand[departments][]	array of objects (Department)	*
data.brand[theme_sets][]	array of objects (ThemeSet)	*
data.task_id	integer	*
data.ticket	object (Ticket)	*
data.ticket[id]	integer	*
data.ticket[ref]	string	*
data.ticket[auth]	string	*
data.ticket[parent_ticket]	object (Ticket)	*	Parent ticket.
data.ticket[children_tickets][]	array of objects (Ticket)	*
data.ticket[language]	object (Language)	*	The language the ticket is in.
data.ticket[language][id]	integer	*	The unique ID.
data.ticket[language][sys_name]	string	*	The unique sys name assigned to the language.
data.ticket[language][title]	string	*	Title of the language.
data.ticket[language][title_local]	string	*	Title of the language.
data.ticket[language][base_filepath]	string	*	The base filepath for default phrases for this lang.
data.ticket[language][locale]	string	*	The locale code.
data.ticket[language][flag_image]	string	*	String path to image.
data.ticket[language][is_rtl]	boolean	*	True if this is a right-to-left language.
data.ticket[language][has_user]	boolean	*	True if has user.
data.ticket[language][has_agent]	boolean	*	True if has agent.
data.ticket[language][has_admin]	boolean	*	True if has admin.
data.ticket[language][plural_categories][]	array of strings	*
data.ticket[language][plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data.ticket[language][flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`
data.ticket[brand]	object (Brand)	*
data.ticket[department]	object (Department)	*
data.ticket[category]	object (TicketCategory)	*
data.ticket[category][id]	integer	*	The unique ID.
data.ticket[category][parent]	integer id (TicketCategory)	*	This category parent.
data.ticket[category][title]	string	*	Category title.
data.ticket[category][display_order]	integer	*	Obviously it's display order for lists.
data.ticket[priority]	object (TicketPriority)	*
data.ticket[priority][id]	integer	*	The unique ID.
data.ticket[priority][title]	string	*	Priority title.
data.ticket[priority][priority]	integer	*	The priority itself.
data.ticket[workflow]	object (TicketWorkflow)	*
data.ticket[workflow][id]	integer	*	The unique ID.
data.ticket[workflow][title]	string	*	Workflow title.
data.ticket[workflow][display_order]	integer	*	Workflow display order.
data.ticket[product]	object (Product)	*
data.ticket[product][parent]	integer id (Product)	*	Parent of the product.
data.ticket[product][title]		*
data.ticket[person]	object (Person)	*
data.ticket[person_email]	object (PersonEmail)	*
data.ticket[person_email][id]	integer	*	The unique ID.
data.ticket[person_email][person]	integer id (Person)	*	Person owner of email.
data.ticket[person_email][email]	string	*	The email address.
data.ticket[person_email][email_domain]	string	*	The email address domain.
data.ticket[person_email][is_validated]	boolean	*	True if validation passed.
data.ticket[person_email][date_created]	DateTime	*	The original time the email was created.
data.ticket[agent]	object (Person)	*
data.ticket[agent_team]	object (AgentTeam)	*
data.ticket[agent_team][id]	integer	*	The unique ID.
data.ticket[agent_team][name]	string	*	The name of agent team.
data.ticket[agent_team][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.ticket[agent_team][members]		*
data.ticket[organization]	object (Organization)	*
data.ticket[organization][id]	integer	*	The unique ID.
data.ticket[organization][picture_blob]	object (Blob)	*	The org picture.
data.ticket[organization][picture_blob][sys_name]	string	*	A unique system name for the blob.
data.ticket[organization][picture_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[organization][picture_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[organization][picture_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[organization][picture_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[organization][picture_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[organization][picture_blob][file_url]	string	*	The HTTP link to download the file.
data.ticket[organization][picture_blob][authcode]	string	*
data.ticket[organization][picture_blob][blob_hash]	string	*
data.ticket[organization][picture_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[organization][picture_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[organization][picture_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[organization][picture_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[organization][picture_blob][date_created]	DateTime	*
data.ticket[organization][picture_blob][is_temp]	boolean	*
data.ticket[organization][picture_blob][source_ref]	string	*
data.ticket[organization][picture_blob][labels][]	array of objects (LabelBlob)	*
data.ticket[organization][picture_blob][labels][][blob]	object (Blob)	*
data.ticket[organization][icon_property]	object (IconProperty)	*
data.ticket[organization][icon_property][urn]	string	*
data.ticket[organization][icon_property][options]	array	*
data.ticket[organization][name]	string	*	The organization name.
data.ticket[organization][summary]	string	*	The summary field as filled in by agents.
data.ticket[organization][importance]	integer	*	The org importance.
data.ticket[organization][custom_data][]	array of objects (CustomDataOrganization)	*
data.ticket[organization][custom_data][][organization]	object (Organization)	*
data.ticket[organization][custom_data][][field]	object (CustomDefOrganization)	*
data.ticket[organization][custom_data][][field][parent]	object (CustomDefOrganization)	*	Field`s parent.
data.ticket[organization][custom_data][][field][children][]	array of objects (CustomDefOrganization)	*	Field children.
data.ticket[organization][custom_data][][field][title]		*
data.ticket[organization][custom_data][][root_field]	object (CustomDefOrganization)	*
data.ticket[organization][usergroups][]	array of objects (Usergroup)	*	Usergroups the user belongs to.
data.ticket[organization][usergroups][][id]	integer	*	The unique ID, DB-generated.
data.ticket[organization][usergroups][][title]	string	*	Title of the usergroup.
data.ticket[organization][usergroups][][note]	string	*	A note or description about the usergroup.
data.ticket[organization][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.ticket[organization][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.ticket[organization][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.ticket[organization][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.ticket[organization][usergroups][][permissions][][id]	integer	*	The unique ID.
data.ticket[organization][usergroups][][permissions][][name]	string	*	The name of the permission.
data.ticket[organization][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.ticket[organization][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.ticket[organization][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.ticket[organization][usergroups][][department_permissions][][department]	integer id (Department)	*
data.ticket[organization][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.ticket[organization][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.ticket[organization][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.ticket[organization][usergroups][][department_permissions][][is_active]	boolean	*
data.ticket[organization][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.ticket[organization][auto_cc_people][]	array of objects (Person)	*	Users who are set to automatically be added to tickets and other org things.
data.ticket[organization][labels][]	array of objects (LabelOrganization)	*
data.ticket[organization][labels][][organization]	object (Organization)	*
data.ticket[organization][contact_data][]	array of objects (OrganizationContactData)	*
data.ticket[organization][contact_data][][organization]		*
data.ticket[organization][contact_data][][contact_type]		*
data.ticket[organization][contact_data][][comment]		*
data.ticket[organization][contact_data][][field_1]		*
data.ticket[organization][contact_data][][field_2]		*
data.ticket[organization][contact_data][][field_3]		*
data.ticket[organization][contact_data][][field_5]		*
data.ticket[organization][contact_data][][field_9]		*
data.ticket[organization][emails][]	array of objects (OrganizationEmail)	*
data.ticket[organization][emails][][id]	integer	*	The unique log id.
data.ticket[organization][emails][][organization]	object (Organization)	*
data.ticket[organization][emails][][email]	string	*
data.ticket[organization][emails][][date_created]	DateTime	*
data.ticket[organization][email_domains][]	array of objects (OrganizationEmailDomain)	*
data.ticket[organization][email_domains][][domain]	string	*	The email domain.
data.ticket[organization][email_domains][][organization]	object (Organization)	*	The users organization.
data.ticket[organization][date_created]	DateTime	*	The date the org was inserted into the system.
data.ticket[organization][members][]	array of objects (Person)	*
data.ticket[organization][parent]	object (Organization)	*
data.ticket[organization][children][]	array of objects (Organization)	*
data.ticket[organization][tickets][]	array of objects (Ticket)	*
data.ticket[organization][organization_members][]	array of objects (OrganizationMember)	*
data.ticket[organization][organization_members][][id]	integer	*
data.ticket[organization][organization_members][][person]	integer id (Person)	*
data.ticket[organization][organization_members][][organization]	integer id (Organization)	*
data.ticket[organization][organization_members][][is_manager]	boolean	*
data.ticket[organization][organization_members][][position]	string	*
data.ticket[organization][organization_members][][created_at]	DateTime	*
data.ticket[organization][organization_members][][updated_at]	DateTime	*
data.ticket[organization][publicUsergroups]		*
data.ticket[linked_chat]	object (ChatConversation)	*
data.ticket[linked_chat][id]	integer	*	The unique id of chat conversation.
data.ticket[linked_chat][department]	object (Department)	*	Department which chat was assigned.
data.ticket[linked_chat][brand]	object (Brand)	*	Department which chat was assigned.
data.ticket[linked_chat][task_id]	integer	*
data.ticket[linked_chat][ticket]	object (Ticket)	*
data.ticket[linked_chat][labels][]	array of objects (LabelChatConversation)	*
data.ticket[linked_chat][labels][][chat]	object (ChatConversation)	*
data.ticket[linked_chat][subject]	string	*	Subject of the chat conversation.
data.ticket[linked_chat][status]	string	*	Status of the chat conversation.
data.ticket[linked_chat][agent]	object (Person)	*	If this is a user conversation, this is the agent assigned.
data.ticket[linked_chat][agent_team]	object (AgentTeam)	*	If this is a team chat, the team it is.
data.ticket[linked_chat][person]	object (Person)	*	If this is a user conversation, this is the user who started the chat.
data.ticket[linked_chat][session]	object (Session)	*	If this is a user convo, this is the users session.
data.ticket[linked_chat][session][id]	integer	*	The unique ID.
data.ticket[linked_chat][session][auth]	string	*	The authcode for the session to verify an id.
data.ticket[linked_chat][session][interface]	string	*	The Interface the session is for.
data.ticket[linked_chat][session][person]	object (Person)	*
data.ticket[linked_chat][session][user_agent]	string	*	The users user agent string.
data.ticket[linked_chat][session][visitor_id]	string	*
data.ticket[linked_chat][session][ip_address]	string	*	The users IP address.
data.ticket[linked_chat][session][data]	string	*
data.ticket[linked_chat][session][is_person]	boolean	*
data.ticket[linked_chat][session][is_bot]	boolean	*
data.ticket[linked_chat][session][is_helpdesk]	boolean	*
data.ticket[linked_chat][session][active_status]	string	*	(Agents) Status (available or away).
data.ticket[linked_chat][session][is_chat_available]	boolean	*	(Agents) Wehn status is available, if they are available for chat.
data.ticket[linked_chat][session][date_created]	DateTime	*
data.ticket[linked_chat][session][date_last]	DateTime	*
data.ticket[linked_chat][session][date_last_page]	DateTime	*
data.ticket[linked_chat][visitor_id]	string	*
data.ticket[linked_chat][person_name]	string	*	User chat: The users name, if they arent a person.
data.ticket[linked_chat][person_email]	string	*	User chat: The users email, if they aren`t a person.
data.ticket[linked_chat][participants][]	array of objects (Person)	*
data.ticket[linked_chat][messages][]	array of objects (ChatMessage)	*
data.ticket[linked_chat][messages][][id]	integer	*	The unique ID.
data.ticket[linked_chat][messages][][author_id]	integer	*	Author id (legacy).
data.ticket[linked_chat][messages][][author_type]	string	*	Author type (legacy).
data.ticket[linked_chat][messages][][conversation_id]	integer	*	Conversation id (legacy).
data.ticket[linked_chat][messages][][author]	integer id (Person)	*	Person who created the message.
data.ticket[linked_chat][messages][][content]	string	*	The message.
data.ticket[linked_chat][messages][][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.ticket[linked_chat][messages][][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.ticket[linked_chat][messages][][is_html]	boolean	*	Is the content an HTML message?
data.ticket[linked_chat][messages][][metadata]	array	*	Additional data.
data.ticket[linked_chat][messages][][date_created]	DateTime	*	Date message was created.
data.ticket[linked_chat][messages][][date_received]	DateTime	*	Date message was received.
data.ticket[linked_chat][custom_data][]	array of objects (CustomDataChat)	*
data.ticket[linked_chat][custom_data][][conversation]	object (ChatConversation)	*	The conversation the message belongs to.
data.ticket[linked_chat][custom_data][][field]	object (CustomDefChat)	*
data.ticket[linked_chat][custom_data][][field][parent]	object (CustomDefChat)	*
data.ticket[linked_chat][custom_data][][field][children][]	array of objects (CustomDefChat)	*	Field children.
data.ticket[linked_chat][custom_data][][field][title]		*
data.ticket[linked_chat][custom_data][][root_field]	object (CustomDefChat)	*
data.ticket[linked_chat][rating_response_time]	integer	*
data.ticket[linked_chat][rating_overall]	integer	*
data.ticket[linked_chat][rating_comment]	string	*
data.ticket[linked_chat][is_agent]	boolean	*	Is this an agent chat.
data.ticket[linked_chat][is_window]	boolean	*	If the chat is popped out into a window. This is used to make sure the JS widget on pages doesn't load again.
data.ticket[linked_chat][date_created]	DateTime	*	Date when chat was started.
data.ticket[linked_chat][date_user_waiting]	DateTime	*	Since when the user has started waiting (i.e., time the assignment was 0).
data.ticket[linked_chat][date_assigned]	DateTime	*
data.ticket[linked_chat][date_agent_typing]	DateTime	*	Date when agent typed last time.
data.ticket[linked_chat][date_first_agent_message]	DateTime	*
data.ticket[linked_chat][date_ended]	DateTime	*	Date when chat was ended.
data.ticket[linked_chat][total_to_ended]	integer	*
data.ticket[linked_chat][ended_by]	string	*	Who ended the chat.
data.ticket[linked_chat][should_send_transcript]	boolean	*	True if transcript should be send.
data.ticket[linked_chat][date_transcript_sent]	DateTime	*	Date when transcript was sent.
data.ticket[linked_chat][email_validation_code]	string	*
data.ticket[linked_chat][email_validated]	boolean	*
data.ticket[linked_chat][access_token]	string	*
data.ticket[attachments][]	array of objects (TicketAttachment)	*
data.ticket[attachments][][id]	integer	*	The unique ID.
data.ticket[attachments][][ticket]	integer id (Ticket)	*	Ticket this attachment belongs to.
data.ticket[attachments][][person]	integer id (Person)	*	Who created the attachment.
data.ticket[attachments][][blob]	object (Blob)	*	Actual attachment.
data.ticket[attachments][][blob][sys_name]	string	*	A unique system name for the blob.
data.ticket[attachments][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[attachments][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[attachments][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[attachments][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[attachments][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[attachments][][blob][file_url]	string	*	The HTTP link to download the file.
data.ticket[attachments][][blob][authcode]	string	*
data.ticket[attachments][][blob][blob_hash]	string	*
data.ticket[attachments][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[attachments][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[attachments][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[attachments][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[attachments][][blob][date_created]	DateTime	*
data.ticket[attachments][][blob][is_temp]	boolean	*
data.ticket[attachments][][blob][source_ref]	string	*
data.ticket[attachments][][blob][labels][]	array of objects (LabelBlob)	*
data.ticket[attachments][][blob][labels][][blob]	object (Blob)	*
data.ticket[attachments][][message]	integer id (TicketMessage)	*	Message - holder of this attachment.
data.ticket[attachments][][is_agent_note]	boolean	*	True if this attachmen just a note.
data.ticket[attachments][][is_inline]	boolean	*	Is this attachment is embed in message.
data.ticket[access_codes][]	array of objects (TicketAccessCode)	*
data.ticket[access_codes][][id]	integer	*
data.ticket[access_codes][][ticket]	object (Ticket)	*
data.ticket[access_codes][][person]	object (Person)	*
data.ticket[access_codes][][auth]	string	*
data.ticket[messages][]	array of objects (TicketMessage)	*
data.ticket[messages][][id]	integer	*	The unique id of message.
data.ticket[messages][][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data.ticket[messages][][person]	object (Person)	*	Person this message was sent by.
data.ticket[messages][][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data.ticket[messages][][email_source][id]	integer	*
data.ticket[messages][][email_source][uuid]	string	*
data.ticket[messages][][email_source][blob]	object (Blob)	*
data.ticket[messages][][email_source][blob][sys_name]	string	*	A unique system name for the blob.
data.ticket[messages][][email_source][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[messages][][email_source][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[messages][][email_source][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[messages][][email_source][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[messages][][email_source][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[messages][][email_source][blob][file_url]	string	*	The HTTP link to download the file.
data.ticket[messages][][email_source][blob][authcode]	string	*
data.ticket[messages][][email_source][blob][blob_hash]	string	*
data.ticket[messages][][email_source][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[messages][][email_source][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[messages][][email_source][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[messages][][email_source][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[messages][][email_source][blob][date_created]	DateTime	*
data.ticket[messages][][email_source][blob][is_temp]	boolean	*
data.ticket[messages][][email_source][blob][source_ref]	string	*
data.ticket[messages][][email_source][blob][labels][]	array of objects (LabelBlob)	*
data.ticket[messages][][email_source][blob][labels][][blob]	object (Blob)	*
data.ticket[messages][][email_source][object_type]	string	*	The type of object this is attached to (should be the table name of the super type, eg: tickets, people, organizations). This typically is not set until after the email is processed (ie the status is 'processed').
data.ticket[messages][][email_source][object_id]	integer	*	The ID of the object this is attached to.
data.ticket[messages][][email_source][from_email]	string	*
data.ticket[messages][][email_source][status]	string	*	The current status of the message: - inserted: Only inserted - processing: Currently processing - complete: Fully processed - error: Tried to process but there was some kind of error (see error_code).
data.ticket[messages][][email_source][date_status]	DateTime	*
data.ticket[messages][][email_source][error_code]	string	*	When status is error, this is the code that describes the error.
data.ticket[messages][][email_source][date_created]	DateTime	*
data.ticket[messages][][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.ticket[messages][][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.ticket[messages][][snippet_use_logs][][id]	integer	*	The unique ID.
data.ticket[messages][][snippet_use_logs][][snippet]	object (SnippetV2)	*	Snippet used.
data.ticket[messages][][snippet_use_logs][][snippet][id]	integer	*
data.ticket[messages][][snippet_use_logs][][snippet][title]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][author]	object (Person)	*
data.ticket[messages][][snippet_use_logs][][snippet][is_private]	boolean	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar]	object (Blob)	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][sys_name]	string	*	A unique system name for the blob.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][file_url]	string	*	The HTTP link to download the file.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][authcode]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][blob_hash]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][date_created]	DateTime	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][is_temp]	boolean	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][source_ref]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][labels][]	array of objects (LabelBlob)	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][labels][][blob]	object (Blob)	*
data.ticket[messages][][snippet_use_logs][][snippet][status]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][shortcut_codes]	array	*
data.ticket[messages][][snippet_use_logs][][snippet][inline_translations]	array	*
data.ticket[messages][][snippet_use_logs][][snippet][translations][]	array of objects (SnippetV2Translation)	*
data.ticket[messages][][snippet_use_logs][][snippet][translations][][id]	integer	*	The unique ID.
data.ticket[messages][][snippet_use_logs][][snippet][translations][][snippet]	object (SnippetV2)	*	Snippet translated.
data.ticket[messages][][snippet_use_logs][][snippet][translations][][language]	object (Language)	*
data.ticket[messages][][snippet_use_logs][][snippet][translations][][content]	array	*	Snippet content.
data.ticket[messages][][snippet_use_logs][][snippet][translations][][blobs][]	array of objects (Blob)	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][]	array of objects (SnippetV2Category)	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][id]	integer	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][title]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][is_global]	boolean	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][display_order]	integer	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][parent]	object (SnippetV2Category)	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][agent_teams][]	array of objects (AgentTeam)	*
data.ticket[messages][][snippet_use_logs][][snippet][display_order]	integer	*
data.ticket[messages][][snippet_use_logs][][snippet][date_created]	DateTime	*
data.ticket[messages][][snippet_use_logs][][ticket_message]	object (TicketMessage)	*	Ticket Message where the snippet was used.
data.ticket[messages][][snippet_use_logs][][chat_message]	object (ChatMessage)	*	Chat Message where the snippet was used.
data.ticket[messages][][snippet_use_logs][][chat_message][id]	integer	*	The unique ID.
data.ticket[messages][][snippet_use_logs][][chat_message][author_id]	integer	*	Author id (legacy).
data.ticket[messages][][snippet_use_logs][][chat_message][author_type]	string	*	Author type (legacy).
data.ticket[messages][][snippet_use_logs][][chat_message][conversation_id]	integer	*	Conversation id (legacy).
data.ticket[messages][][snippet_use_logs][][chat_message][author]	integer id (Person)	*	Person who created the message.
data.ticket[messages][][snippet_use_logs][][chat_message][content]	string	*	The message.
data.ticket[messages][][snippet_use_logs][][chat_message][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.ticket[messages][][snippet_use_logs][][chat_message][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.ticket[messages][][snippet_use_logs][][chat_message][is_html]	boolean	*	Is the content an HTML message?
data.ticket[messages][][snippet_use_logs][][chat_message][metadata]	array	*	Additional data.
data.ticket[messages][][snippet_use_logs][][chat_message][date_created]	DateTime	*	Date message was created.
data.ticket[messages][][snippet_use_logs][][chat_message][date_received]	DateTime	*	Date message was received.
data.ticket[messages][][snippet_use_logs][][language]	object (Language)	*	Snippet translated.
data.ticket[messages][][snippet_use_logs][][person]	object (Person)	*
data.ticket[messages][][snippet_use_logs][][rating]	integer	*
data.ticket[messages][][snippet_use_logs][][rating_person]	object (Person)	*
data.ticket[messages][][snippet_use_logs][][rating_message]	string	*
data.ticket[messages][][snippet_use_logs][][date_created]	DateTime	*
data.ticket[messages][][date_created]	DateTime	*	Date when message was created.
data.ticket[messages][][is_agent_note]	boolean	*	Is this message agent note?
data.ticket[messages][][is_hidden]	boolean	*	Is this message hidden?
data.ticket[messages][][creation_system]	string	*	How this message was created.
data.ticket[messages][][ip_address]	string	*	An ip address from which message was sent.
data.ticket[messages][][visitor_id]	string	*	Unique ID of visitor left this message.
data.ticket[messages][][hostname]	string	*	Host from which message was left.
data.ticket[messages][][geo_country]	string	*	Country message is from (deprecated).
data.ticket[messages][][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.ticket[messages][][message_hash]	string	*	An unique hash of message.
data.ticket[messages][][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.ticket[messages][][primary_translation][id]	integer	*
data.ticket[messages][][primary_translation][ticket]	object (Ticket)	*
data.ticket[messages][][primary_translation][ticket_message]	object (TicketMessage)	*
data.ticket[messages][][primary_translation][from_lang_code]	string	*
data.ticket[messages][][primary_translation][lang_code]	string	*
data.ticket[messages][][primary_translation][message]	string	*
data.ticket[messages][][primary_translation][date_created]	DateTime	*
data.ticket[messages][][message]	string	*	The message, will be in HTML!
data.ticket[messages][][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.ticket[messages][][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.ticket[messages][][message_source]	string	*	The message source.
data.ticket[messages][][message_source_type]	string	*	The message source type.
data.ticket[messages][][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.ticket[messages][][lang_code]	string	*	The set/detected lang code.
data.ticket[messages][][email_message_id][]	array of objects (TicketMessageEmailId)	*
data.ticket[messages][][email_message_id][][id]	integer	*
data.ticket[messages][][email_message_id][][message]	object (TicketMessage)	*
data.ticket[messages][][email_message_id][][email_id]	string	*
data.ticket[messages][][ticket_feedback][]	array of objects (TicketFeedback)	*
data.ticket[messages][][ticket_feedback][][id]	integer	*
data.ticket[messages][][ticket_feedback][][ticket]	object (Ticket)	*
data.ticket[messages][][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data.ticket[messages][][ticket_feedback][][person]	object (Person)	*
data.ticket[messages][][ticket_feedback][][rating]	integer	*
data.ticket[messages][][ticket_feedback][][message]	string	*
data.ticket[messages][][ticket_feedback][][date_created]	DateTime	*
data.ticket[messages][][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data.ticket[messages][][ticket_message_forwards][][id]	integer	*
data.ticket[messages][][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data.ticket[messages][][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data.ticket[messages][][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data.ticket[messages][][ticket_message_forwards][][subject]	string	*
data.ticket[messages][][ticket_message_forwards][][from_email]	string	*
data.ticket[messages][][ticket_message_forwards][][tos]	array	*
data.ticket[messages][][ticket_message_forwards][][ccs]	array	*
data.ticket[messages][][ticket_message_forwards][][bccs]	array	*
data.ticket[messages][][ticket_message_forwards][][message]	string	*
data.ticket[messages][][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data.ticket[messages][][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data.ticket[messages][][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[messages][][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[messages][][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[messages][][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[messages][][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[messages][][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data.ticket[messages][][ticket_message_forwards][][blobs][][authcode]	string	*
data.ticket[messages][][ticket_message_forwards][][blobs][][blob_hash]	string	*
data.ticket[messages][][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[messages][][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[messages][][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[messages][][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[messages][][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data.ticket[messages][][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data.ticket[messages][][ticket_message_forwards][][blobs][][source_ref]	string	*
data.ticket[messages][][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data.ticket[messages][][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data.ticket[messages][][ticket_message_forwards][][date_created]	DateTime	*
data.ticket[messages][][channel_message]	object (TicketMessageChannelMessage)	*
data.ticket[messages][][channel_message][id]	integer	*	@var int The unique id of message.
data.ticket[messages][][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data.ticket[messages][][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data.ticket[messages][][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data.ticket[messages][][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data.ticket[messages][][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data.ticket[messages][][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data.ticket[messages][][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data.ticket[messages][][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data.ticket[messages][][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data.ticket[sms_messages][]	array of objects (TicketSms)	*
data.ticket[sms_messages][][id]	integer	*
data.ticket[sms_messages][][ticket]	object (Ticket)	*
data.ticket[sms_messages][][person]	object (Person)	*
data.ticket[sms_messages][][sms_account]	object (SmsAccount)	*
data.ticket[sms_messages][][sms_account][id]	integer	*	The unique ID.
data.ticket[sms_messages][][sms_account][type]	string	*
data.ticket[sms_messages][][sms_account][params]	array	*
data.ticket[sms_messages][][sms_account][identifier]	string	*
data.ticket[sms_messages][][sms_account][is_enabled]	boolean	*
data.ticket[sms_messages][][sms_account][is_connected]	boolean	*
data.ticket[sms_messages][][sms_account][is_tested]	boolean	*
data.ticket[sms_messages][][sms_account][test_code]	string	*
data.ticket[sms_messages][][job]	object (Job)	*
data.ticket[sms_messages][][job][id]	integer	*	The unique job id.
data.ticket[sms_messages][][job][type]	string	*	The job type, used by the Job Router to find the right Job Processor.
data.ticket[sms_messages][][job][status]	string	*	The status of the job.
data.ticket[sms_messages][][job][status_code]	string	*	Any code to further classify the status.
data.ticket[sms_messages][][job][date_touch]	DateTime	*	Date the last time a process "touched" this ticket.
data.ticket[sms_messages][][job][date_created]	DateTime	*	Date this job entered the "jobs" table.
data.ticket[sms_messages][][job][date_last_try]	DateTime	*	Last time we processed this job.
data.ticket[sms_messages][][job][date_next_try]	DateTime	*	If this DateTime is in the future, it won't be selected for execution.
data.ticket[sms_messages][][job][num_tries]	integer	*	The number of times this job has been executed Job Processor (usually indicated failures if > 1).
data.ticket[sms_messages][][job][log_summary]	string	*	A human readable summary of the job's execution.
data.ticket[sms_messages][][job][log]	string	*	A more verbose log.
data.ticket[sms_messages][][job][data]	array	*	An array of data, or payload, that the job processor needs to execute this job (stored in the db as json). This MUST always be an array, even if its an empty array
data.ticket[sms_messages][][job][original_job]	integer	*	Null unless the job was created as a retry - if so, the originating job ID is stored here so we can query it later. Note: You MUST specify the originating job, do not create a linked list of failed jobs.
data.ticket[sms_messages][][date_created]	DateTime	*
data.ticket[sms_messages][][from_number]	string	*	Permanent record of the phone number that sent this SMS. (Won't change even if Person changes their phone number).
data.ticket[sms_messages][][to_number]	string	*	Permanent record of the phone number that this SMS was sent to.
data.ticket[sms_messages][][message]	string	*	The SMS message.
data.ticket[sms_messages][][direction]	string	*	Just a system flag for reporting.
data.ticket[topic_links][]	array of objects (TicketCommunityTopicLink)	*
data.ticket[topic_links][][id]	integer	*	The unique filter ID.
data.ticket[topic_links][][ticket]	integer id (Ticket)	*
data.ticket[topic_links][][topic]	integer id (CommunityTopic)	*
data.ticket[topic_links][][person]	integer id (Person)	*
data.ticket[topic_links][][date_created]	DateTime	*
data.ticket[custom_data][]	array of objects (CustomDataTicket)	*
data.ticket[custom_data][][ticket]	object (Ticket)	*
data.ticket[custom_data][][field]	object (CustomDefTicket)	*
data.ticket[custom_data][][field][parent]	object (CustomDefTicket)	*
data.ticket[custom_data][][field][children][]	array of objects (CustomDefTicket)	*	Field children.
data.ticket[custom_data][][field][title]		*
data.ticket[custom_data][][root_field]	object (CustomDefTicket)	*
data.ticket[labels][]	array of objects (LabelTicket)	*
data.ticket[labels][][ticket]	object (Ticket)	*
data.ticket[sent_to_address]	string	*	The email address the ticket was sent to if it came in via a gateway. This is a full string (e.g., including CC's) of the original.
data.ticket[email_account]	object (EmailAccount)	*	The gateway this ticket originated from.
data.ticket[email_account][id]	integer	*
data.ticket[email_account][account_type]	string	*
data.ticket[email_account][is_enabled]	boolean	*
data.ticket[email_account][address]	string	*
data.ticket[email_account][cert_blob]	object (Blob)	*
data.ticket[email_account][cert_blob][sys_name]	string	*	A unique system name for the blob.
data.ticket[email_account][cert_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[email_account][cert_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[email_account][cert_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[email_account][cert_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[email_account][cert_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[email_account][cert_blob][file_url]	string	*	The HTTP link to download the file.
data.ticket[email_account][cert_blob][authcode]	string	*
data.ticket[email_account][cert_blob][blob_hash]	string	*
data.ticket[email_account][cert_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[email_account][cert_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[email_account][cert_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[email_account][cert_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[email_account][cert_blob][date_created]	DateTime	*
data.ticket[email_account][cert_blob][is_temp]	boolean	*
data.ticket[email_account][cert_blob][source_ref]	string	*
data.ticket[email_account][cert_blob][labels][]	array of objects (LabelBlob)	*
data.ticket[email_account][cert_blob][labels][][blob]	object (Blob)	*
data.ticket[email_account][key_blob]	object (Blob)	*
data.ticket[email_account_address]	string	*	The email address (from list of to/cc) that matched with the email account.
data.ticket[creation_system]	string	*
data.ticket[creation_system_option]	string	*	Optional information about the creation system. For example, source URL the ticket came from.
data.ticket[ticket_hash]	string	*
data.ticket[status]	string	*
data.ticket[ticket_status]	object (TicketStatus)	*
data.ticket[ticket_status][id]	integer	*
data.ticket[ticket_status][status_type]	string	*
data.ticket[ticket_status][status_code]	string	*
data.ticket[ticket_status][sys_id]	string	*
data.ticket[ticket_status][title]	string	*
data.ticket[ticket_status][display_order]	integer	*
data.ticket[ticket_status][pending_waiting_time_mode]	string	*	Where to count time spending in pending status. Check PENDING_WAITING_TIME_MODE_ constants
data.ticket[ticket_status][children][]	array of objects (TicketStatus)	*
data.ticket[ticket_status][options]	array	*
data.ticket[ticket_status][statusType]		*
data.ticket[ticket_status][displayOrder]	integer	*
data.ticket[urgency]	integer	*
data.ticket[feedback_rating]	integer	*
data.ticket[date_feedback_rating]	DateTime	*
data.ticket[date_created]	DateTime	*
data.ticket[date_resolved]	DateTime	*
data.ticket[date_archived]	DateTime	*
data.ticket[date_first_agent_assign]	DateTime	*
data.ticket[date_first_agent_reply]	DateTime	*
data.ticket[date_last_agent_reply]	DateTime	*
data.ticket[date_last_user_reply]	DateTime	*
data.ticket[date_agent_waiting]	DateTime	*
data.ticket[date_user_waiting]	DateTime	*
data.ticket[date_status]	DateTime	*
data.ticket[date_on_hold]	DateTime	*
data.ticket[total_user_waiting]	integer	*
data.ticket[total_to_first_reply]	integer	*
data.ticket[total_user_waiting_wh_start]	DateTime	*
data.ticket[total_user_waiting_wh]	integer	*
data.ticket[total_to_first_reply_wh]	integer	*
data.ticket[locked_by_agent]	object (Person)	*
data.ticket[date_locked]	DateTime	*
data.ticket[has_attachments]	boolean	*
data.ticket[subject]	string	*
data.ticket[original_subject]	string	*
data.ticket[properties]	array	*
data.ticket[count_agent_replies]	integer	*
data.ticket[count_user_replies]	integer	*
data.ticket[worst_sla_status]	string	*
data.ticket[waiting_times]	array	*	Used to track ticket status changes and how much time ticket was in status Add new item every time status changed This is optimisation over TicketLog.
data.ticket[participants][]	array of objects (TicketParticipant)	*
data.ticket[participants][][id]	integer	*
data.ticket[participants][][ticket]	object (Ticket)	*
data.ticket[participants][][person]	object (Person)	*
data.ticket[participants][][access_code]	object (TicketAccessCode)	*
data.ticket[participants][][person_email]	object (PersonEmail)	*
data.ticket[participants][][default_on]	boolean	*	Default checkbox status of the user.
data.ticket[charges][]	array of objects (TicketCharge)	*
data.ticket[charges][][id]	integer	*
data.ticket[charges][][charge_time]	integer	*
data.ticket[charges][][amount]	float	*
data.ticket[charges][][date_created]	DateTime	*
data.ticket[charges][][ticket]	object (Ticket)	*
data.ticket[charges][][person]	object (Person)	*
data.ticket[charges][][organization]	object (Organization)	*
data.ticket[charges][][agent]	object (Person)	*
data.ticket[charges][][custom_data][]	array of objects (CustomDataBilling)	*
data.ticket[charges][][custom_data][][ticket_charge]	object (TicketCharge)	*
data.ticket[charges][][custom_data][][field]	object (CustomDefBilling)	*
data.ticket[charges][][custom_data][][field][parent]	object (CustomDefBilling)	*
data.ticket[charges][][custom_data][][field][children][]	array of objects (CustomDefBilling)	*	Field children.
data.ticket[charges][][custom_data][][field][title]		*
data.ticket[charges][][custom_data][][root_field]	object (CustomDefBilling)	*
data.ticket[ticket_slas][]	array of objects (TicketSla)	*
data.ticket[ticket_slas][][id]	integer	*	The unique ID.
data.ticket[ticket_slas][][sla_status]	string	*	The SLA status.
data.ticket[ticket_slas][][warn_date]	DateTime	*	The SLA warn date.
data.ticket[ticket_slas][][fail_date]	DateTime	*	The SLA fail date.
data.ticket[ticket_slas][][is_completed]	boolean	*	Is the SLA completed?
data.ticket[ticket_slas][][is_completed_set]	boolean	*	Completed by automated action.
data.ticket[ticket_slas][][completed_time_taken]	integer	*	Time taken.
data.ticket[ticket_slas][][ticket]	integer id (Ticket)	*	Ticket.
data.ticket[ticket_slas][][sla]	integer id (Sla)	*	SLA.
data.ticket[ticket_slas][][date_applied]	DateTime	*	time and date when SLA was applied to the ticket.
data.ticket[ticket_slas][][date_completed]	DateTime	*	time when SLA status became OK.
data.ticket[jira_issues][]	array of objects (JiraIssue)	*	linked jira issues.
data.ticket[jira_issues][][id]	integer	*	The unique ID.
data.ticket[jira_issues][][ticket]	object (Ticket)	*	The associated DeskPRO ticket.
data.ticket[jira_issues][][issue_id]	integer	*
data.ticket[jira_issues][][status_id]	integer	*
data.ticket[jira_issues][][created]	DateTime	*	Export time.
data.ticket[problems][]	array of objects (Problem)	*
data.ticket[problems][][id]	integer	*	The unique ID.
data.ticket[problems][][title]	string	*	Problem title.
data.ticket[problems][][creator]	integer id (Person)	*	Person who created the problem.
data.ticket[problems][][created]	DateTime	*	Date when the problem was created.
data.ticket[problems][][is_open]	boolean	*	Is problem still has no solution?
data.ticket[problems][][tickets][]	array of integer ids (Ticket)	*	Tickets associated with problem.
data.ticket[stars][]	array of objects (TicketFlagged)	*
data.ticket[stars][][ticket]	object (Ticket)	*
data.ticket[stars][][person_id]	integer	*
data.ticket[stars][][color]	string	*
data.ticket[follow_ups][]	array of objects (TicketFollowUp)	*
data.ticket[follow_ups][][id]	integer	*	The unique ID.
data.ticket[follow_ups][][person]	integer id (Person)	*
data.ticket[follow_ups][][actions]	array	*
data.ticket[follow_ups][][cancel_if_user_reply]	boolean	*
data.ticket[follow_ups][][cancel_if_agent_reply]	boolean	*
data.ticket[follow_ups][][status]	string	*
data.ticket[follow_ups][][date_created]	DateTime	*
data.ticket[follow_ups][][date_to_run]	DateTime	*
data.ticket[follow_ups][][date_did_run]	DateTime	*
data.ticket[follow_ups][][dateToRun]		*
data.ticket[logs][]	array of objects (TicketLog)	*
data.ticket[logs][][id]	integer	*
data.ticket[logs][][parent]	object (TicketLog)	*
data.ticket[logs][][ticket]	object (Ticket)	*
data.ticket[logs][][person]	object (Person)	*
data.ticket[logs][][action_type]	string	*
data.ticket[logs][][id_object]	integer	*	If the log involves a specific thing in a ticket (eg a message that was moved), then that is this id.
data.ticket[logs][][id_before]	integer	*	The ID of the previous entity changed, or any other numeric value.
data.ticket[logs][][id_after]	integer	*	The ID of the new entity, or any other numeric value.
data.ticket[logs][][trigger_id]	integer	*	If the change was caused by a trigger, the trigger id. Note this is the integer ID (not a FK relation) so the record is kept even if the trigger itself is deleted.
data.ticket[logs][][escalation_id]	integer	*	If the change was caused by an escalation Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.ticket[logs][][macro_id]	integer	*	If the change was caused by an v2 macro Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.ticket[logs][][sla]	object (Sla)	*	If the change was caused by an SLA, the SLA.
data.ticket[logs][][sla][id]	integer	*	The unique ID.
data.ticket[logs][][sla][title]	string	*	SLA title.
data.ticket[logs][][sla][sla_type]	string	*	Type of SLA - first_response, resolution, waiting_time.
data.ticket[logs][][sla][active_time]	string	*	Whether active all the time (all) or during work hours only (work_hours) or use the default ticket-wide settings (default).
data.ticket[logs][][sla][work_start]	integer	*	When the work day starts. This is stored as the number of seconds after 00:00:00.
data.ticket[logs][][sla][work_end]	integer	*	When the work day ends. This is stored as the number of seconds after 00:00:00.
data.ticket[logs][][sla][work_days]	array	*	Array of work days, stored with keys corresponding to day numbers. Values are true. 0 = Sunday, 6 = Saturday (same as PHP, easy to convert to MySQL which is 1 = Sunday, 7 = Saturday).
data.ticket[logs][][sla][work_timezone]	string	*	Timezone for work hours/days to be considered in.
data.ticket[logs][][sla][work_holidays]	array	*	List of work holidays.
data.ticket[logs][][sla][apply_type]	string	*	Controls how the SLA is applied to tickets: all, terms, terms_before_triggers, manual.
data.ticket[logs][][sla][apply_terms]	object (TriggerTerms)	*	Conditions to apply.
data.ticket[logs][][sla][apply_terms][version]	integer	*	Terms version.
data.ticket[logs][][sla][apply_terms][terms]	array	*	Terms themselves.
data.ticket[logs][][sla][trigger_terms]	object (TriggerTerms)	*	Conditions to consider sla completed.
data.ticket[logs][][sla][warn_time]	integer	*	Warn time integer.
data.ticket[logs][][sla][warn_time_unit]	string	*	And it's unit (see warn time).
data.ticket[logs][][sla][warn_actions]	object (TriggerActions)	*	How to warn about SLA will fail.
data.ticket[logs][][sla][warn_actions][version]	integer	*	Actions version.
data.ticket[logs][][sla][warn_actions][actions]	array	*	Actions array representation.
data.ticket[logs][][sla][fail_time]	integer	*	Fail time integer.
data.ticket[logs][][sla][fail_time_unit]	string	*	And it's measuring unit (see fail_time).
data.ticket[logs][][sla][fail_actions]	object (TriggerActions)	*	What to do if SLA failed.
data.ticket[logs][][sla][exclude_ticket_statuses]	array	*	This SLA will not apply while tickets are in these pending statuses.
data.ticket[logs][][sla_status]	string	*
data.ticket[logs][][details]	array	*
data.ticket[logs][][date_created]	DateTime	*
data.ticket[chats][]	array of objects (ChatConversation)	*
data.ticket[created_with_channel]	string	*
data.ticket[last_channel_used]	string	*
data.ticket[channels]	array	*
data.ticket[pending_articles][]	array of objects (ArticlePendingCreate)	*
data.ticket[pending_articles][][id]	integer	*
data.ticket[pending_articles][][person]	integer id (Person)	*
data.ticket[pending_articles][][assigned_person]	integer id (Person)	*
data.ticket[pending_articles][][ticket]	integer id (Ticket)	*
data.ticket[pending_articles][][message]	integer id (TicketMessage)	*
data.ticket[pending_articles][][comment]	string	*
data.ticket[pending_articles][][date_created]	DateTime	*
data.ticket[summary]	object (TicketSummary)	*
data.ticket[summary][id]	integer	*
data.ticket[summary][ticket]	object (Ticket)	*
data.ticket[summary][summary]	string	*
data.ticket[summary][summary_input]	string	*
data.ticket[summary][date_created]	DateTime	*
data.subject	string	*	Subject of the chat conversation.
data.status	string	*	Status of the chat conversation.
data.agent	object (Person)	*	If this is a user conversation, this is the agent assigned.
data.agent[emails]		*
data.agent[labels]		*
data.agent[teams]		*
data.agent[primary_team]		*
data.agent[agentData]		*
data.agent[publicUsergroups]		*
data.agent[publicAgentgroups]		*
data.agent_team	object (AgentTeam)	*	If this is a team chat, the team it is.
data.agent_team[id]	integer	*	The unique ID.
data.agent_team[name]	string	*	The name of agent team.
data.agent_team[avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.agent_team[members]		*
data.person	object (Person)	*	If this is a user conversation, this is the user who started the chat.
data.session	object (Session)	*	If this is a user convo, this is the users session.
data.session[id]	integer	*	The unique ID.
data.session[auth]	string	*	The authcode for the session to verify an id.
data.session[interface]	string	*	The Interface the session is for.
data.session[person]	object (Person)	*
data.session[user_agent]	string	*	The users user agent string.
data.session[visitor_id]	string	*
data.session[ip_address]	string	*	The users IP address.
data.session[data]	string	*
data.session[is_person]	boolean	*
data.session[is_bot]	boolean	*
data.session[is_helpdesk]	boolean	*
data.session[active_status]	string	*	(Agents) Status (available or away).
data.session[is_chat_available]	boolean	*	(Agents) Wehn status is available, if they are available for chat.
data.session[date_created]	DateTime	*
data.session[date_last]	DateTime	*
data.session[date_last_page]	DateTime	*
data.visitor_id	string	*
data.person_name	string	*	User chat: The users name, if they arent a person.
data.person_email	string	*	User chat: The users email, if they aren`t a person.
data.participants[]	array of objects (Person)	*
data.messages[]	array of objects (ChatMessage)	*
data.messages[][id]	integer	*	The unique ID.
data.messages[][author_id]	integer	*	Author id (legacy).
data.messages[][author_type]	string	*	Author type (legacy).
data.messages[][conversation_id]	integer	*	Conversation id (legacy).
data.messages[][author]	integer id (Person)	*	Person who created the message.
data.messages[][content]	string	*	The message.
data.messages[][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.messages[][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.messages[][is_html]	boolean	*	Is the content an HTML message?
data.messages[][metadata]	array	*	Additional data.
data.messages[][date_created]	DateTime	*	Date message was created.
data.messages[][date_received]	DateTime	*	Date message was received.
data.custom_data[]	array of objects (CustomDataChat)	*
data.custom_data[][conversation]	object (ChatConversation)	*	The conversation the message belongs to.
data.custom_data[][conversation][id]	integer	*	The unique id of chat conversation.
data.custom_data[][conversation][department]	object (Department)	*	Department which chat was assigned.
data.custom_data[][conversation][brand]	object (Brand)	*	Department which chat was assigned.
data.custom_data[][conversation][task_id]	integer	*
data.custom_data[][conversation][ticket]	object (Ticket)	*
data.custom_data[][conversation][labels][]	array of objects (LabelChatConversation)	*
data.custom_data[][conversation][subject]	string	*	Subject of the chat conversation.
data.custom_data[][conversation][status]	string	*	Status of the chat conversation.
data.custom_data[][conversation][agent]	object (Person)	*	If this is a user conversation, this is the agent assigned.
data.custom_data[][conversation][agent_team]	object (AgentTeam)	*	If this is a team chat, the team it is.
data.custom_data[][conversation][person]	object (Person)	*	If this is a user conversation, this is the user who started the chat.
data.custom_data[][conversation][session]	object (Session)	*	If this is a user convo, this is the users session.
data.custom_data[][conversation][visitor_id]	string	*
data.custom_data[][conversation][person_name]	string	*	User chat: The users name, if they arent a person.
data.custom_data[][conversation][person_email]	string	*	User chat: The users email, if they aren`t a person.
data.custom_data[][conversation][participants][]	array of objects (Person)	*
data.custom_data[][conversation][messages][]	array of objects (ChatMessage)	*
data.custom_data[][conversation][custom_data][]	array of objects (CustomDataChat)	*
data.custom_data[][conversation][rating_response_time]	integer	*
data.custom_data[][conversation][rating_overall]	integer	*
data.custom_data[][conversation][rating_comment]	string	*
data.custom_data[][conversation][is_agent]	boolean	*	Is this an agent chat.
data.custom_data[][conversation][is_window]	boolean	*	If the chat is popped out into a window. This is used to make sure the JS widget on pages doesn't load again.
data.custom_data[][conversation][date_created]	DateTime	*	Date when chat was started.
data.custom_data[][conversation][date_user_waiting]	DateTime	*	Since when the user has started waiting (i.e., time the assignment was 0).
data.custom_data[][conversation][date_assigned]	DateTime	*
data.custom_data[][conversation][date_agent_typing]	DateTime	*	Date when agent typed last time.
data.custom_data[][conversation][date_first_agent_message]	DateTime	*
data.custom_data[][conversation][date_ended]	DateTime	*	Date when chat was ended.
data.custom_data[][conversation][total_to_ended]	integer	*
data.custom_data[][conversation][ended_by]	string	*	Who ended the chat.
data.custom_data[][conversation][should_send_transcript]	boolean	*	True if transcript should be send.
data.custom_data[][conversation][date_transcript_sent]	DateTime	*	Date when transcript was sent.
data.custom_data[][conversation][email_validation_code]	string	*
data.custom_data[][conversation][email_validated]	boolean	*
data.custom_data[][conversation][access_token]	string	*
data.custom_data[][field]	object (CustomDefChat)	*
data.custom_data[][field][parent]	object (CustomDefChat)	*
data.custom_data[][field][children][]	array of objects (CustomDefChat)	*	Field children.
data.custom_data[][field][title]		*
data.custom_data[][root_field]	object (CustomDefChat)	*
data.rating_response_time	integer	*
data.rating_overall	integer	*
data.rating_comment	string	*
data.is_agent	boolean	*	Is this an agent chat.
data.is_window	boolean	*	If the chat is popped out into a window. This is used to make sure the JS widget on pages doesn't load again.
data.date_created	DateTime	*	Date when chat was started.
data.date_user_waiting	DateTime	*	Since when the user has started waiting (i.e., time the assignment was 0).
data.date_assigned	DateTime	*
data.date_agent_typing	DateTime	*	Date when agent typed last time.
data.date_first_agent_message	DateTime	*
data.date_ended	DateTime	*	Date when chat was ended.
data.total_to_ended	integer	*
data.should_send_transcript	boolean	*	True if transcript should be send.
data.date_transcript_sent	DateTime	*	Date when transcript was sent.
data.email_validation_code	string	*
data.email_validated	boolean	*
data.access_token	string	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/user_chats/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chats.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format
subject	string	false
person[id]	string	false
person[name]	string	false
person[email]	string	false
person[fieldId]	string	false
person[key]	string	false
person_email	string	false
agent[id]	string	false
agent[name]	string	false
agent[email]	string	false
agent[fieldId]	string	false
agent[key]	string	false
email_validated	boolean	false
fields[2][mode]	string	false
fields[2][criteria]	string	false
fields[2][data]	string	false
fields[3][mode]	string	false
fields[3][criteria]	string	false
fields[3][data]	choice	false
fields[7][mode]	string	false
fields[7][criteria]	string	false
fields[7][data]	boolean	false
fields[8][mode]	string	false
fields[8][criteria]	string	false
fields[8][data]	date	false	yyyy-MM-dd
fields[9][mode]	string	false
fields[9][criteria]	string	false
fields[9][data]	datetime	false	yyyy-MM-dd'T'HH:mm:ss
chat_department	choice	false
rating_comment	string	false
rating_overall	boolean	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

PUT /api/v2/user_chats/{id}/assign/{agentId}

Assign chat to agent

Documentation

Assign a chat conversation to an agent.

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chats.assign

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer
agentId	\d+	integer

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

PUT /api/v2/user_chats/{id}/block_user

End a chat conversation

Documentation

Block chat user.

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chats.block_user

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer

Status Code	Description
204	Returned if successful request
400	Returned if you filter set was malformed

PUT /api/v2/user_chats/{id}/decline

Join chat conversation

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chats.decline_chat

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer

Status Code	Description
204	Returned if successful request
400	Returned if assignation failed

PUT /api/v2/user_chats/{id}/end

End a chat conversation

Documentation

End a chat conversation.

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chats.end

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer

Status Code	Description
204	Returned if successful request
400	Returned if you filter set was malformed

PUT /api/v2/user_chats/{id}/invite

End a chat conversation

Documentation

Invite others to a chat conversation.

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chats.invite

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer

Status Code	Description
204	Returned if successful request
400	Returned if you filter set was malformed

PUT /api/v2/user_chats/{id}/join

Join chat conversation

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chats.join

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer

Status Code	Description
204	Returned if successful request
400	Returned if assignation failed

PUT /api/v2/user_chats/{id}/leave

End a chat conversation

Documentation

Leave chat with possible other subsequent actions.

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chats.leave_chat

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer

Status Code	Description
204	Returned if successful request
400	Returned if you filter set was malformed

PUT /api/v2/user_chats/{id}/start

Start chat by joining chat conversion in no other agent has joined

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chats.start_chat

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer

Status Code	Description
204	Returned if successful request
400	Returned if assignation failed

POST /api/v2/user_chats/{id}/typing

Send agent typing action

Documentation

Set agent typing action.

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.user_chats.typing

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer
erase	true\|false	boolean

Status Code	Description
204	Returned if successful request
400	Returned if you filter set was malformed

Show/hide List Operations Expand Operations

Client Devices

GET /api/v2/client_devices/{app_type} CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.client_device.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
app_type	mobile

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (Application\DeskPRO\Entity\ClientDevice)	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/client_devices/{app_type} CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.client_device.post

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
app_type	mobile

Parameter	Type	Required?	Format
device_id	string	true
device_type	choice	true	["generic","ios","ios.ipad","ios.iphone","android","android.phone","android.tablet"]
device_agent	string	false
device_name	string	false
notification_token	string	false

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/client_devices/{app_type}/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.client_device.count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
app_type	mobile

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

PUT /api/v2/client_devices/{app_type}/register/{id} CRUD

Updates a given device or create it if it does not exist yet.

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.client_device.register

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer\|string	The id or device_id of the resource
app_type	mobile

Parameter	Type	Required?	Format
device_id	string	false
device_type	choice	false	["generic","ios","ios.ipad","ios.iphone","android","android.phone","android.tablet"]
device_agent	string	false
device_name	string	false
notification_token	string	false

Status Code	Description
201	Returned in case of successful resource creation
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

DELETE /api/v2/client_devices/{app_type}/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.client_device.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+\|.*?	integer\|string	The id or device_id of the resource
app_type	mobile

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/client_devices/{app_type}/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.client_device.get

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+\|.*?	integer\|string	The id or device_id of the resource
app_type	mobile

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/client_devices/{app_type}/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

authentication.client_device.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer\|string	The id or device_id of the resource
app_type	mobile

Parameter	Type	Required?	Format
device_id	string	false
device_type	choice	false	["generic","ios","ios.ipad","ios.iphone","android","android.phone","android.tablet"]
device_agent	string	false
device_name	string	false
notification_token	string	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

Show/hide List Operations Expand Operations

Community

GET /api/v2/community_categories

get list of custom community forums

Documentation

Fetch custom community forums list. Proper output coming soon.

Applicable api modes

session token key oauth

Api tags for this endpoint

community.community_categories.list

Response
Status Codes

Parameter	Type	Versions	Description
data.title		*

Status Code	Description
200	Returned if request was successful

GET /api/v2/community_custom_fields CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

community.community_custom_fields.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (CustomDefCommunityTopic)	*
data[][title]		*
data[][parent]	object (CustomDefCommunityTopic)	*
data[][parent][parent]	object (CustomDefCommunityTopic)	*
data[][parent][children][]	array of objects (CustomDefCommunityTopic)	*	Field children.
data[][parent][brand]	object (Brand)	*
data[][parent][brand][id]	integer	*	The unique ID.
data[][parent][brand][name]	string	*	The brand name.
data[][parent][brand][slug]	string	*
data[][parent][brand][url]	string	*	The brand url.
data[][parent][brand][theme_set]	object (ThemeSet)	*
data[][parent][brand][theme_set][id]	integer	*
data[][parent][brand][theme_set][theme_id]	string	*
data[][parent][brand][theme_set][title]	string	*
data[][parent][brand][edit_theme_set]	object (ThemeSet)	*
data[][parent][brand][departments][]	array of objects (Department)	*
data[][parent][brand][departments][][id]	integer	*
data[][parent][brand][departments][][parent]	object (Department)	*
data[][parent][brand][departments][][children][]	array of objects (Department)	*
data[][parent][brand][departments][][title]	string	*
data[][parent][brand][departments][][user_title]	string	*
data[][parent][brand][departments][][is_tickets_enabled]	boolean	*
data[][parent][brand][departments][][is_chat_enabled]	boolean	*
data[][parent][brand][departments][][display_order]	integer	*
data[][parent][brand][departments][][avatar]	object (Blob)	*
data[][parent][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data[][parent][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][parent][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][parent][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][parent][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][parent][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data[][parent][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data[][parent][brand][departments][][avatar][authcode]	string	*
data[][parent][brand][departments][][avatar][blob_hash]	string	*
data[][parent][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][parent][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][parent][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][parent][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][parent][brand][departments][][avatar][date_created]	DateTime	*
data[][parent][brand][departments][][avatar][is_temp]	boolean	*
data[][parent][brand][departments][][avatar][source_ref]	string	*
data[][parent][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data[][parent][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data[][parent][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][parent][brand][departments][][brands][]	array of objects (Brand)	*
data[][parent][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data[][parent][brand][departments][][permissions][][department]	integer id (Department)	*
data[][parent][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][parent][brand][departments][][permissions][][name]	string	*	The name of the permission.
data[][parent][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][parent][brand][departments][][permissions][][is_active]	boolean	*
data[][parent][brand][departments][][chat_queue]	object (UserChatQueue)	*
data[][parent][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data[][parent][brand][departments][][chat_queue][name]	string	*
data[][parent][brand][departments][][chat_queue][routing_model]	string	*
data[][parent][brand][departments][][chat_queue][answer_timeout]	integer	*
data[][parent][brand][departments][][chat_queue][is_all_agents]	boolean	*
data[][parent][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data[][parent][brand][departments][][chat_queue][max_queue_size]	integer	*
data[][parent][brand][theme_sets][]	array of objects (ThemeSet)	*
data[][parent][forums][]	array of objects (CommunityForumToCustomDefCommunityTopic)	*
data[][parent][forums][][display_order]	integer	*
data[][parent][is_global]	boolean	*
data[][children][]	array of objects (CustomDefCommunityTopic)	*	Field children.
data[][brand]	object (Brand)	*
data[][brand][id]	integer	*	The unique ID.
data[][brand][name]	string	*	The brand name.
data[][brand][slug]	string	*
data[][brand][url]	string	*	The brand url.
data[][brand][theme_set]	object (ThemeSet)	*
data[][brand][theme_set][id]	integer	*
data[][brand][theme_set][theme_id]	string	*
data[][brand][theme_set][title]	string	*
data[][brand][edit_theme_set]	object (ThemeSet)	*
data[][brand][departments][]	array of objects (Department)	*
data[][brand][departments][][id]	integer	*
data[][brand][departments][][parent]	object (Department)	*
data[][brand][departments][][children][]	array of objects (Department)	*
data[][brand][departments][][title]	string	*
data[][brand][departments][][user_title]	string	*
data[][brand][departments][][is_tickets_enabled]	boolean	*
data[][brand][departments][][is_chat_enabled]	boolean	*
data[][brand][departments][][display_order]	integer	*
data[][brand][departments][][avatar]	object (Blob)	*
data[][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data[][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data[][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data[][brand][departments][][avatar][authcode]	string	*
data[][brand][departments][][avatar][blob_hash]	string	*
data[][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][brand][departments][][avatar][date_created]	DateTime	*
data[][brand][departments][][avatar][is_temp]	boolean	*
data[][brand][departments][][avatar][source_ref]	string	*
data[][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data[][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data[][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][brand][departments][][brands][]	array of objects (Brand)	*
data[][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data[][brand][departments][][permissions][][department]	integer id (Department)	*
data[][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][brand][departments][][permissions][][name]	string	*	The name of the permission.
data[][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][brand][departments][][permissions][][is_active]	boolean	*
data[][brand][departments][][chat_queue]	object (UserChatQueue)	*
data[][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data[][brand][departments][][chat_queue][name]	string	*
data[][brand][departments][][chat_queue][routing_model]	string	*
data[][brand][departments][][chat_queue][answer_timeout]	integer	*
data[][brand][departments][][chat_queue][is_all_agents]	boolean	*
data[][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data[][brand][departments][][chat_queue][max_queue_size]	integer	*
data[][brand][theme_sets][]	array of objects (ThemeSet)	*
data[][forums][]	array of objects (CommunityForumToCustomDefCommunityTopic)	*
data[][forums][][display_order]	integer	*
data[][is_global]	boolean	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/community_custom_fields CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

community.community_custom_fields.post

Parameters
Response
Status Codes

Parameter	Type	Required?	Format	Description
handler_class	choice	true	["Application\\DeskPRO\\CustomFields\\Handler\\Text","Application\\DeskPRO\\CustomFields\\Handler\\Textarea","Application\\DeskPRO\\CustomFields\\Handler\\Choice","Application\\DeskPRO\\CustomFields\\Handler\\Toggle","Application\\DeskPRO\\CustomFields\\Handler\\Date","Application\\DeskPRO\\CustomFields\\Handler\\DateTime","Application\\DeskPRO\\CustomFields\\Handler\\Display","Application\\DeskPRO\\CustomFields\\Handler\\Hidden","Application\\DeskPRO\\CustomFields\\Handler\\Data","Application\\DeskPRO\\CustomFields\\Handler\\DataJson","Application\\DeskPRO\\CustomFields\\Handler\\Javascript","Application\\DeskPRO\\CustomFields\\Handler\\DataList","Application\\DeskPRO\\CustomFields\\Handler\\Url","Application\\DeskPRO\\CustomFields\\Handler\\Number","Application\\DeskPRO\\CustomFields\\Handler\\Currency","Application\\DeskPRO\\CustomFields\\Handler\\File","Application\\DeskPRO\\CustomFields\\Handler\\ExternalUniqueKey"]

Parameter	Type	Versions	Description
data.title		*
data.parent	object (CustomDefCommunityTopic)	*
data.parent[parent]	object (CustomDefCommunityTopic)	*
data.parent[children][]	array of objects (CustomDefCommunityTopic)	*	Field children.
data.parent[brand]	object (Brand)	*
data.parent[brand][id]	integer	*	The unique ID.
data.parent[brand][name]	string	*	The brand name.
data.parent[brand][slug]	string	*
data.parent[brand][url]	string	*	The brand url.
data.parent[brand][theme_set]	object (ThemeSet)	*
data.parent[brand][theme_set][id]	integer	*
data.parent[brand][theme_set][theme_id]	string	*
data.parent[brand][theme_set][title]	string	*
data.parent[brand][theme_set][options]		*
data.parent[brand][edit_theme_set]	object (ThemeSet)	*
data.parent[brand][departments][]	array of objects (Department)	*
data.parent[brand][departments][][id]	integer	*
data.parent[brand][departments][][parent]	object (Department)	*
data.parent[brand][departments][][children][]	array of objects (Department)	*
data.parent[brand][departments][][title]	string	*
data.parent[brand][departments][][user_title]	string	*
data.parent[brand][departments][][is_tickets_enabled]	boolean	*
data.parent[brand][departments][][is_chat_enabled]	boolean	*
data.parent[brand][departments][][display_order]	integer	*
data.parent[brand][departments][][avatar]	object (Blob)	*
data.parent[brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.parent[brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.parent[brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.parent[brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.parent[brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.parent[brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.parent[brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.parent[brand][departments][][avatar][authcode]	string	*
data.parent[brand][departments][][avatar][blob_hash]	string	*
data.parent[brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.parent[brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.parent[brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.parent[brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.parent[brand][departments][][avatar][date_created]	DateTime	*
data.parent[brand][departments][][avatar][is_temp]	boolean	*
data.parent[brand][departments][][avatar][source_ref]	string	*
data.parent[brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.parent[brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.parent[brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.parent[brand][departments][][brands][]	array of objects (Brand)	*
data.parent[brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.parent[brand][departments][][permissions][][department]	integer id (Department)	*
data.parent[brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.parent[brand][departments][][permissions][][name]	string	*	The name of the permission.
data.parent[brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.parent[brand][departments][][permissions][][is_active]	boolean	*
data.parent[brand][departments][][chat_queue]	object (UserChatQueue)	*
data.parent[brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.parent[brand][departments][][chat_queue][name]	string	*
data.parent[brand][departments][][chat_queue][routing_model]	string	*
data.parent[brand][departments][][chat_queue][answer_timeout]	integer	*
data.parent[brand][departments][][chat_queue][is_all_agents]	boolean	*
data.parent[brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.parent[brand][departments][][chat_queue][max_queue_size]	integer	*
data.parent[brand][departments][][chat_queue][routingModel]		*
data.parent[brand][theme_sets][]	array of objects (ThemeSet)	*
data.parent[forums][]	array of objects (CommunityForumToCustomDefCommunityTopic)	*
data.parent[forums][][display_order]	integer	*
data.parent[is_global]	boolean	*
data.parent[title]		*
data.children[]	array of objects (CustomDefCommunityTopic)	*	Field children.
data.brand	object (Brand)	*
data.brand[id]	integer	*	The unique ID.
data.brand[name]	string	*	The brand name.
data.brand[slug]	string	*
data.brand[url]	string	*	The brand url.
data.brand[theme_set]	object (ThemeSet)	*
data.brand[theme_set][id]	integer	*
data.brand[theme_set][theme_id]	string	*
data.brand[theme_set][title]	string	*
data.brand[theme_set][options]		*
data.brand[edit_theme_set]	object (ThemeSet)	*
data.brand[departments][]	array of objects (Department)	*
data.brand[departments][][id]	integer	*
data.brand[departments][][parent]	object (Department)	*
data.brand[departments][][children][]	array of objects (Department)	*
data.brand[departments][][title]	string	*
data.brand[departments][][user_title]	string	*
data.brand[departments][][is_tickets_enabled]	boolean	*
data.brand[departments][][is_chat_enabled]	boolean	*
data.brand[departments][][display_order]	integer	*
data.brand[departments][][avatar]	object (Blob)	*
data.brand[departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.brand[departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.brand[departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.brand[departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.brand[departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.brand[departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.brand[departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.brand[departments][][avatar][authcode]	string	*
data.brand[departments][][avatar][blob_hash]	string	*
data.brand[departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.brand[departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.brand[departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.brand[departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.brand[departments][][avatar][date_created]	DateTime	*
data.brand[departments][][avatar][is_temp]	boolean	*
data.brand[departments][][avatar][source_ref]	string	*
data.brand[departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.brand[departments][][avatar][labels][][blob]	object (Blob)	*
data.brand[departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.brand[departments][][brands][]	array of objects (Brand)	*
data.brand[departments][][permissions][]	array of objects (DepartmentPermission)	*
data.brand[departments][][permissions][][department]	integer id (Department)	*
data.brand[departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.brand[departments][][permissions][][name]	string	*	The name of the permission.
data.brand[departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.brand[departments][][permissions][][is_active]	boolean	*
data.brand[departments][][chat_queue]	object (UserChatQueue)	*
data.brand[departments][][chat_queue][id]	integer	*	The unique ID.
data.brand[departments][][chat_queue][name]	string	*
data.brand[departments][][chat_queue][routing_model]	string	*
data.brand[departments][][chat_queue][answer_timeout]	integer	*
data.brand[departments][][chat_queue][is_all_agents]	boolean	*
data.brand[departments][][chat_queue][departments][]	array of objects (Department)	*
data.brand[departments][][chat_queue][max_queue_size]	integer	*
data.brand[departments][][chat_queue][routingModel]		*
data.brand[theme_sets][]	array of objects (ThemeSet)	*
data.forums[]	array of objects (CommunityForumToCustomDefCommunityTopic)	*
data.forums[][display_order]	integer	*
data.is_global	boolean	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

DELETE /api/v2/community_custom_fields/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

community.community_custom_fields.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/community_custom_fields/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

community.community_custom_fields.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.title		*
data.parent	object (CustomDefCommunityTopic)	*
data.parent[parent]	object (CustomDefCommunityTopic)	*
data.parent[children][]	array of objects (CustomDefCommunityTopic)	*	Field children.
data.parent[brand]	object (Brand)	*
data.parent[brand][id]	integer	*	The unique ID.
data.parent[brand][name]	string	*	The brand name.
data.parent[brand][slug]	string	*
data.parent[brand][url]	string	*	The brand url.
data.parent[brand][theme_set]	object (ThemeSet)	*
data.parent[brand][theme_set][id]	integer	*
data.parent[brand][theme_set][theme_id]	string	*
data.parent[brand][theme_set][title]	string	*
data.parent[brand][theme_set][options]		*
data.parent[brand][edit_theme_set]	object (ThemeSet)	*
data.parent[brand][departments][]	array of objects (Department)	*
data.parent[brand][departments][][id]	integer	*
data.parent[brand][departments][][parent]	object (Department)	*
data.parent[brand][departments][][children][]	array of objects (Department)	*
data.parent[brand][departments][][title]	string	*
data.parent[brand][departments][][user_title]	string	*
data.parent[brand][departments][][is_tickets_enabled]	boolean	*
data.parent[brand][departments][][is_chat_enabled]	boolean	*
data.parent[brand][departments][][display_order]	integer	*
data.parent[brand][departments][][avatar]	object (Blob)	*
data.parent[brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.parent[brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.parent[brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.parent[brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.parent[brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.parent[brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.parent[brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.parent[brand][departments][][avatar][authcode]	string	*
data.parent[brand][departments][][avatar][blob_hash]	string	*
data.parent[brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.parent[brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.parent[brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.parent[brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.parent[brand][departments][][avatar][date_created]	DateTime	*
data.parent[brand][departments][][avatar][is_temp]	boolean	*
data.parent[brand][departments][][avatar][source_ref]	string	*
data.parent[brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.parent[brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.parent[brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.parent[brand][departments][][brands][]	array of objects (Brand)	*
data.parent[brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.parent[brand][departments][][permissions][][department]	integer id (Department)	*
data.parent[brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.parent[brand][departments][][permissions][][name]	string	*	The name of the permission.
data.parent[brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.parent[brand][departments][][permissions][][is_active]	boolean	*
data.parent[brand][departments][][chat_queue]	object (UserChatQueue)	*
data.parent[brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.parent[brand][departments][][chat_queue][name]	string	*
data.parent[brand][departments][][chat_queue][routing_model]	string	*
data.parent[brand][departments][][chat_queue][answer_timeout]	integer	*
data.parent[brand][departments][][chat_queue][is_all_agents]	boolean	*
data.parent[brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.parent[brand][departments][][chat_queue][max_queue_size]	integer	*
data.parent[brand][departments][][chat_queue][routingModel]		*
data.parent[brand][theme_sets][]	array of objects (ThemeSet)	*
data.parent[forums][]	array of objects (CommunityForumToCustomDefCommunityTopic)	*
data.parent[forums][][display_order]	integer	*
data.parent[is_global]	boolean	*
data.parent[title]		*
data.children[]	array of objects (CustomDefCommunityTopic)	*	Field children.
data.brand	object (Brand)	*
data.brand[id]	integer	*	The unique ID.
data.brand[name]	string	*	The brand name.
data.brand[slug]	string	*
data.brand[url]	string	*	The brand url.
data.brand[theme_set]	object (ThemeSet)	*
data.brand[theme_set][id]	integer	*
data.brand[theme_set][theme_id]	string	*
data.brand[theme_set][title]	string	*
data.brand[theme_set][options]		*
data.brand[edit_theme_set]	object (ThemeSet)	*
data.brand[departments][]	array of objects (Department)	*
data.brand[departments][][id]	integer	*
data.brand[departments][][parent]	object (Department)	*
data.brand[departments][][children][]	array of objects (Department)	*
data.brand[departments][][title]	string	*
data.brand[departments][][user_title]	string	*
data.brand[departments][][is_tickets_enabled]	boolean	*
data.brand[departments][][is_chat_enabled]	boolean	*
data.brand[departments][][display_order]	integer	*
data.brand[departments][][avatar]	object (Blob)	*
data.brand[departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.brand[departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.brand[departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.brand[departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.brand[departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.brand[departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.brand[departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.brand[departments][][avatar][authcode]	string	*
data.brand[departments][][avatar][blob_hash]	string	*
data.brand[departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.brand[departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.brand[departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.brand[departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.brand[departments][][avatar][date_created]	DateTime	*
data.brand[departments][][avatar][is_temp]	boolean	*
data.brand[departments][][avatar][source_ref]	string	*
data.brand[departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.brand[departments][][avatar][labels][][blob]	object (Blob)	*
data.brand[departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.brand[departments][][brands][]	array of objects (Brand)	*
data.brand[departments][][permissions][]	array of objects (DepartmentPermission)	*
data.brand[departments][][permissions][][department]	integer id (Department)	*
data.brand[departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.brand[departments][][permissions][][name]	string	*	The name of the permission.
data.brand[departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.brand[departments][][permissions][][is_active]	boolean	*
data.brand[departments][][chat_queue]	object (UserChatQueue)	*
data.brand[departments][][chat_queue][id]	integer	*	The unique ID.
data.brand[departments][][chat_queue][name]	string	*
data.brand[departments][][chat_queue][routing_model]	string	*
data.brand[departments][][chat_queue][answer_timeout]	integer	*
data.brand[departments][][chat_queue][is_all_agents]	boolean	*
data.brand[departments][][chat_queue][departments][]	array of objects (Department)	*
data.brand[departments][][chat_queue][max_queue_size]	integer	*
data.brand[departments][][chat_queue][routingModel]		*
data.brand[theme_sets][]	array of objects (ThemeSet)	*
data.forums[]	array of objects (CommunityForumToCustomDefCommunityTopic)	*
data.forums[][display_order]	integer	*
data.is_global	boolean	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/community_custom_fields/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

community.community_custom_fields.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format	Description
handler_class	choice	false	["Application\\DeskPRO\\CustomFields\\Handler\\Text","Application\\DeskPRO\\CustomFields\\Handler\\Textarea","Application\\DeskPRO\\CustomFields\\Handler\\Choice","Application\\DeskPRO\\CustomFields\\Handler\\Toggle","Application\\DeskPRO\\CustomFields\\Handler\\Date","Application\\DeskPRO\\CustomFields\\Handler\\DateTime","Application\\DeskPRO\\CustomFields\\Handler\\Display","Application\\DeskPRO\\CustomFields\\Handler\\Hidden","Application\\DeskPRO\\CustomFields\\Handler\\Data","Application\\DeskPRO\\CustomFields\\Handler\\DataJson","Application\\DeskPRO\\CustomFields\\Handler\\Javascript","Application\\DeskPRO\\CustomFields\\Handler\\DataList","Application\\DeskPRO\\CustomFields\\Handler\\Url","Application\\DeskPRO\\CustomFields\\Handler\\Number","Application\\DeskPRO\\CustomFields\\Handler\\Currency","Application\\DeskPRO\\CustomFields\\Handler\\File","Application\\DeskPRO\\CustomFields\\Handler\\ExternalUniqueKey"]

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/community_forums CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

community.community_forums.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (CommunityForum)	*
data[][title]		*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

GET /api/v2/community_forums/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

community.community_forums.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

POST /api/v2/community_forums/{forum}/icon

set Icon

Documentation

Set icon for Community forum.

Applicable api modes

session token key oauth

Api tags for this endpoint

community.community_forums.set_icon

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
forum	\d+	integer	the id forum

Parameter	Type	Required?
urn	string	true
style	string	true
color	string	true

Status Code	Description
200	Returned if everything is OK

POST /api/v2/community_forums/{forum}/splash_image

set Splash Image

Documentation

Post a new splash image.

You have to post json_encoded object, please refer to the JS code to find out the shape.

Applicable api modes

session token key oauth

Api tags for this endpoint

community.community_forums.select_splash_image

Requirements
Status Codes

Name	Requirement	Type	Description
forum	\d+	integer	the id of forum

Status Code	Description
200	Returned if everything is OK

GET /api/v2/community_forums/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

community.community_forums.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.title		*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

GET /api/v2/community_topic_comments CRUD community comments

get list of community topic comments

Applicable api modes

session token key oauth

Api tags for this endpoint

community.community_topic_all_comments.list

Filters
Response
Status Codes

Name

Information

page

Type	integer
Default	1
Description	current page

count

Type	integer
Default	5
Description	per page comments quantity

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Datatype	string
Description	a comma separated list of comment`s ids

awaiting_validation

Type	boolean
Description	set it if you want to fetch new comments

category

Datatype	string
Description	category to search, exact name

statusCategory

Datatype	integer
Description	integer represents status category

label

Datatype	string
Description	a comma separated list of exact label names

no_labels

Datatype	boolean
Description	boolean value

custom_category

Datatype	string[]
Description	an array of exact custom categories names

status

Datatype	integer
Description	an integer value represents current status

hidden_status

Datatype	string
Description	an integer value represents current hidden_status

created_from

Datatype	datetime
Description	a datetime string to search comments since

created_to

Datatype	datetime
Description	a datetime string to search comments until

community_topic_field.{id}

Description	\n * Custom community topic field filter. To filter by a custom field with ID=1 you need to add\n * ?community_topic_field.1=value to the query string
Datatype	string
Pattern	\d+\|\w

Parameter	Type	Versions	Description
data[]	array of objects (CommunityTopicComment)	*
data[][status]	string	*	Comment`s status.
data[][id]	integer	*	The unique ID.
data[][person]	integer id (Person)	*	The id of person that wrote this comment.
data[][ip_address]	string	*	IP address with which comment was written.
data[][email]	string	*	Person`s email.
data[][name]	string	*	Person`s name.
data[][website]	string	*	Website where comment was written.
data[][content]	string	*	Comment`s content itself.
data[][is_reviewed]	boolean	*	Has this comment been reviewed by an agent?
data[][date_created]	DateTime	*	When this comment was created.
data[][content_type]	string	*	Content Type for this comment.
data[][rating]	integer	*	Total rating for this comment.
data[][topic]	integer id (CommunityTopic)	*	CommunityTopic this comment belongs to.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/community_topic_comments CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

community.community_topic_all_comments.post

Response
Status Codes

Parameter	Type	Versions	Description
data.status	string	*	Comment`s status.
data.id	integer	*	The unique ID.
data.person	integer id (Person)	*	The id of person that wrote this comment.
data.ip_address	string	*	IP address with which comment was written.
data.email	string	*	Person`s email.
data.name	string	*	Person`s name.
data.website	string	*	Website where comment was written.
data.content	string	*	Comment`s content itself.
data.is_reviewed	boolean	*	Has this comment been reviewed by an agent?
data.date_created	DateTime	*	When this comment was created.
data.content_type	string	*	Content Type for this comment.
data.rating	integer	*	Total rating for this comment.
data.topic	integer id (CommunityTopic)	*	CommunityTopic this comment belongs to.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/community_topic_comments/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

community.community_topic_all_comments.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/community_topic_comments/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

community.community_topic_all_comments.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/community_topic_comments/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

community.community_topic_all_comments.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.status	string	*	Comment`s status.
data.id	integer	*	The unique ID.
data.person	integer id (Person)	*	The id of person that wrote this comment.
data.ip_address	string	*	IP address with which comment was written.
data.email	string	*	Person`s email.
data.name	string	*	Person`s name.
data.website	string	*	Website where comment was written.
data.content	string	*	Comment`s content itself.
data.is_reviewed	boolean	*	Has this comment been reviewed by an agent?
data.date_created	DateTime	*	When this comment was created.
data.content_type	string	*	Content Type for this comment.
data.rating	integer	*	Total rating for this comment.
data.topic	integer id (CommunityTopic)	*	CommunityTopic this comment belongs to.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/community_topic_comments/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

community.community_topic_all_comments.put

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/community_topics CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

community.community_topics.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	\d,\d...\d
Description	comma separated ids list
Datatype	string

awaiting_validation

Pattern	1
Description	select community topics awaiting validation only
Datatype	boolean

status

Pattern	active\|closed\|hidden
Description	filter by status
Datatype	string

hidden_status

Datatype	integer
Pattern	unpublished\|deleted\|spam\|draft
Description	limit with hidden_status

status_category

Pattern	\w\|[\w]
Description	filter by status category
Datatype	string[]

forum

Pattern	\w\|[\w]
Description	forum title, or titles array
Datatype	string[]

category

Pattern	\w\|[\w]
Description	filter by category
Datatype	string[]

labels_mode

Pattern	any\|all
Description	how to load labels
Datatype	string

label

Pattern	\w,\w...\w
Description	select community topics with given lables
Datatype	string

no_labels

Pattern	1
Description	select community topics have no label
Datatype	boolean

created_from

Pattern	YYYY-mm-dd H:i:s
Description	limit by date, interval`s start
Datatype	date

created_to

Pattern	YYYY-mm-dd H:i:s
Description	limit by date, interval`s end
Datatype	date

community_topic_field.{id}

Description	\n * Custom community topic field filter. To filter by a custom field with ID=1 you need to add\n * ?community_topic_field.1=value to the query string
Datatype	string
Pattern	\d+\|\w

order_by

Pattern	date_created\|total_rating\|num_ratings\|id\|title\|status\|forum\|person
Description	how to order result
Datatype	string

order_dir

Pattern	asc\|desc
Description	order direction
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (CommunityTopic)	*
data[][id]	integer	*	The unique ID.
data[][person]	integer id (Person)	*	Person created this content first time.
data[][language]	integer id (Language)	*	Language content was written.
data[][translated_language]	integer id (Language)	*	Language matched when translating content.
data[][slug]	string	*	Content slug.
data[][title]	string	*	Content title.
data[][content]	string	*	The main content for the item. This should be HTML!
data[][view_count]	integer	*	View counts.
data[][total_rating]	integer	*	Total rating: This is a tally and must be updated when a rating is added.
data[][num_comments]	integer	*	Number of user-visible comments: This is a count that must be updated when a comment is added.
data[][num_ratings]	integer	*	Total rating.
data[][status]	string	*	Status title.
data[][hidden_status]	string	*	Hidden status code.
data[][date_created]	DateTime	*	DateTime when content was created.
data[][date_updated]	DateTime	*	DateTime when content was updated last time.
data[][date_published]	DateTime	*	DateTime when content was published.
data[][vote_stats]	array	*	Vote stats object, like {"up": 1, "down": 1}.
data[][url]	string	*	Content's url.
data[][revisions][]	array of integer ids (ArticleRevision)	*	Revisions of this article.
data[][splash_image_property]	integer id (SplashImageProperty)	*
data[][brand_id]	integer	*	Content's Brand ID.
data[][status_category]	integer id (CommunityTopicStatusCategory)	*	Category the community topic belongs to.
data[][forum]	integer id (CommunityForum)	*	Community forum the topic belongs to.
data[][labels][]	array of objects (label)	*	String array of labels associated with this news.
data[][fields][]	dynamically declared custom fields (array)	*	Custom ticket fields.
data[][popularity]	integer	*	Popularity.
data[][comments_count]	integer	*	Comments count.
data[][is_reviewed]	boolean	*	Is reviewed.
data[][attachments][]	array of integer ids (CommunityTopicAttachment)	*	Items attached to the content.
data[][custom_data][]	array of objects (CustomDataCommunityTopic)	*	String array of labels associated with this community topic.
data[][custom_data][][topic]	object (CommunityTopic)	*
data[][custom_data][][topic][hidden_status]	string	*	Hidden status code.
data[][custom_data][][topic][brand]	object (Brand)	*
data[][custom_data][][topic][brand][id]	integer	*	The unique ID.
data[][custom_data][][topic][brand][name]	string	*	The brand name.
data[][custom_data][][topic][brand][slug]	string	*
data[][custom_data][][topic][brand][url]	string	*	The brand url.
data[][custom_data][][topic][brand][theme_set]	object (ThemeSet)	*
data[][custom_data][][topic][brand][theme_set][id]	integer	*
data[][custom_data][][topic][brand][theme_set][theme_id]	string	*
data[][custom_data][][topic][brand][theme_set][title]	string	*
data[][custom_data][][topic][brand][edit_theme_set]	object (ThemeSet)	*
data[][custom_data][][topic][brand][departments][]	array of objects (Department)	*
data[][custom_data][][topic][brand][departments][][id]	integer	*
data[][custom_data][][topic][brand][departments][][parent]	object (Department)	*
data[][custom_data][][topic][brand][departments][][children][]	array of objects (Department)	*
data[][custom_data][][topic][brand][departments][][title]	string	*
data[][custom_data][][topic][brand][departments][][user_title]	string	*
data[][custom_data][][topic][brand][departments][][is_tickets_enabled]	boolean	*
data[][custom_data][][topic][brand][departments][][is_chat_enabled]	boolean	*
data[][custom_data][][topic][brand][departments][][display_order]	integer	*
data[][custom_data][][topic][brand][departments][][avatar]	object (Blob)	*
data[][custom_data][][topic][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data[][custom_data][][topic][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][custom_data][][topic][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][custom_data][][topic][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][custom_data][][topic][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][custom_data][][topic][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data[][custom_data][][topic][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data[][custom_data][][topic][brand][departments][][avatar][authcode]	string	*
data[][custom_data][][topic][brand][departments][][avatar][blob_hash]	string	*
data[][custom_data][][topic][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][custom_data][][topic][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][custom_data][][topic][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][custom_data][][topic][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][custom_data][][topic][brand][departments][][avatar][date_created]	DateTime	*
data[][custom_data][][topic][brand][departments][][avatar][is_temp]	boolean	*
data[][custom_data][][topic][brand][departments][][avatar][source_ref]	string	*
data[][custom_data][][topic][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data[][custom_data][][topic][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data[][custom_data][][topic][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][custom_data][][topic][brand][departments][][brands][]	array of objects (Brand)	*
data[][custom_data][][topic][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data[][custom_data][][topic][brand][departments][][permissions][][department]	integer id (Department)	*
data[][custom_data][][topic][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][custom_data][][topic][brand][departments][][permissions][][name]	string	*	The name of the permission.
data[][custom_data][][topic][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][custom_data][][topic][brand][departments][][permissions][][is_active]	boolean	*
data[][custom_data][][topic][brand][departments][][chat_queue]	object (UserChatQueue)	*
data[][custom_data][][topic][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data[][custom_data][][topic][brand][departments][][chat_queue][name]	string	*
data[][custom_data][][topic][brand][departments][][chat_queue][routing_model]	string	*
data[][custom_data][][topic][brand][departments][][chat_queue][answer_timeout]	integer	*
data[][custom_data][][topic][brand][departments][][chat_queue][is_all_agents]	boolean	*
data[][custom_data][][topic][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data[][custom_data][][topic][brand][departments][][chat_queue][max_queue_size]	integer	*
data[][custom_data][][topic][brand][theme_sets][]	array of objects (ThemeSet)	*
data[][custom_data][][topic][is_reviewed]	boolean	*	Has this community topic been reviewed by an agent?
data[][custom_data][][topic][status_category]	object (CommunityTopicStatusCategory)	*	Status category the topic belongs to.
data[][custom_data][][topic][status_category][id]	integer	*	The unique ID.
data[][custom_data][][topic][status_category][status_type]	string	*	Category status type.
data[][custom_data][][topic][status_category][title]	string	*	Category title.
data[][custom_data][][topic][status_category][color]	string	*
data[][custom_data][][topic][forum]	object (CommunityForum)	*	Forum the topic belongs to.
data[][custom_data][][topic][revisions][]	array of objects (CommunityTopicRevision)	*	Revisions of this topic.
data[][custom_data][][topic][revisions][][id]	integer	*	The unique ID.
data[][custom_data][][topic][revisions][][person]	integer id (Person)	*	Person who made the revision.
data[][custom_data][][topic][revisions][][date_created]	DateTime	*	DateTime the revision was created.
data[][custom_data][][topic][revisions][][community_topic]	object (CommunityTopic)	*
data[][custom_data][][topic][revisions][][title]	string	*
data[][custom_data][][topic][revisions][][content]	string	*
data[][custom_data][][topic][revisions][][content_input]	string	*
data[][custom_data][][topic][revisions][][content_input_type]	string	*	Revision content_input type of community topic.
data[][custom_data][][topic][labels][]	array of objects (LabelCommunityTopic)	*	String array of labels associated with this news.
data[][custom_data][][topic][labels][][topic]	object (CommunityTopic)	*
data[][custom_data][][topic][custom_data][]	array of objects (CustomDataCommunityTopic)	*
data[][custom_data][][topic][popularity]	integer	*	Popularity. (see recalculatePopularity)
data[][custom_data][][topic][attachments][]	array of objects (CommunityTopicAttachment)	*
data[][custom_data][][topic][attachments][][id]	integer	*
data[][custom_data][][topic][attachments][][topic]	integer id (CommunityTopic)	*
data[][custom_data][][topic][attachments][][person]	integer id (Person)	*	Who created the attachment.
data[][custom_data][][topic][attachments][][blob]	object (Blob)	*
data[][custom_data][][topic][attachments][][blob][sys_name]	string	*	A unique system name for the blob.
data[][custom_data][][topic][attachments][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][custom_data][][topic][attachments][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][custom_data][][topic][attachments][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][custom_data][][topic][attachments][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][custom_data][][topic][attachments][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][custom_data][][topic][attachments][][blob][file_url]	string	*	The HTTP link to download the file.
data[][custom_data][][topic][attachments][][blob][authcode]	string	*
data[][custom_data][][topic][attachments][][blob][blob_hash]	string	*
data[][custom_data][][topic][attachments][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][custom_data][][topic][attachments][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][custom_data][][topic][attachments][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][custom_data][][topic][attachments][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][custom_data][][topic][attachments][][blob][date_created]	DateTime	*
data[][custom_data][][topic][attachments][][blob][is_temp]	boolean	*
data[][custom_data][][topic][attachments][][blob][source_ref]	string	*
data[][custom_data][][topic][attachments][][blob][labels][]	array of objects (LabelBlob)	*
data[][custom_data][][topic][attachments][][blob][labels][][blob]	object (Blob)	*
data[][custom_data][][topic][official_response]	object (CommunityTopicComment)	*
data[][custom_data][][topic][official_response][id]	integer	*	The unique ID.
data[][custom_data][][topic][official_response][person]	integer id (Person)	*	The id of person that wrote this comment.
data[][custom_data][][topic][official_response][ip_address]	string	*	IP address with which comment was written.
data[][custom_data][][topic][official_response][email]	string	*	Person`s email.
data[][custom_data][][topic][official_response][name]	string	*	Person`s name.
data[][custom_data][][topic][official_response][website]	string	*	Website where comment was written.
data[][custom_data][][topic][official_response][content]	string	*	Comment`s content itself.
data[][custom_data][][topic][official_response][status]	string	*	Comment`s status.
data[][custom_data][][topic][official_response][is_reviewed]	boolean	*	Has this comment been reviewed by an agent?
data[][custom_data][][topic][official_response][date_created]	DateTime	*	When this comment was created.
data[][custom_data][][topic][official_response][content_type]	string	*	Content Type for this comment.
data[][custom_data][][topic][official_response][rating]	integer	*	Total rating for this comment.
data[][custom_data][][topic][official_response][topic]	integer id (CommunityTopic)	*	CommunityTopic this comment belongs to.
data[][custom_data][][topic][status_transitions][]	array of objects (CommunityTopicStatusTransition)	*
data[][custom_data][][topic][status_transitions][][id]	integer	*
data[][custom_data][][topic][status_transitions][][topic]	object (CommunityTopic)	*
data[][custom_data][][topic][status_transitions][][old_status_category]	object (CommunityTopicStatusCategory)	*
data[][custom_data][][topic][status_transitions][][new_status_category]	object (CommunityTopicStatusCategory)	*
data[][custom_data][][topic][status_transitions][][date_created]	DateTime	*
data[][custom_data][][topic][status_transitions][][performer]	object (Person)	*
data[][custom_data][][topic][content_format]	string	*
data[][custom_data][][topic][content_data]	array	*
data[][custom_data][][field]	object (CustomDefCommunityTopic)	*
data[][custom_data][][field][parent]	object (CustomDefCommunityTopic)	*
data[][custom_data][][field][children][]	array of objects (CustomDefCommunityTopic)	*	Field children.
data[][custom_data][][field][brand]	object (Brand)	*
data[][custom_data][][field][brand][id]	integer	*	The unique ID.
data[][custom_data][][field][brand][name]	string	*	The brand name.
data[][custom_data][][field][brand][slug]	string	*
data[][custom_data][][field][brand][url]	string	*	The brand url.
data[][custom_data][][field][brand][theme_set]	object (ThemeSet)	*
data[][custom_data][][field][brand][theme_set][id]	integer	*
data[][custom_data][][field][brand][theme_set][theme_id]	string	*
data[][custom_data][][field][brand][theme_set][title]	string	*
data[][custom_data][][field][brand][edit_theme_set]	object (ThemeSet)	*
data[][custom_data][][field][brand][departments][]	array of objects (Department)	*
data[][custom_data][][field][brand][departments][][id]	integer	*
data[][custom_data][][field][brand][departments][][parent]	object (Department)	*
data[][custom_data][][field][brand][departments][][children][]	array of objects (Department)	*
data[][custom_data][][field][brand][departments][][title]	string	*
data[][custom_data][][field][brand][departments][][user_title]	string	*
data[][custom_data][][field][brand][departments][][is_tickets_enabled]	boolean	*
data[][custom_data][][field][brand][departments][][is_chat_enabled]	boolean	*
data[][custom_data][][field][brand][departments][][display_order]	integer	*
data[][custom_data][][field][brand][departments][][avatar]	object (Blob)	*
data[][custom_data][][field][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data[][custom_data][][field][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][custom_data][][field][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][custom_data][][field][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][custom_data][][field][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][custom_data][][field][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data[][custom_data][][field][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data[][custom_data][][field][brand][departments][][avatar][authcode]	string	*
data[][custom_data][][field][brand][departments][][avatar][blob_hash]	string	*
data[][custom_data][][field][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][custom_data][][field][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][custom_data][][field][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][custom_data][][field][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][custom_data][][field][brand][departments][][avatar][date_created]	DateTime	*
data[][custom_data][][field][brand][departments][][avatar][is_temp]	boolean	*
data[][custom_data][][field][brand][departments][][avatar][source_ref]	string	*
data[][custom_data][][field][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data[][custom_data][][field][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data[][custom_data][][field][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][custom_data][][field][brand][departments][][brands][]	array of objects (Brand)	*
data[][custom_data][][field][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data[][custom_data][][field][brand][departments][][permissions][][department]	integer id (Department)	*
data[][custom_data][][field][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][custom_data][][field][brand][departments][][permissions][][name]	string	*	The name of the permission.
data[][custom_data][][field][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][custom_data][][field][brand][departments][][permissions][][is_active]	boolean	*
data[][custom_data][][field][brand][departments][][chat_queue]	object (UserChatQueue)	*
data[][custom_data][][field][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data[][custom_data][][field][brand][departments][][chat_queue][name]	string	*
data[][custom_data][][field][brand][departments][][chat_queue][routing_model]	string	*
data[][custom_data][][field][brand][departments][][chat_queue][answer_timeout]	integer	*
data[][custom_data][][field][brand][departments][][chat_queue][is_all_agents]	boolean	*
data[][custom_data][][field][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data[][custom_data][][field][brand][departments][][chat_queue][max_queue_size]	integer	*
data[][custom_data][][field][brand][theme_sets][]	array of objects (ThemeSet)	*
data[][custom_data][][field][forums][]	array of objects (CommunityForumToCustomDefCommunityTopic)	*
data[][custom_data][][field][forums][][display_order]	integer	*
data[][custom_data][][field][is_global]	boolean	*
data[][custom_data][][root_field]	object (CustomDefCommunityTopic)	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/community_topics CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

community.community_topics.post

Parameters
Response
Status Codes

Parameter	Type	Required?	Format
title	string	true
content	string	true
person[id]	string	false
person[name]	string	false
person[email]	string	false
person[fieldId]	string	false
person[key]	string	false
forum	choice	true
status	choice	false	["active","closed","hidden"]
labels[]	array of strings	false
fields[1][mode]	string	false
fields[1][criteria]	string	false
fields[1][data]	choice	true
fields[5][mode]	string	false
fields[5][criteria]	string	false
fields[5][data]	choice	true
fields[9][mode]	string	false
fields[9][criteria]	string	false
fields[9][data]	string	true
fields[10][mode]	string	false
fields[10][criteria]	string	false
fields[10][data]	string	true
fields[11][mode]	string	false
fields[11][criteria]	string	false
fields[11][data][]	array of choices	true
fields[15][mode]	string	false
fields[15][criteria]	string	false
fields[15][data]	date	true	yyyy-MM-dd
fields[16][mode]	string	false
fields[16][criteria]	string	false
fields[16][data]	choice	true
fields[23][mode]	string	false
fields[23][criteria]	string	false
fields[23][data][]	array of choices	true
fields[28][mode]	string	false
fields[28][criteria]	string	false
fields[28][data]	choice	true
fields[37][mode]	string	false
fields[37][criteria]	string	false
fields[37][data]	datetime	true	yyyy-MM-dd'T'HH:mm:ss
is_reviewed	boolean	false

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.person	integer id (Person)	*	Person created this content first time.
data.language	integer id (Language)	*	Language content was written.
data.translated_language	integer id (Language)	*	Language matched when translating content.
data.slug	string	*	Content slug.
data.title	string	*	Content title.
data.content	string	*	The main content for the item. This should be HTML!
data.view_count	integer	*	View counts.
data.total_rating	integer	*	Total rating: This is a tally and must be updated when a rating is added.
data.num_comments	integer	*	Number of user-visible comments: This is a count that must be updated when a comment is added.
data.num_ratings	integer	*	Total rating.
data.status	string	*	Status title.
data.hidden_status	string	*	Hidden status code.
data.date_created	DateTime	*	DateTime when content was created.
data.date_updated	DateTime	*	DateTime when content was updated last time.
data.date_published	DateTime	*	DateTime when content was published.
data.vote_stats	array	*	Vote stats object, like {"up": 1, "down": 1}.
data.url	string	*	Content's url.
data.revisions[]	array of integer ids (ArticleRevision)	*	Revisions of this article.
data.splash_image_property	integer id (SplashImageProperty)	*
data.brand_id	integer	*	Content's Brand ID.
data.status_category	integer id (CommunityTopicStatusCategory)	*	Category the community topic belongs to.
data.forum	integer id (CommunityForum)	*	Community forum the topic belongs to.
data.labels[]	array of objects (label)	*	String array of labels associated with this news.
data.fields[]	dynamically declared custom fields (array)	*	Custom ticket fields.
data.popularity	integer	*	Popularity.
data.comments_count	integer	*	Comments count.
data.is_reviewed	boolean	*	Is reviewed.
data.attachments[]	array of integer ids (CommunityTopicAttachment)	*	Items attached to the content.
data.custom_data[]	array of objects (CustomDataCommunityTopic)	*	String array of labels associated with this community topic.
data.custom_data[][topic]	object (CommunityTopic)	*
data.custom_data[][topic][hidden_status]	string	*	Hidden status code.
data.custom_data[][topic][brand]	object (Brand)	*
data.custom_data[][topic][brand][id]	integer	*	The unique ID.
data.custom_data[][topic][brand][name]	string	*	The brand name.
data.custom_data[][topic][brand][slug]	string	*
data.custom_data[][topic][brand][url]	string	*	The brand url.
data.custom_data[][topic][brand][theme_set]	object (ThemeSet)	*
data.custom_data[][topic][brand][theme_set][id]	integer	*
data.custom_data[][topic][brand][theme_set][theme_id]	string	*
data.custom_data[][topic][brand][theme_set][title]	string	*
data.custom_data[][topic][brand][theme_set][options]		*
data.custom_data[][topic][brand][edit_theme_set]	object (ThemeSet)	*
data.custom_data[][topic][brand][departments][]	array of objects (Department)	*
data.custom_data[][topic][brand][departments][][id]	integer	*
data.custom_data[][topic][brand][departments][][parent]	object (Department)	*
data.custom_data[][topic][brand][departments][][children][]	array of objects (Department)	*
data.custom_data[][topic][brand][departments][][title]	string	*
data.custom_data[][topic][brand][departments][][user_title]	string	*
data.custom_data[][topic][brand][departments][][is_tickets_enabled]	boolean	*
data.custom_data[][topic][brand][departments][][is_chat_enabled]	boolean	*
data.custom_data[][topic][brand][departments][][display_order]	integer	*
data.custom_data[][topic][brand][departments][][avatar]	object (Blob)	*
data.custom_data[][topic][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.custom_data[][topic][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.custom_data[][topic][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.custom_data[][topic][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.custom_data[][topic][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.custom_data[][topic][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.custom_data[][topic][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.custom_data[][topic][brand][departments][][avatar][authcode]	string	*
data.custom_data[][topic][brand][departments][][avatar][blob_hash]	string	*
data.custom_data[][topic][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.custom_data[][topic][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.custom_data[][topic][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.custom_data[][topic][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.custom_data[][topic][brand][departments][][avatar][date_created]	DateTime	*
data.custom_data[][topic][brand][departments][][avatar][is_temp]	boolean	*
data.custom_data[][topic][brand][departments][][avatar][source_ref]	string	*
data.custom_data[][topic][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.custom_data[][topic][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.custom_data[][topic][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.custom_data[][topic][brand][departments][][brands][]	array of objects (Brand)	*
data.custom_data[][topic][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.custom_data[][topic][brand][departments][][permissions][][department]	integer id (Department)	*
data.custom_data[][topic][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.custom_data[][topic][brand][departments][][permissions][][name]	string	*	The name of the permission.
data.custom_data[][topic][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.custom_data[][topic][brand][departments][][permissions][][is_active]	boolean	*
data.custom_data[][topic][brand][departments][][chat_queue]	object (UserChatQueue)	*
data.custom_data[][topic][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.custom_data[][topic][brand][departments][][chat_queue][name]	string	*
data.custom_data[][topic][brand][departments][][chat_queue][routing_model]	string	*
data.custom_data[][topic][brand][departments][][chat_queue][answer_timeout]	integer	*
data.custom_data[][topic][brand][departments][][chat_queue][is_all_agents]	boolean	*
data.custom_data[][topic][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.custom_data[][topic][brand][departments][][chat_queue][max_queue_size]	integer	*
data.custom_data[][topic][brand][departments][][chat_queue][routingModel]		*
data.custom_data[][topic][brand][theme_sets][]	array of objects (ThemeSet)	*
data.custom_data[][topic][is_reviewed]	boolean	*	Has this community topic been reviewed by an agent?
data.custom_data[][topic][status_category]	object (CommunityTopicStatusCategory)	*	Status category the topic belongs to.
data.custom_data[][topic][status_category][id]	integer	*	The unique ID.
data.custom_data[][topic][status_category][status_type]	string	*	Category status type.
data.custom_data[][topic][status_category][title]	string	*	Category title.
data.custom_data[][topic][status_category][color]	string	*
data.custom_data[][topic][forum]	object (CommunityForum)	*	Forum the topic belongs to.
data.custom_data[][topic][forum][title]		*
data.custom_data[][topic][revisions][]	array of objects (CommunityTopicRevision)	*	Revisions of this topic.
data.custom_data[][topic][revisions][][id]	integer	*	The unique ID.
data.custom_data[][topic][revisions][][person]	integer id (Person)	*	Person who made the revision.
data.custom_data[][topic][revisions][][date_created]	DateTime	*	DateTime the revision was created.
data.custom_data[][topic][revisions][][community_topic]	object (CommunityTopic)	*
data.custom_data[][topic][revisions][][title]	string	*
data.custom_data[][topic][revisions][][content]	string	*
data.custom_data[][topic][revisions][][content_input]	string	*
data.custom_data[][topic][revisions][][content_input_type]	string	*	Revision content_input type of community topic.
data.custom_data[][topic][labels][]	array of objects (LabelCommunityTopic)	*	String array of labels associated with this news.
data.custom_data[][topic][labels][][topic]	object (CommunityTopic)	*
data.custom_data[][topic][custom_data][]	array of objects (CustomDataCommunityTopic)	*
data.custom_data[][topic][popularity]	integer	*	Popularity. (see recalculatePopularity)
data.custom_data[][topic][attachments][]	array of objects (CommunityTopicAttachment)	*
data.custom_data[][topic][attachments][][id]	integer	*
data.custom_data[][topic][attachments][][topic]	integer id (CommunityTopic)	*
data.custom_data[][topic][attachments][][person]	integer id (Person)	*	Who created the attachment.
data.custom_data[][topic][attachments][][blob]	object (Blob)	*
data.custom_data[][topic][attachments][][blob][sys_name]	string	*	A unique system name for the blob.
data.custom_data[][topic][attachments][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.custom_data[][topic][attachments][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.custom_data[][topic][attachments][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.custom_data[][topic][attachments][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.custom_data[][topic][attachments][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.custom_data[][topic][attachments][][blob][file_url]	string	*	The HTTP link to download the file.
data.custom_data[][topic][attachments][][blob][authcode]	string	*
data.custom_data[][topic][attachments][][blob][blob_hash]	string	*
data.custom_data[][topic][attachments][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.custom_data[][topic][attachments][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.custom_data[][topic][attachments][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.custom_data[][topic][attachments][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.custom_data[][topic][attachments][][blob][date_created]	DateTime	*
data.custom_data[][topic][attachments][][blob][is_temp]	boolean	*
data.custom_data[][topic][attachments][][blob][source_ref]	string	*
data.custom_data[][topic][attachments][][blob][labels][]	array of objects (LabelBlob)	*
data.custom_data[][topic][attachments][][blob][labels][][blob]	object (Blob)	*
data.custom_data[][topic][official_response]	object (CommunityTopicComment)	*
data.custom_data[][topic][official_response][id]	integer	*	The unique ID.
data.custom_data[][topic][official_response][person]	integer id (Person)	*	The id of person that wrote this comment.
data.custom_data[][topic][official_response][ip_address]	string	*	IP address with which comment was written.
data.custom_data[][topic][official_response][email]	string	*	Person`s email.
data.custom_data[][topic][official_response][name]	string	*	Person`s name.
data.custom_data[][topic][official_response][website]	string	*	Website where comment was written.
data.custom_data[][topic][official_response][content]	string	*	Comment`s content itself.
data.custom_data[][topic][official_response][status]	string	*	Comment`s status.
data.custom_data[][topic][official_response][is_reviewed]	boolean	*	Has this comment been reviewed by an agent?
data.custom_data[][topic][official_response][date_created]	DateTime	*	When this comment was created.
data.custom_data[][topic][official_response][content_type]	string	*	Content Type for this comment.
data.custom_data[][topic][official_response][rating]	integer	*	Total rating for this comment.
data.custom_data[][topic][official_response][topic]	integer id (CommunityTopic)	*	CommunityTopic this comment belongs to.
data.custom_data[][topic][status_transitions][]	array of objects (CommunityTopicStatusTransition)	*
data.custom_data[][topic][status_transitions][][id]	integer	*
data.custom_data[][topic][status_transitions][][topic]	object (CommunityTopic)	*
data.custom_data[][topic][status_transitions][][old_status_category]	object (CommunityTopicStatusCategory)	*
data.custom_data[][topic][status_transitions][][new_status_category]	object (CommunityTopicStatusCategory)	*
data.custom_data[][topic][status_transitions][][date_created]	DateTime	*
data.custom_data[][topic][status_transitions][][performer]	object (Person)	*
data.custom_data[][topic][status_transitions][][performer][emails]		*
data.custom_data[][topic][status_transitions][][performer][labels]		*
data.custom_data[][topic][status_transitions][][performer][teams]		*
data.custom_data[][topic][status_transitions][][performer][primary_team]		*
data.custom_data[][topic][status_transitions][][performer][agentData]		*
data.custom_data[][topic][status_transitions][][performer][publicUsergroups]		*
data.custom_data[][topic][status_transitions][][performer][publicAgentgroups]		*
data.custom_data[][topic][content_format]	string	*
data.custom_data[][topic][content_data]	array	*
data.custom_data[][topic][title]		*
data.custom_data[][topic][content]		*
data.custom_data[][topic][comments]		*
data.custom_data[][topic][status]		*
data.custom_data[][field]	object (CustomDefCommunityTopic)	*
data.custom_data[][field][parent]	object (CustomDefCommunityTopic)	*
data.custom_data[][field][children][]	array of objects (CustomDefCommunityTopic)	*	Field children.
data.custom_data[][field][brand]	object (Brand)	*
data.custom_data[][field][brand][id]	integer	*	The unique ID.
data.custom_data[][field][brand][name]	string	*	The brand name.
data.custom_data[][field][brand][slug]	string	*
data.custom_data[][field][brand][url]	string	*	The brand url.
data.custom_data[][field][brand][theme_set]	object (ThemeSet)	*
data.custom_data[][field][brand][theme_set][id]	integer	*
data.custom_data[][field][brand][theme_set][theme_id]	string	*
data.custom_data[][field][brand][theme_set][title]	string	*
data.custom_data[][field][brand][theme_set][options]		*
data.custom_data[][field][brand][edit_theme_set]	object (ThemeSet)	*
data.custom_data[][field][brand][departments][]	array of objects (Department)	*
data.custom_data[][field][brand][departments][][id]	integer	*
data.custom_data[][field][brand][departments][][parent]	object (Department)	*
data.custom_data[][field][brand][departments][][children][]	array of objects (Department)	*
data.custom_data[][field][brand][departments][][title]	string	*
data.custom_data[][field][brand][departments][][user_title]	string	*
data.custom_data[][field][brand][departments][][is_tickets_enabled]	boolean	*
data.custom_data[][field][brand][departments][][is_chat_enabled]	boolean	*
data.custom_data[][field][brand][departments][][display_order]	integer	*
data.custom_data[][field][brand][departments][][avatar]	object (Blob)	*
data.custom_data[][field][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.custom_data[][field][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.custom_data[][field][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.custom_data[][field][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.custom_data[][field][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.custom_data[][field][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.custom_data[][field][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.custom_data[][field][brand][departments][][avatar][authcode]	string	*
data.custom_data[][field][brand][departments][][avatar][blob_hash]	string	*
data.custom_data[][field][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.custom_data[][field][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.custom_data[][field][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.custom_data[][field][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.custom_data[][field][brand][departments][][avatar][date_created]	DateTime	*
data.custom_data[][field][brand][departments][][avatar][is_temp]	boolean	*
data.custom_data[][field][brand][departments][][avatar][source_ref]	string	*
data.custom_data[][field][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.custom_data[][field][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.custom_data[][field][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.custom_data[][field][brand][departments][][brands][]	array of objects (Brand)	*
data.custom_data[][field][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.custom_data[][field][brand][departments][][permissions][][department]	integer id (Department)	*
data.custom_data[][field][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.custom_data[][field][brand][departments][][permissions][][name]	string	*	The name of the permission.
data.custom_data[][field][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.custom_data[][field][brand][departments][][permissions][][is_active]	boolean	*
data.custom_data[][field][brand][departments][][chat_queue]	object (UserChatQueue)	*
data.custom_data[][field][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.custom_data[][field][brand][departments][][chat_queue][name]	string	*
data.custom_data[][field][brand][departments][][chat_queue][routing_model]	string	*
data.custom_data[][field][brand][departments][][chat_queue][answer_timeout]	integer	*
data.custom_data[][field][brand][departments][][chat_queue][is_all_agents]	boolean	*
data.custom_data[][field][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.custom_data[][field][brand][departments][][chat_queue][max_queue_size]	integer	*
data.custom_data[][field][brand][departments][][chat_queue][routingModel]		*
data.custom_data[][field][brand][theme_sets][]	array of objects (ThemeSet)	*
data.custom_data[][field][forums][]	array of objects (CommunityForumToCustomDefCommunityTopic)	*
data.custom_data[][field][forums][][display_order]	integer	*
data.custom_data[][field][is_global]	boolean	*
data.custom_data[][field][title]		*
data.custom_data[][root_field]	object (CustomDefCommunityTopic)	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/community_topics/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

community.community_topics.count

Filters
Response
Status Codes

Name

Information

awaiting_validation

Pattern	1
Description	select community topics awaiting validation only
Datatype	boolean

status

Pattern	active\|closed\|hidden
Description	filter by status
Datatype	string

hidden_status

Datatype	integer
Pattern	unpublished\|deleted\|spam\|draft
Description	limit with hidden_status

status_category

Pattern	\w\|[\w]
Description	filter by status category
Datatype	string[]

forum

Pattern	\w\|[\w]
Description	forum title, or titles array
Datatype	string[]

category

Pattern	\w\|[\w]
Description	filter by category
Datatype	string[]

labels_mode

Pattern	any\|all
Description	how to load labels
Datatype	string

label

Pattern	\w,\w...\w
Description	select community topics with given lables
Datatype	string

no_labels

Pattern	1
Description	select community topics have no label
Datatype	boolean

ids

Pattern	\d,\d...\d
Description	comma separated ids list
Datatype	string

created_from

Pattern	YYYY-mm-dd H:i:s
Description	limit by date, interval`s start
Datatype	date

created_to

Pattern	YYYY-mm-dd H:i:s
Description	limit by date, interval`s end
Datatype	date

community_topic_field.{id}

Description	\n * Custom community topic field filter. To filter by a custom field with ID=1 you need to add\n * ?community_topic_field.1=value to the query string
Datatype	string
Pattern	\d+\|\w

group_by

Pattern	status_category\|hidden_status\|forum\|category
Description	how to group counts
Datatype	boolean

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/community_topics/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

community.community_topics.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/community_topics/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

community.community_topics.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.person	integer id (Person)	*	Person created this content first time.
data.language	integer id (Language)	*	Language content was written.
data.translated_language	integer id (Language)	*	Language matched when translating content.
data.slug	string	*	Content slug.
data.title	string	*	Content title.
data.content	string	*	The main content for the item. This should be HTML!
data.view_count	integer	*	View counts.
data.total_rating	integer	*	Total rating: This is a tally and must be updated when a rating is added.
data.num_comments	integer	*	Number of user-visible comments: This is a count that must be updated when a comment is added.
data.num_ratings	integer	*	Total rating.
data.status	string	*	Status title.
data.hidden_status	string	*	Hidden status code.
data.date_created	DateTime	*	DateTime when content was created.
data.date_updated	DateTime	*	DateTime when content was updated last time.
data.date_published	DateTime	*	DateTime when content was published.
data.vote_stats	array	*	Vote stats object, like {"up": 1, "down": 1}.
data.url	string	*	Content's url.
data.revisions[]	array of integer ids (ArticleRevision)	*	Revisions of this article.
data.splash_image_property	integer id (SplashImageProperty)	*
data.brand_id	integer	*	Content's Brand ID.
data.status_category	integer id (CommunityTopicStatusCategory)	*	Category the community topic belongs to.
data.forum	integer id (CommunityForum)	*	Community forum the topic belongs to.
data.labels[]	array of objects (label)	*	String array of labels associated with this news.
data.fields[]	dynamically declared custom fields (array)	*	Custom ticket fields.
data.popularity	integer	*	Popularity.
data.comments_count	integer	*	Comments count.
data.is_reviewed	boolean	*	Is reviewed.
data.attachments[]	array of integer ids (CommunityTopicAttachment)	*	Items attached to the content.
data.custom_data[]	array of objects (CustomDataCommunityTopic)	*	String array of labels associated with this community topic.
data.custom_data[][topic]	object (CommunityTopic)	*
data.custom_data[][topic][hidden_status]	string	*	Hidden status code.
data.custom_data[][topic][brand]	object (Brand)	*
data.custom_data[][topic][brand][id]	integer	*	The unique ID.
data.custom_data[][topic][brand][name]	string	*	The brand name.
data.custom_data[][topic][brand][slug]	string	*
data.custom_data[][topic][brand][url]	string	*	The brand url.
data.custom_data[][topic][brand][theme_set]	object (ThemeSet)	*
data.custom_data[][topic][brand][theme_set][id]	integer	*
data.custom_data[][topic][brand][theme_set][theme_id]	string	*
data.custom_data[][topic][brand][theme_set][title]	string	*
data.custom_data[][topic][brand][theme_set][options]		*
data.custom_data[][topic][brand][edit_theme_set]	object (ThemeSet)	*
data.custom_data[][topic][brand][departments][]	array of objects (Department)	*
data.custom_data[][topic][brand][departments][][id]	integer	*
data.custom_data[][topic][brand][departments][][parent]	object (Department)	*
data.custom_data[][topic][brand][departments][][children][]	array of objects (Department)	*
data.custom_data[][topic][brand][departments][][title]	string	*
data.custom_data[][topic][brand][departments][][user_title]	string	*
data.custom_data[][topic][brand][departments][][is_tickets_enabled]	boolean	*
data.custom_data[][topic][brand][departments][][is_chat_enabled]	boolean	*
data.custom_data[][topic][brand][departments][][display_order]	integer	*
data.custom_data[][topic][brand][departments][][avatar]	object (Blob)	*
data.custom_data[][topic][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.custom_data[][topic][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.custom_data[][topic][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.custom_data[][topic][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.custom_data[][topic][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.custom_data[][topic][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.custom_data[][topic][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.custom_data[][topic][brand][departments][][avatar][authcode]	string	*
data.custom_data[][topic][brand][departments][][avatar][blob_hash]	string	*
data.custom_data[][topic][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.custom_data[][topic][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.custom_data[][topic][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.custom_data[][topic][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.custom_data[][topic][brand][departments][][avatar][date_created]	DateTime	*
data.custom_data[][topic][brand][departments][][avatar][is_temp]	boolean	*
data.custom_data[][topic][brand][departments][][avatar][source_ref]	string	*
data.custom_data[][topic][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.custom_data[][topic][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.custom_data[][topic][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.custom_data[][topic][brand][departments][][brands][]	array of objects (Brand)	*
data.custom_data[][topic][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.custom_data[][topic][brand][departments][][permissions][][department]	integer id (Department)	*
data.custom_data[][topic][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.custom_data[][topic][brand][departments][][permissions][][name]	string	*	The name of the permission.
data.custom_data[][topic][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.custom_data[][topic][brand][departments][][permissions][][is_active]	boolean	*
data.custom_data[][topic][brand][departments][][chat_queue]	object (UserChatQueue)	*
data.custom_data[][topic][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.custom_data[][topic][brand][departments][][chat_queue][name]	string	*
data.custom_data[][topic][brand][departments][][chat_queue][routing_model]	string	*
data.custom_data[][topic][brand][departments][][chat_queue][answer_timeout]	integer	*
data.custom_data[][topic][brand][departments][][chat_queue][is_all_agents]	boolean	*
data.custom_data[][topic][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.custom_data[][topic][brand][departments][][chat_queue][max_queue_size]	integer	*
data.custom_data[][topic][brand][departments][][chat_queue][routingModel]		*
data.custom_data[][topic][brand][theme_sets][]	array of objects (ThemeSet)	*
data.custom_data[][topic][is_reviewed]	boolean	*	Has this community topic been reviewed by an agent?
data.custom_data[][topic][status_category]	object (CommunityTopicStatusCategory)	*	Status category the topic belongs to.
data.custom_data[][topic][status_category][id]	integer	*	The unique ID.
data.custom_data[][topic][status_category][status_type]	string	*	Category status type.
data.custom_data[][topic][status_category][title]	string	*	Category title.
data.custom_data[][topic][status_category][color]	string	*
data.custom_data[][topic][forum]	object (CommunityForum)	*	Forum the topic belongs to.
data.custom_data[][topic][forum][title]		*
data.custom_data[][topic][revisions][]	array of objects (CommunityTopicRevision)	*	Revisions of this topic.
data.custom_data[][topic][revisions][][id]	integer	*	The unique ID.
data.custom_data[][topic][revisions][][person]	integer id (Person)	*	Person who made the revision.
data.custom_data[][topic][revisions][][date_created]	DateTime	*	DateTime the revision was created.
data.custom_data[][topic][revisions][][community_topic]	object (CommunityTopic)	*
data.custom_data[][topic][revisions][][title]	string	*
data.custom_data[][topic][revisions][][content]	string	*
data.custom_data[][topic][revisions][][content_input]	string	*
data.custom_data[][topic][revisions][][content_input_type]	string	*	Revision content_input type of community topic.
data.custom_data[][topic][labels][]	array of objects (LabelCommunityTopic)	*	String array of labels associated with this news.
data.custom_data[][topic][labels][][topic]	object (CommunityTopic)	*
data.custom_data[][topic][custom_data][]	array of objects (CustomDataCommunityTopic)	*
data.custom_data[][topic][popularity]	integer	*	Popularity. (see recalculatePopularity)
data.custom_data[][topic][attachments][]	array of objects (CommunityTopicAttachment)	*
data.custom_data[][topic][attachments][][id]	integer	*
data.custom_data[][topic][attachments][][topic]	integer id (CommunityTopic)	*
data.custom_data[][topic][attachments][][person]	integer id (Person)	*	Who created the attachment.
data.custom_data[][topic][attachments][][blob]	object (Blob)	*
data.custom_data[][topic][attachments][][blob][sys_name]	string	*	A unique system name for the blob.
data.custom_data[][topic][attachments][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.custom_data[][topic][attachments][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.custom_data[][topic][attachments][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.custom_data[][topic][attachments][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.custom_data[][topic][attachments][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.custom_data[][topic][attachments][][blob][file_url]	string	*	The HTTP link to download the file.
data.custom_data[][topic][attachments][][blob][authcode]	string	*
data.custom_data[][topic][attachments][][blob][blob_hash]	string	*
data.custom_data[][topic][attachments][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.custom_data[][topic][attachments][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.custom_data[][topic][attachments][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.custom_data[][topic][attachments][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.custom_data[][topic][attachments][][blob][date_created]	DateTime	*
data.custom_data[][topic][attachments][][blob][is_temp]	boolean	*
data.custom_data[][topic][attachments][][blob][source_ref]	string	*
data.custom_data[][topic][attachments][][blob][labels][]	array of objects (LabelBlob)	*
data.custom_data[][topic][attachments][][blob][labels][][blob]	object (Blob)	*
data.custom_data[][topic][official_response]	object (CommunityTopicComment)	*
data.custom_data[][topic][official_response][id]	integer	*	The unique ID.
data.custom_data[][topic][official_response][person]	integer id (Person)	*	The id of person that wrote this comment.
data.custom_data[][topic][official_response][ip_address]	string	*	IP address with which comment was written.
data.custom_data[][topic][official_response][email]	string	*	Person`s email.
data.custom_data[][topic][official_response][name]	string	*	Person`s name.
data.custom_data[][topic][official_response][website]	string	*	Website where comment was written.
data.custom_data[][topic][official_response][content]	string	*	Comment`s content itself.
data.custom_data[][topic][official_response][status]	string	*	Comment`s status.
data.custom_data[][topic][official_response][is_reviewed]	boolean	*	Has this comment been reviewed by an agent?
data.custom_data[][topic][official_response][date_created]	DateTime	*	When this comment was created.
data.custom_data[][topic][official_response][content_type]	string	*	Content Type for this comment.
data.custom_data[][topic][official_response][rating]	integer	*	Total rating for this comment.
data.custom_data[][topic][official_response][topic]	integer id (CommunityTopic)	*	CommunityTopic this comment belongs to.
data.custom_data[][topic][status_transitions][]	array of objects (CommunityTopicStatusTransition)	*
data.custom_data[][topic][status_transitions][][id]	integer	*
data.custom_data[][topic][status_transitions][][topic]	object (CommunityTopic)	*
data.custom_data[][topic][status_transitions][][old_status_category]	object (CommunityTopicStatusCategory)	*
data.custom_data[][topic][status_transitions][][new_status_category]	object (CommunityTopicStatusCategory)	*
data.custom_data[][topic][status_transitions][][date_created]	DateTime	*
data.custom_data[][topic][status_transitions][][performer]	object (Person)	*
data.custom_data[][topic][status_transitions][][performer][emails]		*
data.custom_data[][topic][status_transitions][][performer][labels]		*
data.custom_data[][topic][status_transitions][][performer][teams]		*
data.custom_data[][topic][status_transitions][][performer][primary_team]		*
data.custom_data[][topic][status_transitions][][performer][agentData]		*
data.custom_data[][topic][status_transitions][][performer][publicUsergroups]		*
data.custom_data[][topic][status_transitions][][performer][publicAgentgroups]		*
data.custom_data[][topic][content_format]	string	*
data.custom_data[][topic][content_data]	array	*
data.custom_data[][topic][title]		*
data.custom_data[][topic][content]		*
data.custom_data[][topic][comments]		*
data.custom_data[][topic][status]		*
data.custom_data[][field]	object (CustomDefCommunityTopic)	*
data.custom_data[][field][parent]	object (CustomDefCommunityTopic)	*
data.custom_data[][field][children][]	array of objects (CustomDefCommunityTopic)	*	Field children.
data.custom_data[][field][brand]	object (Brand)	*
data.custom_data[][field][brand][id]	integer	*	The unique ID.
data.custom_data[][field][brand][name]	string	*	The brand name.
data.custom_data[][field][brand][slug]	string	*
data.custom_data[][field][brand][url]	string	*	The brand url.
data.custom_data[][field][brand][theme_set]	object (ThemeSet)	*
data.custom_data[][field][brand][theme_set][id]	integer	*
data.custom_data[][field][brand][theme_set][theme_id]	string	*
data.custom_data[][field][brand][theme_set][title]	string	*
data.custom_data[][field][brand][theme_set][options]		*
data.custom_data[][field][brand][edit_theme_set]	object (ThemeSet)	*
data.custom_data[][field][brand][departments][]	array of objects (Department)	*
data.custom_data[][field][brand][departments][][id]	integer	*
data.custom_data[][field][brand][departments][][parent]	object (Department)	*
data.custom_data[][field][brand][departments][][children][]	array of objects (Department)	*
data.custom_data[][field][brand][departments][][title]	string	*
data.custom_data[][field][brand][departments][][user_title]	string	*
data.custom_data[][field][brand][departments][][is_tickets_enabled]	boolean	*
data.custom_data[][field][brand][departments][][is_chat_enabled]	boolean	*
data.custom_data[][field][brand][departments][][display_order]	integer	*
data.custom_data[][field][brand][departments][][avatar]	object (Blob)	*
data.custom_data[][field][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.custom_data[][field][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.custom_data[][field][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.custom_data[][field][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.custom_data[][field][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.custom_data[][field][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.custom_data[][field][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.custom_data[][field][brand][departments][][avatar][authcode]	string	*
data.custom_data[][field][brand][departments][][avatar][blob_hash]	string	*
data.custom_data[][field][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.custom_data[][field][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.custom_data[][field][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.custom_data[][field][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.custom_data[][field][brand][departments][][avatar][date_created]	DateTime	*
data.custom_data[][field][brand][departments][][avatar][is_temp]	boolean	*
data.custom_data[][field][brand][departments][][avatar][source_ref]	string	*
data.custom_data[][field][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.custom_data[][field][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.custom_data[][field][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.custom_data[][field][brand][departments][][brands][]	array of objects (Brand)	*
data.custom_data[][field][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.custom_data[][field][brand][departments][][permissions][][department]	integer id (Department)	*
data.custom_data[][field][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.custom_data[][field][brand][departments][][permissions][][name]	string	*	The name of the permission.
data.custom_data[][field][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.custom_data[][field][brand][departments][][permissions][][is_active]	boolean	*
data.custom_data[][field][brand][departments][][chat_queue]	object (UserChatQueue)	*
data.custom_data[][field][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.custom_data[][field][brand][departments][][chat_queue][name]	string	*
data.custom_data[][field][brand][departments][][chat_queue][routing_model]	string	*
data.custom_data[][field][brand][departments][][chat_queue][answer_timeout]	integer	*
data.custom_data[][field][brand][departments][][chat_queue][is_all_agents]	boolean	*
data.custom_data[][field][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.custom_data[][field][brand][departments][][chat_queue][max_queue_size]	integer	*
data.custom_data[][field][brand][departments][][chat_queue][routingModel]		*
data.custom_data[][field][brand][theme_sets][]	array of objects (ThemeSet)	*
data.custom_data[][field][forums][]	array of objects (CommunityForumToCustomDefCommunityTopic)	*
data.custom_data[][field][forums][][display_order]	integer	*
data.custom_data[][field][is_global]	boolean	*
data.custom_data[][field][title]		*
data.custom_data[][root_field]	object (CustomDefCommunityTopic)	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/community_topics/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

community.community_topics.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format
title	string	false
content	string	false
person[id]	string	false
person[name]	string	false
person[email]	string	false
person[fieldId]	string	false
person[key]	string	false
forum	choice	false
status	choice	false	["active","closed","hidden"]
labels[]	array of strings	false
fields[1][mode]	string	false
fields[1][criteria]	string	false
fields[1][data]	choice	false
fields[5][mode]	string	false
fields[5][criteria]	string	false
fields[5][data]	choice	false
fields[9][mode]	string	false
fields[9][criteria]	string	false
fields[9][data]	string	false
fields[10][mode]	string	false
fields[10][criteria]	string	false
fields[10][data]	string	false
fields[11][mode]	string	false
fields[11][criteria]	string	false
fields[11][data][]	array of choices	false
fields[15][mode]	string	false
fields[15][criteria]	string	false
fields[15][data]	date	false	yyyy-MM-dd
fields[16][mode]	string	false
fields[16][criteria]	string	false
fields[16][data]	choice	false
fields[23][mode]	string	false
fields[23][criteria]	string	false
fields[23][data][]	array of choices	false
fields[28][mode]	string	false
fields[28][criteria]	string	false
fields[28][data]	choice	false
fields[37][mode]	string	false
fields[37][criteria]	string	false
fields[37][data]	datetime	false	yyyy-MM-dd'T'HH:mm:ss
is_reviewed	boolean	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

Show/hide List Operations Expand Operations

Content

GET /api/v2/article_categories CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.article_categories.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (ArticleCategory)	*
data[][id]	integer	*	The unique id of the category.
data[][title]	string	*	Category`s title.
data[][title_translations][]	array of objects (Phrase)	*
data[][title_translations][][language]	integer id (Language)	*	The language this phrase belongs to.
data[][title_translations][][value]	string	*
data[][slug]	string	*	Category`s slug.
data[][display_order]	integer	*	Display order.
data[][parent]	integer id (ArticleCategory)	*
data[][children][]	array of integer ids (ArticleCategory)	*
data[][usergroups][]	array of integer ids (Usergroup)	*	Usergroups that has access to this category.
data[][brand]	integer id (Brand)	*	Brand linked to the category.
data[][is_agent]	boolean	*	If this is true, then all categories and articles under this one are considered agent KB articles and wont be displayed in the user interface.
data[][is_book]	boolean	*	If this is true, then all the articles and categories under this category is treated as a book (aka manual).
data[][template_suffix]	string	*	The template suffix to use when rendering the category, and articles within the category.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/article_categories CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.article_categories.post

Parameters
Response
Status Codes

Parameter	Type	Required?
title	string	true
title_translations[][language]	choice	true
title_translations[][value]	string	true
brand	choice	false
usergroups[]	array of choices	false
parent	choice	false

Parameter	Type	Versions	Description
data.id	integer	*	The unique id of the category.
data.title	string	*	Category`s title.
data.title_translations[]	array of objects (Phrase)	*
data.title_translations[][language]	integer id (Language)	*	The language this phrase belongs to.
data.title_translations[][value]	string	*
data.slug	string	*	Category`s slug.
data.display_order	integer	*	Display order.
data.parent	integer id (ArticleCategory)	*
data.children[]	array of integer ids (ArticleCategory)	*
data.usergroups[]	array of integer ids (Usergroup)	*	Usergroups that has access to this category.
data.brand	integer id (Brand)	*	Brand linked to the category.
data.is_agent	boolean	*	If this is true, then all categories and articles under this one are considered agent KB articles and wont be displayed in the user interface.
data.is_book	boolean	*	If this is true, then all the articles and categories under this category is treated as a book (aka manual).
data.template_suffix	string	*	The template suffix to use when rendering the category, and articles within the category.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/article_categories/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.article_categories.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/article_categories/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.article_categories.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/article_categories/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.article_categories.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.id	integer	*	The unique id of the category.
data.title	string	*	Category`s title.
data.title_translations[]	array of objects (Phrase)	*
data.title_translations[][language]	integer id (Language)	*	The language this phrase belongs to.
data.title_translations[][value]	string	*
data.slug	string	*	Category`s slug.
data.display_order	integer	*	Display order.
data.parent	integer id (ArticleCategory)	*
data.children[]	array of integer ids (ArticleCategory)	*
data.usergroups[]	array of integer ids (Usergroup)	*	Usergroups that has access to this category.
data.brand	integer id (Brand)	*	Brand linked to the category.
data.is_agent	boolean	*	If this is true, then all categories and articles under this one are considered agent KB articles and wont be displayed in the user interface.
data.is_book	boolean	*	If this is true, then all the articles and categories under this category is treated as a book (aka manual).
data.template_suffix	string	*	The template suffix to use when rendering the category, and articles within the category.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/article_categories/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.article_categories.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?
title	string	false
title_translations[][language]	choice	false
title_translations[][value]	string	false
brand	choice	false
usergroups[]	array of choices	false
parent	choice	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

POST /api/v2/article_comments CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.comments.article_all_comments.post

Response
Status Codes

Parameter	Type	Versions	Description
data.status	string	*	Comment`s status.
data.id	integer	*	The unique ID.
data.person	integer id (Person)	*	The id of person that wrote this comment.
data.ip_address	string	*	IP address with which comment was written.
data.email	string	*	Person`s email.
data.name	string	*	Person`s name.
data.website	string	*	Website where comment was written.
data.content	string	*	Comment`s content itself.
data.is_reviewed	boolean	*	Has this comment been reviewed by an agent?
data.date_created	DateTime	*	When this comment was created.
data.content_type	string	*	Content Type for this comment.
data.rating	integer	*	Total rating for this comment.
data.article	integer id (Article)	*	The article this comment belongs to.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

PUT /api/v2/article_comments/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.comments.article_all_comments.put

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/article_pending_creates CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

content.article_pending_create.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

assigned_person

Datatype	string\|integer
Pattern	me\|\d+

order_by

Pattern	date_created\|assigned_person
Description	how to order result
Datatype	string

order_dir

Pattern	asc\|desc
Description	order direction
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (ArticlePendingCreate)	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/article_pending_creates CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.article_pending_create.post

Status Codes

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/article_pending_creates/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

content.article_pending_create.count

Filters
Response
Status Codes

Name

Information

assigned_person

Datatype	string\|integer
Pattern	me\|\d+

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/article_pending_creates/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.article_pending_create.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/article_pending_creates/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.article_pending_create.get

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/article_pending_creates/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.article_pending_create.put

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/articles CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

content.articles.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

author

Datatype	string
Pattern	\d+\|me
Description	filter by author, provide an id or 'me' for current user

category

Datatype	integer
Pattern	\d+\|[\d+]
Description	filter category, could be an array or just digit

group_by

Datatype	string
Pattern	author\|category\|period_created\|period_updated
Description	how to group downloads

status

Datatype	string
Pattern	published\|archived\|hidden
Description	filter by status

hidden_status

Datatype	integer
Pattern	unpublished\|deleted\|spam\|draft
Description	select for article with given id

period_created

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by period when content was created

period_last_comment

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by period when content was last commented

period_published

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by py period when content was published

period_updated

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by py period when content was updated

order_by

Datatype	integer
Pattern	date_created\|date_updated\|person
Description	how to order

Parameter	Type	Versions	Description
data[]	array of objects (Article)	*
data[][attachments]		*
data[][labels][]	array of objects (LabelArticle)	*	String array of labels associated with this article.
data[][labels][][article]	object (Article)	*
data[][labels][][article][categories][]	array of objects (ArticleToCategory)	*
data[][labels][][article][revisions][]	array of objects (ArticleRevision)	*	Revisions of this article.
data[][labels][][article][date_end]	DateTime	*
data[][labels][][article][date_next_review]	DateTime	*
data[][labels][][article][review_interval]	string	*
data[][labels][][article][end_action]	string	*
data[][labels][][article][custom_data][]	array of objects (CustomDataArticle)	*
data[][labels][][article][labels][]	array of objects (LabelArticle)	*	String array of labels associated with this article.
data[][labels][][article][content_format]	string	*
data[][labels][][article][content_data]	array	*
data[][titleTranslations]		*
data[][contentTranslations]		*
data[][title]		*
data[][content]		*
data[][comments]		*
data[][status]		*
data[][categories][]	array of objects (ArticleToCategory)	*
data[][categories][][article]	object (Article)	*
data[][categories][][article][categories][]	array of objects (ArticleToCategory)	*
data[][categories][][article][revisions][]	array of objects (ArticleRevision)	*	Revisions of this article.
data[][categories][][article][revisions][][id]	integer	*	The unique ID.
data[][categories][][article][revisions][][person]	integer id (Person)	*	Person who made the revision.
data[][categories][][article][revisions][][date_created]	DateTime	*	DateTime the revision was created.
data[][categories][][article][date_end]	DateTime	*
data[][categories][][article][date_next_review]	DateTime	*
data[][categories][][article][review_interval]	string	*
data[][categories][][article][end_action]	string	*
data[][categories][][article][custom_data][]	array of objects (CustomDataArticle)	*
data[][categories][][article][custom_data][][article]	object (Article)	*
data[][categories][][article][custom_data][][field]	object (CustomDefArticle)	*
data[][categories][][article][custom_data][][field][parent]	object (CustomDefArticle)	*
data[][categories][][article][custom_data][][field][children][]	array of objects (CustomDefArticle)	*	Field children.
data[][categories][][article][custom_data][][root_field]	object (CustomDefArticle)	*
data[][categories][][article][labels][]	array of objects (LabelArticle)	*	String array of labels associated with this article.
data[][categories][][article][labels][][article]	object (Article)	*
data[][categories][][article][content_format]	string	*
data[][categories][][article][content_data]	array	*
data[][categories][][category]	object (ArticleCategory)	*
data[][categories][][category][parent]	object (ArticleCategory)	*
data[][categories][][category][children][]	array of objects (ArticleCategory)	*
data[][categories][][category][articles][]	array of objects (ArticleToCategory)	*	Articles belongs this category.
data[][categories][][category][usergroups][]	array of objects (Usergroup)	*	Usergroups that has access to this category.
data[][categories][][category][usergroups][][id]	integer	*	The unique ID, DB-generated.
data[][categories][][category][usergroups][][title]	string	*	Title of the usergroup.
data[][categories][][category][usergroups][][note]	string	*	A note or description about the usergroup.
data[][categories][][category][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data[][categories][][category][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data[][categories][][category][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data[][categories][][category][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data[][categories][][category][usergroups][][permissions][][id]	integer	*	The unique ID.
data[][categories][][category][usergroups][][permissions][][name]	string	*	The name of the permission.
data[][categories][][category][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][categories][][category][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data[][categories][][category][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data[][categories][][category][usergroups][][department_permissions][][department]	integer id (Department)	*
data[][categories][][category][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][categories][][category][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data[][categories][][category][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][categories][][category][usergroups][][department_permissions][][is_active]	boolean	*
data[][categories][][category][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data[][categories][][category][brand]	object (Brand)	*	Brand linked to the category.
data[][categories][][category][brand][id]	integer	*	The unique ID.
data[][categories][][category][brand][name]	string	*	The brand name.
data[][categories][][category][brand][slug]	string	*
data[][categories][][category][brand][url]	string	*	The brand url.
data[][categories][][category][brand][theme_set]	object (ThemeSet)	*
data[][categories][][category][brand][theme_set][id]	integer	*
data[][categories][][category][brand][theme_set][theme_id]	string	*
data[][categories][][category][brand][theme_set][title]	string	*
data[][categories][][category][brand][edit_theme_set]	object (ThemeSet)	*
data[][categories][][category][brand][departments][]	array of objects (Department)	*
data[][categories][][category][brand][departments][][id]	integer	*
data[][categories][][category][brand][departments][][parent]	object (Department)	*
data[][categories][][category][brand][departments][][children][]	array of objects (Department)	*
data[][categories][][category][brand][departments][][title]	string	*
data[][categories][][category][brand][departments][][user_title]	string	*
data[][categories][][category][brand][departments][][is_tickets_enabled]	boolean	*
data[][categories][][category][brand][departments][][is_chat_enabled]	boolean	*
data[][categories][][category][brand][departments][][display_order]	integer	*
data[][categories][][category][brand][departments][][avatar]	object (Blob)	*
data[][categories][][category][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data[][categories][][category][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][categories][][category][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][categories][][category][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][categories][][category][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][categories][][category][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data[][categories][][category][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data[][categories][][category][brand][departments][][avatar][authcode]	string	*
data[][categories][][category][brand][departments][][avatar][blob_hash]	string	*
data[][categories][][category][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][categories][][category][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][categories][][category][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][categories][][category][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][categories][][category][brand][departments][][avatar][date_created]	DateTime	*
data[][categories][][category][brand][departments][][avatar][is_temp]	boolean	*
data[][categories][][category][brand][departments][][avatar][source_ref]	string	*
data[][categories][][category][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data[][categories][][category][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data[][categories][][category][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][categories][][category][brand][departments][][brands][]	array of objects (Brand)	*
data[][categories][][category][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data[][categories][][category][brand][departments][][permissions][][department]	integer id (Department)	*
data[][categories][][category][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][categories][][category][brand][departments][][permissions][][name]	string	*	The name of the permission.
data[][categories][][category][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][categories][][category][brand][departments][][permissions][][is_active]	boolean	*
data[][categories][][category][brand][departments][][chat_queue]	object (UserChatQueue)	*
data[][categories][][category][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data[][categories][][category][brand][departments][][chat_queue][name]	string	*
data[][categories][][category][brand][departments][][chat_queue][routing_model]	string	*
data[][categories][][category][brand][departments][][chat_queue][answer_timeout]	integer	*
data[][categories][][category][brand][departments][][chat_queue][is_all_agents]	boolean	*
data[][categories][][category][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data[][categories][][category][brand][departments][][chat_queue][max_queue_size]	integer	*
data[][categories][][category][brand][theme_sets][]	array of objects (ThemeSet)	*
data[][categories][][category][is_agent]	boolean	*	If this is true, then all categories and articles under this one are considered agent KB articles and wont be displayed in the user interface.
data[][categories][][category][is_book]	boolean	*	If this is true, then all the articles and categories under this category is treated as a book (aka manual).
data[][categories][][category][template_suffix]	string	*	The template suffix to use when rendering the category, and articles within the category. Eg UserBundle:Articles:article.html.twig With suffix 'download' becomes UserBundle:Articles:article-download.html.twig
data[][categories][][display_order]	integer	*
data[][revisions][]	array of objects (ArticleRevision)	*	Revisions of this article.
data[][revisions][][id]	integer	*	The unique ID.
data[][revisions][][person]	integer id (Person)	*	Person who made the revision.
data[][revisions][][date_created]	DateTime	*	DateTime the revision was created.
data[][date_end]	DateTime	*
data[][date_next_review]	DateTime	*
data[][review_interval]	string	*
data[][end_action]	string	*
data[][custom_data][]	array of objects (CustomDataArticle)	*
data[][custom_data][][article]	object (Article)	*
data[][custom_data][][article][categories][]	array of objects (ArticleToCategory)	*
data[][custom_data][][article][revisions][]	array of objects (ArticleRevision)	*	Revisions of this article.
data[][custom_data][][article][date_end]	DateTime	*
data[][custom_data][][article][date_next_review]	DateTime	*
data[][custom_data][][article][review_interval]	string	*
data[][custom_data][][article][end_action]	string	*
data[][custom_data][][article][custom_data][]	array of objects (CustomDataArticle)	*
data[][custom_data][][article][labels][]	array of objects (LabelArticle)	*	String array of labels associated with this article.
data[][custom_data][][article][labels][][article]	object (Article)	*
data[][custom_data][][article][content_format]	string	*
data[][custom_data][][article][content_data]	array	*
data[][custom_data][][field]	object (CustomDefArticle)	*
data[][custom_data][][field][parent]	object (CustomDefArticle)	*
data[][custom_data][][field][children][]	array of objects (CustomDefArticle)	*	Field children.
data[][custom_data][][root_field]	object (CustomDefArticle)	*
data[][content_format]	string	*
data[][content_data]	array	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/articles CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.articles.post

Parameters
Response
Status Codes

Parameter	Type	Required?	Format
title	string	true
content	string	true
person[id]	string	false
person[name]	string	false
person[email]	string	false
person[fieldId]	string	false
person[key]	string	false
language	choice	false
content_input_type	choice	false	["markdown","rte","dped_v1","html"]
status	choice	true	["archived","published","hidden.deleted","hidden.draft","hidden.pending","hidden.spam","hidden.unpublished"]
title_translations[][language]	choice	true
title_translations[][value]	string	true
content_translations[][language]	choice	true
content_translations[][value]	string	true
categories[]	array of choices	false
date_created	datetime	false	yyyy-MM-dd'T'HH:mm:ss
fields[1][mode]	string	false
fields[1][criteria]	string	false
fields[1][data]	string	true
fields[2][mode]	string	false
fields[2][criteria]	string	false
fields[2][data]	string	true
fields[3][mode]	string	false
fields[3][criteria]	string	false
fields[3][data]	choice	true
fields[7][mode]	string	false
fields[7][criteria]	string	false
fields[7][data]	date	true	yyyy-MM-dd
fields[8][mode]	string	false
fields[8][criteria]	string	false
fields[8][data]	datetime	true	yyyy-MM-dd'T'HH:mm:ss

Parameter	Type	Versions	Description
data.attachments		*
data.labels[]	array of objects (LabelArticle)	*	String array of labels associated with this article.
data.labels[][article]	object (Article)	*
data.labels[][article][categories][]	array of objects (ArticleToCategory)	*
data.labels[][article][categories][][article]	object (Article)	*
data.labels[][article][categories][][category]	object (ArticleCategory)	*
data.labels[][article][categories][][category][parent]	object (ArticleCategory)	*
data.labels[][article][categories][][category][children][]	array of objects (ArticleCategory)	*
data.labels[][article][categories][][category][articles][]	array of objects (ArticleToCategory)	*	Articles belongs this category.
data.labels[][article][categories][][category][usergroups][]	array of objects (Usergroup)	*	Usergroups that has access to this category.
data.labels[][article][categories][][category][usergroups][][id]	integer	*	The unique ID, DB-generated.
data.labels[][article][categories][][category][usergroups][][title]	string	*	Title of the usergroup.
data.labels[][article][categories][][category][usergroups][][note]	string	*	A note or description about the usergroup.
data.labels[][article][categories][][category][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.labels[][article][categories][][category][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.labels[][article][categories][][category][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.labels[][article][categories][][category][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.labels[][article][categories][][category][usergroups][][permissions][][id]	integer	*	The unique ID.
data.labels[][article][categories][][category][usergroups][][permissions][][name]	string	*	The name of the permission.
data.labels[][article][categories][][category][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.labels[][article][categories][][category][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.labels[][article][categories][][category][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.labels[][article][categories][][category][usergroups][][department_permissions][][department]	integer id (Department)	*
data.labels[][article][categories][][category][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.labels[][article][categories][][category][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.labels[][article][categories][][category][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.labels[][article][categories][][category][usergroups][][department_permissions][][is_active]	boolean	*
data.labels[][article][categories][][category][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.labels[][article][categories][][category][brand]	object (Brand)	*	Brand linked to the category.
data.labels[][article][categories][][category][brand][id]	integer	*	The unique ID.
data.labels[][article][categories][][category][brand][name]	string	*	The brand name.
data.labels[][article][categories][][category][brand][slug]	string	*
data.labels[][article][categories][][category][brand][url]	string	*	The brand url.
data.labels[][article][categories][][category][brand][theme_set]	object (ThemeSet)	*
data.labels[][article][categories][][category][brand][theme_set][id]	integer	*
data.labels[][article][categories][][category][brand][theme_set][theme_id]	string	*
data.labels[][article][categories][][category][brand][theme_set][title]	string	*
data.labels[][article][categories][][category][brand][edit_theme_set]	object (ThemeSet)	*
data.labels[][article][categories][][category][brand][departments][]	array of objects (Department)	*
data.labels[][article][categories][][category][brand][departments][][id]	integer	*
data.labels[][article][categories][][category][brand][departments][][parent]	object (Department)	*
data.labels[][article][categories][][category][brand][departments][][children][]	array of objects (Department)	*
data.labels[][article][categories][][category][brand][departments][][title]	string	*
data.labels[][article][categories][][category][brand][departments][][user_title]	string	*
data.labels[][article][categories][][category][brand][departments][][is_tickets_enabled]	boolean	*
data.labels[][article][categories][][category][brand][departments][][is_chat_enabled]	boolean	*
data.labels[][article][categories][][category][brand][departments][][display_order]	integer	*
data.labels[][article][categories][][category][brand][departments][][avatar]	object (Blob)	*
data.labels[][article][categories][][category][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.labels[][article][categories][][category][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][article][categories][][category][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][article][categories][][category][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][article][categories][][category][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][article][categories][][category][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][article][categories][][category][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.labels[][article][categories][][category][brand][departments][][avatar][authcode]	string	*
data.labels[][article][categories][][category][brand][departments][][avatar][blob_hash]	string	*
data.labels[][article][categories][][category][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][article][categories][][category][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][article][categories][][category][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][article][categories][][category][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][article][categories][][category][brand][departments][][avatar][date_created]	DateTime	*
data.labels[][article][categories][][category][brand][departments][][avatar][is_temp]	boolean	*
data.labels[][article][categories][][category][brand][departments][][avatar][source_ref]	string	*
data.labels[][article][categories][][category][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.labels[][article][categories][][category][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.labels[][article][categories][][category][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.labels[][article][categories][][category][brand][departments][][brands][]	array of objects (Brand)	*
data.labels[][article][categories][][category][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.labels[][article][categories][][category][brand][departments][][permissions][][department]	integer id (Department)	*
data.labels[][article][categories][][category][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.labels[][article][categories][][category][brand][departments][][permissions][][name]	string	*	The name of the permission.
data.labels[][article][categories][][category][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.labels[][article][categories][][category][brand][departments][][permissions][][is_active]	boolean	*
data.labels[][article][categories][][category][brand][departments][][chat_queue]	object (UserChatQueue)	*
data.labels[][article][categories][][category][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.labels[][article][categories][][category][brand][departments][][chat_queue][name]	string	*
data.labels[][article][categories][][category][brand][departments][][chat_queue][routing_model]	string	*
data.labels[][article][categories][][category][brand][departments][][chat_queue][answer_timeout]	integer	*
data.labels[][article][categories][][category][brand][departments][][chat_queue][is_all_agents]	boolean	*
data.labels[][article][categories][][category][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.labels[][article][categories][][category][brand][departments][][chat_queue][max_queue_size]	integer	*
data.labels[][article][categories][][category][brand][theme_sets][]	array of objects (ThemeSet)	*
data.labels[][article][categories][][category][is_agent]	boolean	*	If this is true, then all categories and articles under this one are considered agent KB articles and wont be displayed in the user interface.
data.labels[][article][categories][][category][is_book]	boolean	*	If this is true, then all the articles and categories under this category is treated as a book (aka manual).
data.labels[][article][categories][][category][template_suffix]	string	*	The template suffix to use when rendering the category, and articles within the category. Eg UserBundle:Articles:article.html.twig With suffix 'download' becomes UserBundle:Articles:article-download.html.twig
data.labels[][article][categories][][display_order]	integer	*
data.labels[][article][revisions][]	array of objects (ArticleRevision)	*	Revisions of this article.
data.labels[][article][revisions][][id]	integer	*	The unique ID.
data.labels[][article][revisions][][person]	integer id (Person)	*	Person who made the revision.
data.labels[][article][revisions][][date_created]	DateTime	*	DateTime the revision was created.
data.labels[][article][date_end]	DateTime	*
data.labels[][article][date_next_review]	DateTime	*
data.labels[][article][review_interval]	string	*
data.labels[][article][end_action]	string	*
data.labels[][article][custom_data][]	array of objects (CustomDataArticle)	*
data.labels[][article][custom_data][][article]	object (Article)	*
data.labels[][article][custom_data][][field]	object (CustomDefArticle)	*
data.labels[][article][custom_data][][field][parent]	object (CustomDefArticle)	*
data.labels[][article][custom_data][][field][children][]	array of objects (CustomDefArticle)	*	Field children.
data.labels[][article][custom_data][][root_field]	object (CustomDefArticle)	*
data.labels[][article][labels][]	array of objects (LabelArticle)	*	String array of labels associated with this article.
data.labels[][article][content_format]	string	*
data.labels[][article][content_data]	array	*
data.labels[][article][attachments]		*
data.labels[][article][titleTranslations]		*
data.labels[][article][contentTranslations]		*
data.labels[][article][title]		*
data.labels[][article][content]		*
data.labels[][article][comments]		*
data.labels[][article][status]		*
data.labels[][label]		*
data.titleTranslations		*
data.contentTranslations		*
data.title		*
data.content		*
data.comments		*
data.status		*
data.categories[]	array of objects (ArticleToCategory)	*
data.categories[][article]	object (Article)	*
data.categories[][article][categories][]	array of objects (ArticleToCategory)	*
data.categories[][article][revisions][]	array of objects (ArticleRevision)	*	Revisions of this article.
data.categories[][article][revisions][][id]	integer	*	The unique ID.
data.categories[][article][revisions][][person]	integer id (Person)	*	Person who made the revision.
data.categories[][article][revisions][][date_created]	DateTime	*	DateTime the revision was created.
data.categories[][article][date_end]	DateTime	*
data.categories[][article][date_next_review]	DateTime	*
data.categories[][article][review_interval]	string	*
data.categories[][article][end_action]	string	*
data.categories[][article][custom_data][]	array of objects (CustomDataArticle)	*
data.categories[][article][custom_data][][article]	object (Article)	*
data.categories[][article][custom_data][][field]	object (CustomDefArticle)	*
data.categories[][article][custom_data][][field][parent]	object (CustomDefArticle)	*
data.categories[][article][custom_data][][field][children][]	array of objects (CustomDefArticle)	*	Field children.
data.categories[][article][custom_data][][field][title]		*
data.categories[][article][custom_data][][root_field]	object (CustomDefArticle)	*
data.categories[][article][labels][]	array of objects (LabelArticle)	*	String array of labels associated with this article.
data.categories[][article][labels][][article]	object (Article)	*
data.categories[][article][content_format]	string	*
data.categories[][article][content_data]	array	*
data.categories[][article][attachments]		*
data.categories[][article][titleTranslations]		*
data.categories[][article][contentTranslations]		*
data.categories[][article][title]		*
data.categories[][article][content]		*
data.categories[][article][comments]		*
data.categories[][article][status]		*
data.categories[][category]	object (ArticleCategory)	*
data.categories[][category][parent]	object (ArticleCategory)	*
data.categories[][category][children][]	array of objects (ArticleCategory)	*
data.categories[][category][articles][]	array of objects (ArticleToCategory)	*	Articles belongs this category.
data.categories[][category][usergroups][]	array of objects (Usergroup)	*	Usergroups that has access to this category.
data.categories[][category][usergroups][][id]	integer	*	The unique ID, DB-generated.
data.categories[][category][usergroups][][title]	string	*	Title of the usergroup.
data.categories[][category][usergroups][][note]	string	*	A note or description about the usergroup.
data.categories[][category][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.categories[][category][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.categories[][category][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.categories[][category][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.categories[][category][usergroups][][permissions][][id]	integer	*	The unique ID.
data.categories[][category][usergroups][][permissions][][name]	string	*	The name of the permission.
data.categories[][category][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.categories[][category][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.categories[][category][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.categories[][category][usergroups][][department_permissions][][department]	integer id (Department)	*
data.categories[][category][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.categories[][category][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.categories[][category][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.categories[][category][usergroups][][department_permissions][][is_active]	boolean	*
data.categories[][category][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.categories[][category][usergroups][][people][][emails]		*
data.categories[][category][usergroups][][people][][labels]		*
data.categories[][category][usergroups][][people][][teams]		*
data.categories[][category][usergroups][][people][][primary_team]		*
data.categories[][category][usergroups][][people][][agentData]		*
data.categories[][category][usergroups][][people][][publicUsergroups]		*
data.categories[][category][usergroups][][people][][publicAgentgroups]		*
data.categories[][category][brand]	object (Brand)	*	Brand linked to the category.
data.categories[][category][brand][id]	integer	*	The unique ID.
data.categories[][category][brand][name]	string	*	The brand name.
data.categories[][category][brand][slug]	string	*
data.categories[][category][brand][url]	string	*	The brand url.
data.categories[][category][brand][theme_set]	object (ThemeSet)	*
data.categories[][category][brand][theme_set][id]	integer	*
data.categories[][category][brand][theme_set][theme_id]	string	*
data.categories[][category][brand][theme_set][title]	string	*
data.categories[][category][brand][theme_set][options]		*
data.categories[][category][brand][edit_theme_set]	object (ThemeSet)	*
data.categories[][category][brand][departments][]	array of objects (Department)	*
data.categories[][category][brand][departments][][id]	integer	*
data.categories[][category][brand][departments][][parent]	object (Department)	*
data.categories[][category][brand][departments][][children][]	array of objects (Department)	*
data.categories[][category][brand][departments][][title]	string	*
data.categories[][category][brand][departments][][user_title]	string	*
data.categories[][category][brand][departments][][is_tickets_enabled]	boolean	*
data.categories[][category][brand][departments][][is_chat_enabled]	boolean	*
data.categories[][category][brand][departments][][display_order]	integer	*
data.categories[][category][brand][departments][][avatar]	object (Blob)	*
data.categories[][category][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.categories[][category][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.categories[][category][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.categories[][category][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.categories[][category][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.categories[][category][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.categories[][category][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.categories[][category][brand][departments][][avatar][authcode]	string	*
data.categories[][category][brand][departments][][avatar][blob_hash]	string	*
data.categories[][category][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.categories[][category][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.categories[][category][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.categories[][category][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.categories[][category][brand][departments][][avatar][date_created]	DateTime	*
data.categories[][category][brand][departments][][avatar][is_temp]	boolean	*
data.categories[][category][brand][departments][][avatar][source_ref]	string	*
data.categories[][category][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.categories[][category][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.categories[][category][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.categories[][category][brand][departments][][brands][]	array of objects (Brand)	*
data.categories[][category][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.categories[][category][brand][departments][][permissions][][department]	integer id (Department)	*
data.categories[][category][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.categories[][category][brand][departments][][permissions][][name]	string	*	The name of the permission.
data.categories[][category][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.categories[][category][brand][departments][][permissions][][is_active]	boolean	*
data.categories[][category][brand][departments][][chat_queue]	object (UserChatQueue)	*
data.categories[][category][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.categories[][category][brand][departments][][chat_queue][name]	string	*
data.categories[][category][brand][departments][][chat_queue][routing_model]	string	*
data.categories[][category][brand][departments][][chat_queue][answer_timeout]	integer	*
data.categories[][category][brand][departments][][chat_queue][is_all_agents]	boolean	*
data.categories[][category][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.categories[][category][brand][departments][][chat_queue][max_queue_size]	integer	*
data.categories[][category][brand][departments][][chat_queue][routingModel]		*
data.categories[][category][brand][theme_sets][]	array of objects (ThemeSet)	*
data.categories[][category][is_agent]	boolean	*	If this is true, then all categories and articles under this one are considered agent KB articles and wont be displayed in the user interface.
data.categories[][category][is_book]	boolean	*	If this is true, then all the articles and categories under this category is treated as a book (aka manual).
data.categories[][category][template_suffix]	string	*	The template suffix to use when rendering the category, and articles within the category. Eg UserBundle:Articles:article.html.twig With suffix 'download' becomes UserBundle:Articles:article-download.html.twig
data.categories[][category][title]		*
data.categories[][display_order]	integer	*
data.revisions[]	array of objects (ArticleRevision)	*	Revisions of this article.
data.revisions[][id]	integer	*	The unique ID.
data.revisions[][person]	integer id (Person)	*	Person who made the revision.
data.revisions[][date_created]	DateTime	*	DateTime the revision was created.
data.date_end	DateTime	*
data.date_next_review	DateTime	*
data.review_interval	string	*
data.end_action	string	*
data.custom_data[]	array of objects (CustomDataArticle)	*
data.custom_data[][article]	object (Article)	*
data.custom_data[][article][categories][]	array of objects (ArticleToCategory)	*
data.custom_data[][article][revisions][]	array of objects (ArticleRevision)	*	Revisions of this article.
data.custom_data[][article][date_end]	DateTime	*
data.custom_data[][article][date_next_review]	DateTime	*
data.custom_data[][article][review_interval]	string	*
data.custom_data[][article][end_action]	string	*
data.custom_data[][article][custom_data][]	array of objects (CustomDataArticle)	*
data.custom_data[][article][labels][]	array of objects (LabelArticle)	*	String array of labels associated with this article.
data.custom_data[][article][labels][][article]	object (Article)	*
data.custom_data[][article][content_format]	string	*
data.custom_data[][article][content_data]	array	*
data.custom_data[][article][attachments]		*
data.custom_data[][article][titleTranslations]		*
data.custom_data[][article][contentTranslations]		*
data.custom_data[][article][title]		*
data.custom_data[][article][content]		*
data.custom_data[][article][comments]		*
data.custom_data[][article][status]		*
data.custom_data[][field]	object (CustomDefArticle)	*
data.custom_data[][field][parent]	object (CustomDefArticle)	*
data.custom_data[][field][children][]	array of objects (CustomDefArticle)	*	Field children.
data.custom_data[][field][title]		*
data.custom_data[][root_field]	object (CustomDefArticle)	*
data.content_format	string	*
data.content_data	array	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/articles/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

content.articles.count

Filters
Response
Status Codes

Name

Information

author

Datatype	string
Pattern	\d+\|me
Description	filter by author, provide an id or 'me' for current user

category

Datatype	integer
Pattern	\d+\|[\d+]
Description	filter category, could be an array or just digit

group_by

Datatype	string
Pattern	author\|category\|period_created\|period_updated
Description	how to group counters

status

Datatype	string
Pattern	published\|archived\|hidden
Description	filter by status

hidden_status

Datatype	integer
Pattern	unpublished\|deleted\|spam\|draft
Description	select for article with given id

period_created

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by period when content was created

period_last_comment

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by period when content was last commented

period_published

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by py period when content was published

period_updated

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by py period when content was updated

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

GET /api/v2/articles/{article}/pdf CRUD

Article download as pdf

Applicable api modes

signed

Api tags for this endpoint

content.articles.view

Requirements
Status Codes

Name	Requirement	Type	Description
article	\d+	integer	the id of article

Status Code	Description
200	Returns the requested resource
400	We will return this in case your request was malformed

DELETE /api/v2/articles/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.articles.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/articles/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.articles.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.attachments		*
data.labels[]	array of objects (LabelArticle)	*	String array of labels associated with this article.
data.labels[][article]	object (Article)	*
data.labels[][article][categories][]	array of objects (ArticleToCategory)	*
data.labels[][article][categories][][article]	object (Article)	*
data.labels[][article][categories][][category]	object (ArticleCategory)	*
data.labels[][article][categories][][category][parent]	object (ArticleCategory)	*
data.labels[][article][categories][][category][children][]	array of objects (ArticleCategory)	*
data.labels[][article][categories][][category][articles][]	array of objects (ArticleToCategory)	*	Articles belongs this category.
data.labels[][article][categories][][category][usergroups][]	array of objects (Usergroup)	*	Usergroups that has access to this category.
data.labels[][article][categories][][category][usergroups][][id]	integer	*	The unique ID, DB-generated.
data.labels[][article][categories][][category][usergroups][][title]	string	*	Title of the usergroup.
data.labels[][article][categories][][category][usergroups][][note]	string	*	A note or description about the usergroup.
data.labels[][article][categories][][category][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.labels[][article][categories][][category][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.labels[][article][categories][][category][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.labels[][article][categories][][category][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.labels[][article][categories][][category][usergroups][][permissions][][id]	integer	*	The unique ID.
data.labels[][article][categories][][category][usergroups][][permissions][][name]	string	*	The name of the permission.
data.labels[][article][categories][][category][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.labels[][article][categories][][category][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.labels[][article][categories][][category][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.labels[][article][categories][][category][usergroups][][department_permissions][][department]	integer id (Department)	*
data.labels[][article][categories][][category][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.labels[][article][categories][][category][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.labels[][article][categories][][category][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.labels[][article][categories][][category][usergroups][][department_permissions][][is_active]	boolean	*
data.labels[][article][categories][][category][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.labels[][article][categories][][category][brand]	object (Brand)	*	Brand linked to the category.
data.labels[][article][categories][][category][brand][id]	integer	*	The unique ID.
data.labels[][article][categories][][category][brand][name]	string	*	The brand name.
data.labels[][article][categories][][category][brand][slug]	string	*
data.labels[][article][categories][][category][brand][url]	string	*	The brand url.
data.labels[][article][categories][][category][brand][theme_set]	object (ThemeSet)	*
data.labels[][article][categories][][category][brand][theme_set][id]	integer	*
data.labels[][article][categories][][category][brand][theme_set][theme_id]	string	*
data.labels[][article][categories][][category][brand][theme_set][title]	string	*
data.labels[][article][categories][][category][brand][edit_theme_set]	object (ThemeSet)	*
data.labels[][article][categories][][category][brand][departments][]	array of objects (Department)	*
data.labels[][article][categories][][category][brand][departments][][id]	integer	*
data.labels[][article][categories][][category][brand][departments][][parent]	object (Department)	*
data.labels[][article][categories][][category][brand][departments][][children][]	array of objects (Department)	*
data.labels[][article][categories][][category][brand][departments][][title]	string	*
data.labels[][article][categories][][category][brand][departments][][user_title]	string	*
data.labels[][article][categories][][category][brand][departments][][is_tickets_enabled]	boolean	*
data.labels[][article][categories][][category][brand][departments][][is_chat_enabled]	boolean	*
data.labels[][article][categories][][category][brand][departments][][display_order]	integer	*
data.labels[][article][categories][][category][brand][departments][][avatar]	object (Blob)	*
data.labels[][article][categories][][category][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.labels[][article][categories][][category][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][article][categories][][category][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][article][categories][][category][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][article][categories][][category][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][article][categories][][category][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][article][categories][][category][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.labels[][article][categories][][category][brand][departments][][avatar][authcode]	string	*
data.labels[][article][categories][][category][brand][departments][][avatar][blob_hash]	string	*
data.labels[][article][categories][][category][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][article][categories][][category][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][article][categories][][category][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][article][categories][][category][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][article][categories][][category][brand][departments][][avatar][date_created]	DateTime	*
data.labels[][article][categories][][category][brand][departments][][avatar][is_temp]	boolean	*
data.labels[][article][categories][][category][brand][departments][][avatar][source_ref]	string	*
data.labels[][article][categories][][category][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.labels[][article][categories][][category][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.labels[][article][categories][][category][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.labels[][article][categories][][category][brand][departments][][brands][]	array of objects (Brand)	*
data.labels[][article][categories][][category][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.labels[][article][categories][][category][brand][departments][][permissions][][department]	integer id (Department)	*
data.labels[][article][categories][][category][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.labels[][article][categories][][category][brand][departments][][permissions][][name]	string	*	The name of the permission.
data.labels[][article][categories][][category][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.labels[][article][categories][][category][brand][departments][][permissions][][is_active]	boolean	*
data.labels[][article][categories][][category][brand][departments][][chat_queue]	object (UserChatQueue)	*
data.labels[][article][categories][][category][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.labels[][article][categories][][category][brand][departments][][chat_queue][name]	string	*
data.labels[][article][categories][][category][brand][departments][][chat_queue][routing_model]	string	*
data.labels[][article][categories][][category][brand][departments][][chat_queue][answer_timeout]	integer	*
data.labels[][article][categories][][category][brand][departments][][chat_queue][is_all_agents]	boolean	*
data.labels[][article][categories][][category][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.labels[][article][categories][][category][brand][departments][][chat_queue][max_queue_size]	integer	*
data.labels[][article][categories][][category][brand][theme_sets][]	array of objects (ThemeSet)	*
data.labels[][article][categories][][category][is_agent]	boolean	*	If this is true, then all categories and articles under this one are considered agent KB articles and wont be displayed in the user interface.
data.labels[][article][categories][][category][is_book]	boolean	*	If this is true, then all the articles and categories under this category is treated as a book (aka manual).
data.labels[][article][categories][][category][template_suffix]	string	*	The template suffix to use when rendering the category, and articles within the category. Eg UserBundle:Articles:article.html.twig With suffix 'download' becomes UserBundle:Articles:article-download.html.twig
data.labels[][article][categories][][display_order]	integer	*
data.labels[][article][revisions][]	array of objects (ArticleRevision)	*	Revisions of this article.
data.labels[][article][revisions][][id]	integer	*	The unique ID.
data.labels[][article][revisions][][person]	integer id (Person)	*	Person who made the revision.
data.labels[][article][revisions][][date_created]	DateTime	*	DateTime the revision was created.
data.labels[][article][date_end]	DateTime	*
data.labels[][article][date_next_review]	DateTime	*
data.labels[][article][review_interval]	string	*
data.labels[][article][end_action]	string	*
data.labels[][article][custom_data][]	array of objects (CustomDataArticle)	*
data.labels[][article][custom_data][][article]	object (Article)	*
data.labels[][article][custom_data][][field]	object (CustomDefArticle)	*
data.labels[][article][custom_data][][field][parent]	object (CustomDefArticle)	*
data.labels[][article][custom_data][][field][children][]	array of objects (CustomDefArticle)	*	Field children.
data.labels[][article][custom_data][][root_field]	object (CustomDefArticle)	*
data.labels[][article][labels][]	array of objects (LabelArticle)	*	String array of labels associated with this article.
data.labels[][article][content_format]	string	*
data.labels[][article][content_data]	array	*
data.labels[][article][attachments]		*
data.labels[][article][titleTranslations]		*
data.labels[][article][contentTranslations]		*
data.labels[][article][title]		*
data.labels[][article][content]		*
data.labels[][article][comments]		*
data.labels[][article][status]		*
data.labels[][label]		*
data.titleTranslations		*
data.contentTranslations		*
data.title		*
data.content		*
data.comments		*
data.status		*
data.categories[]	array of objects (ArticleToCategory)	*
data.categories[][article]	object (Article)	*
data.categories[][article][categories][]	array of objects (ArticleToCategory)	*
data.categories[][article][revisions][]	array of objects (ArticleRevision)	*	Revisions of this article.
data.categories[][article][revisions][][id]	integer	*	The unique ID.
data.categories[][article][revisions][][person]	integer id (Person)	*	Person who made the revision.
data.categories[][article][revisions][][date_created]	DateTime	*	DateTime the revision was created.
data.categories[][article][date_end]	DateTime	*
data.categories[][article][date_next_review]	DateTime	*
data.categories[][article][review_interval]	string	*
data.categories[][article][end_action]	string	*
data.categories[][article][custom_data][]	array of objects (CustomDataArticle)	*
data.categories[][article][custom_data][][article]	object (Article)	*
data.categories[][article][custom_data][][field]	object (CustomDefArticle)	*
data.categories[][article][custom_data][][field][parent]	object (CustomDefArticle)	*
data.categories[][article][custom_data][][field][children][]	array of objects (CustomDefArticle)	*	Field children.
data.categories[][article][custom_data][][field][title]		*
data.categories[][article][custom_data][][root_field]	object (CustomDefArticle)	*
data.categories[][article][labels][]	array of objects (LabelArticle)	*	String array of labels associated with this article.
data.categories[][article][labels][][article]	object (Article)	*
data.categories[][article][content_format]	string	*
data.categories[][article][content_data]	array	*
data.categories[][article][attachments]		*
data.categories[][article][titleTranslations]		*
data.categories[][article][contentTranslations]		*
data.categories[][article][title]		*
data.categories[][article][content]		*
data.categories[][article][comments]		*
data.categories[][article][status]		*
data.categories[][category]	object (ArticleCategory)	*
data.categories[][category][parent]	object (ArticleCategory)	*
data.categories[][category][children][]	array of objects (ArticleCategory)	*
data.categories[][category][articles][]	array of objects (ArticleToCategory)	*	Articles belongs this category.
data.categories[][category][usergroups][]	array of objects (Usergroup)	*	Usergroups that has access to this category.
data.categories[][category][usergroups][][id]	integer	*	The unique ID, DB-generated.
data.categories[][category][usergroups][][title]	string	*	Title of the usergroup.
data.categories[][category][usergroups][][note]	string	*	A note or description about the usergroup.
data.categories[][category][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.categories[][category][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.categories[][category][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.categories[][category][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.categories[][category][usergroups][][permissions][][id]	integer	*	The unique ID.
data.categories[][category][usergroups][][permissions][][name]	string	*	The name of the permission.
data.categories[][category][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.categories[][category][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.categories[][category][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.categories[][category][usergroups][][department_permissions][][department]	integer id (Department)	*
data.categories[][category][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.categories[][category][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.categories[][category][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.categories[][category][usergroups][][department_permissions][][is_active]	boolean	*
data.categories[][category][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.categories[][category][usergroups][][people][][emails]		*
data.categories[][category][usergroups][][people][][labels]		*
data.categories[][category][usergroups][][people][][teams]		*
data.categories[][category][usergroups][][people][][primary_team]		*
data.categories[][category][usergroups][][people][][agentData]		*
data.categories[][category][usergroups][][people][][publicUsergroups]		*
data.categories[][category][usergroups][][people][][publicAgentgroups]		*
data.categories[][category][brand]	object (Brand)	*	Brand linked to the category.
data.categories[][category][brand][id]	integer	*	The unique ID.
data.categories[][category][brand][name]	string	*	The brand name.
data.categories[][category][brand][slug]	string	*
data.categories[][category][brand][url]	string	*	The brand url.
data.categories[][category][brand][theme_set]	object (ThemeSet)	*
data.categories[][category][brand][theme_set][id]	integer	*
data.categories[][category][brand][theme_set][theme_id]	string	*
data.categories[][category][brand][theme_set][title]	string	*
data.categories[][category][brand][theme_set][options]		*
data.categories[][category][brand][edit_theme_set]	object (ThemeSet)	*
data.categories[][category][brand][departments][]	array of objects (Department)	*
data.categories[][category][brand][departments][][id]	integer	*
data.categories[][category][brand][departments][][parent]	object (Department)	*
data.categories[][category][brand][departments][][children][]	array of objects (Department)	*
data.categories[][category][brand][departments][][title]	string	*
data.categories[][category][brand][departments][][user_title]	string	*
data.categories[][category][brand][departments][][is_tickets_enabled]	boolean	*
data.categories[][category][brand][departments][][is_chat_enabled]	boolean	*
data.categories[][category][brand][departments][][display_order]	integer	*
data.categories[][category][brand][departments][][avatar]	object (Blob)	*
data.categories[][category][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.categories[][category][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.categories[][category][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.categories[][category][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.categories[][category][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.categories[][category][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.categories[][category][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.categories[][category][brand][departments][][avatar][authcode]	string	*
data.categories[][category][brand][departments][][avatar][blob_hash]	string	*
data.categories[][category][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.categories[][category][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.categories[][category][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.categories[][category][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.categories[][category][brand][departments][][avatar][date_created]	DateTime	*
data.categories[][category][brand][departments][][avatar][is_temp]	boolean	*
data.categories[][category][brand][departments][][avatar][source_ref]	string	*
data.categories[][category][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.categories[][category][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.categories[][category][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.categories[][category][brand][departments][][brands][]	array of objects (Brand)	*
data.categories[][category][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.categories[][category][brand][departments][][permissions][][department]	integer id (Department)	*
data.categories[][category][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.categories[][category][brand][departments][][permissions][][name]	string	*	The name of the permission.
data.categories[][category][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.categories[][category][brand][departments][][permissions][][is_active]	boolean	*
data.categories[][category][brand][departments][][chat_queue]	object (UserChatQueue)	*
data.categories[][category][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.categories[][category][brand][departments][][chat_queue][name]	string	*
data.categories[][category][brand][departments][][chat_queue][routing_model]	string	*
data.categories[][category][brand][departments][][chat_queue][answer_timeout]	integer	*
data.categories[][category][brand][departments][][chat_queue][is_all_agents]	boolean	*
data.categories[][category][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.categories[][category][brand][departments][][chat_queue][max_queue_size]	integer	*
data.categories[][category][brand][departments][][chat_queue][routingModel]		*
data.categories[][category][brand][theme_sets][]	array of objects (ThemeSet)	*
data.categories[][category][is_agent]	boolean	*	If this is true, then all categories and articles under this one are considered agent KB articles and wont be displayed in the user interface.
data.categories[][category][is_book]	boolean	*	If this is true, then all the articles and categories under this category is treated as a book (aka manual).
data.categories[][category][template_suffix]	string	*	The template suffix to use when rendering the category, and articles within the category. Eg UserBundle:Articles:article.html.twig With suffix 'download' becomes UserBundle:Articles:article-download.html.twig
data.categories[][category][title]		*
data.categories[][display_order]	integer	*
data.revisions[]	array of objects (ArticleRevision)	*	Revisions of this article.
data.revisions[][id]	integer	*	The unique ID.
data.revisions[][person]	integer id (Person)	*	Person who made the revision.
data.revisions[][date_created]	DateTime	*	DateTime the revision was created.
data.date_end	DateTime	*
data.date_next_review	DateTime	*
data.review_interval	string	*
data.end_action	string	*
data.custom_data[]	array of objects (CustomDataArticle)	*
data.custom_data[][article]	object (Article)	*
data.custom_data[][article][categories][]	array of objects (ArticleToCategory)	*
data.custom_data[][article][revisions][]	array of objects (ArticleRevision)	*	Revisions of this article.
data.custom_data[][article][date_end]	DateTime	*
data.custom_data[][article][date_next_review]	DateTime	*
data.custom_data[][article][review_interval]	string	*
data.custom_data[][article][end_action]	string	*
data.custom_data[][article][custom_data][]	array of objects (CustomDataArticle)	*
data.custom_data[][article][labels][]	array of objects (LabelArticle)	*	String array of labels associated with this article.
data.custom_data[][article][labels][][article]	object (Article)	*
data.custom_data[][article][content_format]	string	*
data.custom_data[][article][content_data]	array	*
data.custom_data[][article][attachments]		*
data.custom_data[][article][titleTranslations]		*
data.custom_data[][article][contentTranslations]		*
data.custom_data[][article][title]		*
data.custom_data[][article][content]		*
data.custom_data[][article][comments]		*
data.custom_data[][article][status]		*
data.custom_data[][field]	object (CustomDefArticle)	*
data.custom_data[][field][parent]	object (CustomDefArticle)	*
data.custom_data[][field][children][]	array of objects (CustomDefArticle)	*	Field children.
data.custom_data[][field][title]		*
data.custom_data[][root_field]	object (CustomDefArticle)	*
data.content_format	string	*
data.content_data	array	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/articles/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.articles.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format
title	string	false
content	string	false
person[id]	string	false
person[name]	string	false
person[email]	string	false
person[fieldId]	string	false
person[key]	string	false
language	choice	false
content_input_type	choice	false	["markdown","rte","dped_v1","html"]
status	choice	false	["archived","published","hidden.deleted","hidden.draft","hidden.pending","hidden.spam","hidden.unpublished"]
title_translations[][language]	choice	false
title_translations[][value]	string	false
content_translations[][language]	choice	false
content_translations[][value]	string	false
categories[]	array of choices	false
date_created	datetime	false	yyyy-MM-dd'T'HH:mm:ss
fields[1][mode]	string	false
fields[1][criteria]	string	false
fields[1][data]	string	false
fields[2][mode]	string	false
fields[2][criteria]	string	false
fields[2][data]	string	false
fields[3][mode]	string	false
fields[3][criteria]	string	false
fields[3][data]	choice	false
fields[7][mode]	string	false
fields[7][criteria]	string	false
fields[7][data]	date	false	yyyy-MM-dd
fields[8][mode]	string	false
fields[8][criteria]	string	false
fields[8][data]	datetime	false	yyyy-MM-dd'T'HH:mm:ss

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/content_categories

Get categories for articles, news and downloads

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.categories.get_categories_grouped_by_content_type

Response
Status Codes

Parameter	Type	Versions	Description
data.articles[]	array of objects (ArticleCategory)	*
data.articles[][parent]	object (ArticleCategory)	*
data.articles[][children][]	array of objects (ArticleCategory)	*
data.articles[][articles][]	array of objects (ArticleToCategory)	*	Articles belongs this category.
data.articles[][articles][][article]	object (Article)	*
data.articles[][articles][][article][categories][]	array of objects (ArticleToCategory)	*
data.articles[][articles][][article][revisions][]	array of objects (ArticleRevision)	*	Revisions of this article.
data.articles[][articles][][article][revisions][][id]	integer	*	The unique ID.
data.articles[][articles][][article][revisions][][person]	integer id (Person)	*	Person who made the revision.
data.articles[][articles][][article][revisions][][date_created]	DateTime	*	DateTime the revision was created.
data.articles[][articles][][article][date_end]	DateTime	*
data.articles[][articles][][article][date_next_review]	DateTime	*
data.articles[][articles][][article][review_interval]	string	*
data.articles[][articles][][article][end_action]	string	*
data.articles[][articles][][article][custom_data][]	array of objects (CustomDataArticle)	*
data.articles[][articles][][article][custom_data][][article]	object (Article)	*
data.articles[][articles][][article][custom_data][][field]	object (CustomDefArticle)	*
data.articles[][articles][][article][custom_data][][field][parent]	object (CustomDefArticle)	*
data.articles[][articles][][article][custom_data][][field][children][]	array of objects (CustomDefArticle)	*	Field children.
data.articles[][articles][][article][custom_data][][field][title]		*
data.articles[][articles][][article][custom_data][][root_field]	object (CustomDefArticle)	*
data.articles[][articles][][article][labels][]	array of objects (LabelArticle)	*	String array of labels associated with this article.
data.articles[][articles][][article][labels][][article]	object (Article)	*
data.articles[][articles][][article][content_format]	string	*
data.articles[][articles][][article][content_data]	array	*
data.articles[][articles][][article][attachments]		*
data.articles[][articles][][article][titleTranslations]		*
data.articles[][articles][][article][contentTranslations]		*
data.articles[][articles][][article][title]		*
data.articles[][articles][][article][content]		*
data.articles[][articles][][article][comments]		*
data.articles[][articles][][article][status]		*
data.articles[][articles][][category]	object (ArticleCategory)	*
data.articles[][articles][][display_order]	integer	*
data.articles[][usergroups][]	array of objects (Usergroup)	*	Usergroups that has access to this category.
data.articles[][usergroups][][id]	integer	*	The unique ID, DB-generated.
data.articles[][usergroups][][title]	string	*	Title of the usergroup.
data.articles[][usergroups][][note]	string	*	A note or description about the usergroup.
data.articles[][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.articles[][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.articles[][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.articles[][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.articles[][usergroups][][permissions][][id]	integer	*	The unique ID.
data.articles[][usergroups][][permissions][][name]	string	*	The name of the permission.
data.articles[][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.articles[][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.articles[][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.articles[][usergroups][][department_permissions][][department]	integer id (Department)	*
data.articles[][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.articles[][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.articles[][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.articles[][usergroups][][department_permissions][][is_active]	boolean	*
data.articles[][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.articles[][usergroups][][people][][emails]		*
data.articles[][usergroups][][people][][labels]		*
data.articles[][usergroups][][people][][teams]		*
data.articles[][usergroups][][people][][primary_team]		*
data.articles[][usergroups][][people][][agentData]		*
data.articles[][usergroups][][people][][publicUsergroups]		*
data.articles[][usergroups][][people][][publicAgentgroups]		*
data.articles[][brand]	object (Brand)	*	Brand linked to the category.
data.articles[][brand][id]	integer	*	The unique ID.
data.articles[][brand][name]	string	*	The brand name.
data.articles[][brand][slug]	string	*
data.articles[][brand][url]	string	*	The brand url.
data.articles[][brand][theme_set]	object (ThemeSet)	*
data.articles[][brand][theme_set][id]	integer	*
data.articles[][brand][theme_set][theme_id]	string	*
data.articles[][brand][theme_set][title]	string	*
data.articles[][brand][theme_set][options]		*
data.articles[][brand][edit_theme_set]	object (ThemeSet)	*
data.articles[][brand][departments][]	array of objects (Department)	*
data.articles[][brand][departments][][id]	integer	*
data.articles[][brand][departments][][parent]	object (Department)	*
data.articles[][brand][departments][][children][]	array of objects (Department)	*
data.articles[][brand][departments][][title]	string	*
data.articles[][brand][departments][][user_title]	string	*
data.articles[][brand][departments][][is_tickets_enabled]	boolean	*
data.articles[][brand][departments][][is_chat_enabled]	boolean	*
data.articles[][brand][departments][][display_order]	integer	*
data.articles[][brand][departments][][avatar]	object (Blob)	*
data.articles[][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.articles[][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.articles[][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.articles[][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.articles[][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.articles[][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.articles[][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.articles[][brand][departments][][avatar][authcode]	string	*
data.articles[][brand][departments][][avatar][blob_hash]	string	*
data.articles[][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.articles[][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.articles[][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.articles[][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.articles[][brand][departments][][avatar][date_created]	DateTime	*
data.articles[][brand][departments][][avatar][is_temp]	boolean	*
data.articles[][brand][departments][][avatar][source_ref]	string	*
data.articles[][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.articles[][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.articles[][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.articles[][brand][departments][][brands][]	array of objects (Brand)	*
data.articles[][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.articles[][brand][departments][][permissions][][department]	integer id (Department)	*
data.articles[][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.articles[][brand][departments][][permissions][][name]	string	*	The name of the permission.
data.articles[][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.articles[][brand][departments][][permissions][][is_active]	boolean	*
data.articles[][brand][departments][][chat_queue]	object (UserChatQueue)	*
data.articles[][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.articles[][brand][departments][][chat_queue][name]	string	*
data.articles[][brand][departments][][chat_queue][routing_model]	string	*
data.articles[][brand][departments][][chat_queue][answer_timeout]	integer	*
data.articles[][brand][departments][][chat_queue][is_all_agents]	boolean	*
data.articles[][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.articles[][brand][departments][][chat_queue][max_queue_size]	integer	*
data.articles[][brand][departments][][chat_queue][routingModel]		*
data.articles[][brand][theme_sets][]	array of objects (ThemeSet)	*
data.articles[][is_agent]	boolean	*	If this is true, then all categories and articles under this one are considered agent KB articles and wont be displayed in the user interface.
data.articles[][is_book]	boolean	*	If this is true, then all the articles and categories under this category is treated as a book (aka manual).
data.articles[][template_suffix]	string	*	The template suffix to use when rendering the category, and articles within the category. Eg UserBundle:Articles:article.html.twig With suffix 'download' becomes UserBundle:Articles:article-download.html.twig
data.articles[][title]		*
data.news[]	array of objects (NewsCategory)	*
data.news[][parent]	object (NewsCategory)	*	Category`s parent.
data.news[][children][]	array of objects (NewsCategory)	*	Category`s children.
data.news[][articles][]	array of objects (News)	*	Articles belongs this category.
data.news[][articles][][category]	object (NewsCategory)	*
data.news[][articles][][revisions][]	array of objects (NewsRevision)	*	Revisions of this news.
data.news[][articles][][revisions][][id]	integer	*	The unique ID.
data.news[][articles][][revisions][][person]	integer id (Person)	*	Person who made the revision.
data.news[][articles][][revisions][][date_created]	DateTime	*	DateTime the revision was created.
data.news[][articles][][attachments][]	array of objects (NewsAttachment)	*
data.news[][articles][][attachments][][id]	integer	*
data.news[][articles][][attachments][][news]	integer id (News)	*
data.news[][articles][][attachments][][person]	integer id (Person)	*	Who created the attachment.
data.news[][articles][][attachments][][blob]	object (Blob)	*
data.news[][articles][][attachments][][blob][sys_name]	string	*	A unique system name for the blob.
data.news[][articles][][attachments][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.news[][articles][][attachments][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.news[][articles][][attachments][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.news[][articles][][attachments][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.news[][articles][][attachments][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.news[][articles][][attachments][][blob][file_url]	string	*	The HTTP link to download the file.
data.news[][articles][][attachments][][blob][authcode]	string	*
data.news[][articles][][attachments][][blob][blob_hash]	string	*
data.news[][articles][][attachments][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.news[][articles][][attachments][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.news[][articles][][attachments][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.news[][articles][][attachments][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.news[][articles][][attachments][][blob][date_created]	DateTime	*
data.news[][articles][][attachments][][blob][is_temp]	boolean	*
data.news[][articles][][attachments][][blob][source_ref]	string	*
data.news[][articles][][attachments][][blob][labels][]	array of objects (LabelBlob)	*
data.news[][articles][][attachments][][blob][labels][][blob]	object (Blob)	*
data.news[][articles][][labels][]	array of objects (LabelNews)	*	String array of labels associated with this news.
data.news[][articles][][labels][][news]	object (News)	*
data.news[][articles][][display_order]	integer	*
data.news[][articles][][date_end]	DateTime	*
data.news[][articles][][end_action]	string	*
data.news[][articles][][content_format]	string	*
data.news[][articles][][content_data]	array	*
data.news[][articles][][title]		*
data.news[][articles][][content]		*
data.news[][articles][][comments]		*
data.news[][articles][][status]		*
data.news[][usergroups][]	array of objects (Usergroup)	*	Usergroups that has access to this category.
data.news[][usergroups][][id]	integer	*	The unique ID, DB-generated.
data.news[][usergroups][][title]	string	*	Title of the usergroup.
data.news[][usergroups][][note]	string	*	A note or description about the usergroup.
data.news[][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.news[][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.news[][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.news[][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.news[][usergroups][][permissions][][id]	integer	*	The unique ID.
data.news[][usergroups][][permissions][][name]	string	*	The name of the permission.
data.news[][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.news[][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.news[][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.news[][usergroups][][department_permissions][][department]	integer id (Department)	*
data.news[][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.news[][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.news[][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.news[][usergroups][][department_permissions][][is_active]	boolean	*
data.news[][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.news[][usergroups][][people][][emails]		*
data.news[][usergroups][][people][][labels]		*
data.news[][usergroups][][people][][teams]		*
data.news[][usergroups][][people][][primary_team]		*
data.news[][usergroups][][people][][agentData]		*
data.news[][usergroups][][people][][publicUsergroups]		*
data.news[][usergroups][][people][][publicAgentgroups]		*
data.news[][brand]	object (Brand)	*	Brand linked to the category.
data.news[][brand][id]	integer	*	The unique ID.
data.news[][brand][name]	string	*	The brand name.
data.news[][brand][slug]	string	*
data.news[][brand][url]	string	*	The brand url.
data.news[][brand][theme_set]	object (ThemeSet)	*
data.news[][brand][theme_set][id]	integer	*
data.news[][brand][theme_set][theme_id]	string	*
data.news[][brand][theme_set][title]	string	*
data.news[][brand][theme_set][options]		*
data.news[][brand][edit_theme_set]	object (ThemeSet)	*
data.news[][brand][departments][]	array of objects (Department)	*
data.news[][brand][departments][][id]	integer	*
data.news[][brand][departments][][parent]	object (Department)	*
data.news[][brand][departments][][children][]	array of objects (Department)	*
data.news[][brand][departments][][title]	string	*
data.news[][brand][departments][][user_title]	string	*
data.news[][brand][departments][][is_tickets_enabled]	boolean	*
data.news[][brand][departments][][is_chat_enabled]	boolean	*
data.news[][brand][departments][][display_order]	integer	*
data.news[][brand][departments][][avatar]	object (Blob)	*
data.news[][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.news[][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.news[][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.news[][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.news[][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.news[][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.news[][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.news[][brand][departments][][avatar][authcode]	string	*
data.news[][brand][departments][][avatar][blob_hash]	string	*
data.news[][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.news[][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.news[][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.news[][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.news[][brand][departments][][avatar][date_created]	DateTime	*
data.news[][brand][departments][][avatar][is_temp]	boolean	*
data.news[][brand][departments][][avatar][source_ref]	string	*
data.news[][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.news[][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.news[][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.news[][brand][departments][][brands][]	array of objects (Brand)	*
data.news[][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.news[][brand][departments][][permissions][][department]	integer id (Department)	*
data.news[][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.news[][brand][departments][][permissions][][name]	string	*	The name of the permission.
data.news[][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.news[][brand][departments][][permissions][][is_active]	boolean	*
data.news[][brand][departments][][chat_queue]	object (UserChatQueue)	*
data.news[][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.news[][brand][departments][][chat_queue][name]	string	*
data.news[][brand][departments][][chat_queue][routing_model]	string	*
data.news[][brand][departments][][chat_queue][answer_timeout]	integer	*
data.news[][brand][departments][][chat_queue][is_all_agents]	boolean	*
data.news[][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.news[][brand][departments][][chat_queue][max_queue_size]	integer	*
data.news[][brand][departments][][chat_queue][routingModel]		*
data.news[][brand][theme_sets][]	array of objects (ThemeSet)	*
data.news[][title]		*
data.downloads[]	array of objects (DownloadCategory)	*
data.downloads[][parent]	object (DownloadCategory)	*	Category`s parent.
data.downloads[][children][]	array of objects (DownloadCategory)	*	Category`s children.
data.downloads[][downloads][]	array of objects (Download)	*	Downloads belong this category.
data.downloads[][downloads][][category]	object (DownloadCategory)	*
data.downloads[][downloads][][revisions][]	array of objects (DownloadRevision)	*	Revisions of this download.
data.downloads[][downloads][][revisions][][id]	integer	*	The unique ID.
data.downloads[][downloads][][revisions][][person]	integer id (Person)	*	Person who made the revision.
data.downloads[][downloads][][revisions][][date_created]	DateTime	*	DateTime the revision was created.
data.downloads[][downloads][][blob]	object (Blob)	*
data.downloads[][downloads][][blob][sys_name]	string	*	A unique system name for the blob.
data.downloads[][downloads][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.downloads[][downloads][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.downloads[][downloads][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.downloads[][downloads][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.downloads[][downloads][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.downloads[][downloads][][blob][file_url]	string	*	The HTTP link to download the file.
data.downloads[][downloads][][blob][authcode]	string	*
data.downloads[][downloads][][blob][blob_hash]	string	*
data.downloads[][downloads][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.downloads[][downloads][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.downloads[][downloads][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.downloads[][downloads][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.downloads[][downloads][][blob][date_created]	DateTime	*
data.downloads[][downloads][][blob][is_temp]	boolean	*
data.downloads[][downloads][][blob][source_ref]	string	*
data.downloads[][downloads][][blob][labels][]	array of objects (LabelBlob)	*
data.downloads[][downloads][][blob][labels][][blob]	object (Blob)	*
data.downloads[][downloads][][fileurl]	string	*
data.downloads[][downloads][][filesize]	integer	*
data.downloads[][downloads][][filename]	string	*
data.downloads[][downloads][][display_order]	integer	*
data.downloads[][downloads][][num_downloads]	integer	*	Total number of downloads.
data.downloads[][downloads][][custom_data][]	array of objects (CustomDataDownload)	*
data.downloads[][downloads][][custom_data][][download]	object (Download)	*
data.downloads[][downloads][][custom_data][][field]	object (CustomDefDownload)	*
data.downloads[][downloads][][custom_data][][field][parent]	object (CustomDefDownload)	*
data.downloads[][downloads][][custom_data][][field][children][]	array of objects (CustomDefDownload)	*	Field children.
data.downloads[][downloads][][custom_data][][field][title]		*
data.downloads[][downloads][][custom_data][][root_field]	object (CustomDefDownload)	*
data.downloads[][downloads][][labels][]	array of objects (LabelDownload)	*	String array of labels associated with this download.
data.downloads[][downloads][][labels][][download]	object (Download)	*
data.downloads[][downloads][][content_format]	string	*
data.downloads[][downloads][][content_data]	array	*
data.downloads[][downloads][][date_end]	DateTime	*
data.downloads[][downloads][][end_action]	string	*
data.downloads[][downloads][][title]		*
data.downloads[][downloads][][content]		*
data.downloads[][downloads][][comments]		*
data.downloads[][downloads][][status]		*
data.downloads[][usergroups][]	array of objects (Usergroup)	*	Usergroups that has access to this category.
data.downloads[][usergroups][][id]	integer	*	The unique ID, DB-generated.
data.downloads[][usergroups][][title]	string	*	Title of the usergroup.
data.downloads[][usergroups][][note]	string	*	A note or description about the usergroup.
data.downloads[][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.downloads[][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.downloads[][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.downloads[][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.downloads[][usergroups][][permissions][][id]	integer	*	The unique ID.
data.downloads[][usergroups][][permissions][][name]	string	*	The name of the permission.
data.downloads[][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.downloads[][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.downloads[][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.downloads[][usergroups][][department_permissions][][department]	integer id (Department)	*
data.downloads[][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.downloads[][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.downloads[][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.downloads[][usergroups][][department_permissions][][is_active]	boolean	*
data.downloads[][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.downloads[][usergroups][][people][][emails]		*
data.downloads[][usergroups][][people][][labels]		*
data.downloads[][usergroups][][people][][teams]		*
data.downloads[][usergroups][][people][][primary_team]		*
data.downloads[][usergroups][][people][][agentData]		*
data.downloads[][usergroups][][people][][publicUsergroups]		*
data.downloads[][usergroups][][people][][publicAgentgroups]		*
data.downloads[][brand]	object (Brand)	*	Brand linked to the category.
data.downloads[][brand][id]	integer	*	The unique ID.
data.downloads[][brand][name]	string	*	The brand name.
data.downloads[][brand][slug]	string	*
data.downloads[][brand][url]	string	*	The brand url.
data.downloads[][brand][theme_set]	object (ThemeSet)	*
data.downloads[][brand][theme_set][id]	integer	*
data.downloads[][brand][theme_set][theme_id]	string	*
data.downloads[][brand][theme_set][title]	string	*
data.downloads[][brand][theme_set][options]		*
data.downloads[][brand][edit_theme_set]	object (ThemeSet)	*
data.downloads[][brand][departments][]	array of objects (Department)	*
data.downloads[][brand][departments][][id]	integer	*
data.downloads[][brand][departments][][parent]	object (Department)	*
data.downloads[][brand][departments][][children][]	array of objects (Department)	*
data.downloads[][brand][departments][][title]	string	*
data.downloads[][brand][departments][][user_title]	string	*
data.downloads[][brand][departments][][is_tickets_enabled]	boolean	*
data.downloads[][brand][departments][][is_chat_enabled]	boolean	*
data.downloads[][brand][departments][][display_order]	integer	*
data.downloads[][brand][departments][][avatar]	object (Blob)	*
data.downloads[][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.downloads[][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.downloads[][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.downloads[][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.downloads[][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.downloads[][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.downloads[][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.downloads[][brand][departments][][avatar][authcode]	string	*
data.downloads[][brand][departments][][avatar][blob_hash]	string	*
data.downloads[][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.downloads[][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.downloads[][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.downloads[][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.downloads[][brand][departments][][avatar][date_created]	DateTime	*
data.downloads[][brand][departments][][avatar][is_temp]	boolean	*
data.downloads[][brand][departments][][avatar][source_ref]	string	*
data.downloads[][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.downloads[][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.downloads[][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.downloads[][brand][departments][][brands][]	array of objects (Brand)	*
data.downloads[][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.downloads[][brand][departments][][permissions][][department]	integer id (Department)	*
data.downloads[][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.downloads[][brand][departments][][permissions][][name]	string	*	The name of the permission.
data.downloads[][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.downloads[][brand][departments][][permissions][][is_active]	boolean	*
data.downloads[][brand][departments][][chat_queue]	object (UserChatQueue)	*
data.downloads[][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.downloads[][brand][departments][][chat_queue][name]	string	*
data.downloads[][brand][departments][][chat_queue][routing_model]	string	*
data.downloads[][brand][departments][][chat_queue][answer_timeout]	integer	*
data.downloads[][brand][departments][][chat_queue][is_all_agents]	boolean	*
data.downloads[][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.downloads[][brand][departments][][chat_queue][max_queue_size]	integer	*
data.downloads[][brand][departments][][chat_queue][routingModel]		*
data.downloads[][brand][theme_sets][]	array of objects (ThemeSet)	*
data.downloads[][title]		*

Status Code	Description
200	Returned if request was successful

GET /api/v2/content_templates CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

content.content_templates.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (Application\DeskPRO\Entity\ContentTemplate)	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/content_templates CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.content_templates.post

Status Codes

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/content_templates/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

content.content_templates.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/content_templates/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.content_templates.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/content_templates/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.content_templates.get

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/content_templates/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.content_templates.put

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/custom_icons

List custom icons of the current theme

Applicable api modes

session token key oauth

Api tags for this endpoint

content.custom_icons.list

Response

Parameter	Type	Versions	Description
data.authcode	string	*
data.labels[]	array of objects (LabelBlob)	*
data.labels[][blob]	object (Blob)	*
data.labels[][blob][sys_name]	string	*	A unique system name for the blob.
data.labels[][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][blob][file_url]	string	*	The HTTP link to download the file.
data.labels[][blob][authcode]	string	*
data.labels[][blob][blob_hash]	string	*
data.labels[][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][blob][date_created]	DateTime	*
data.labels[][blob][is_temp]	boolean	*
data.labels[][blob][source_ref]	string	*
data.labels[][blob][labels][]	array of objects (LabelBlob)	*
data.labels[][label]		*
data.sys_name	string	*	A unique system name for the blob.
data.original_blob	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.original_blob[sys_name]	string	*	A unique system name for the blob.
data.original_blob[original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.original_blob[storage_loc]	string	*	The storage adapter that knows how to load this file.
data.original_blob[storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.original_blob[storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.original_blob[save_path]	string	*	The path to the file if it's not stored in the database.
data.original_blob[file_url]	string	*	The HTTP link to download the file.
data.original_blob[authcode]	string	*
data.original_blob[blob_hash]	string	*
data.original_blob[is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.original_blob[title]	string	*	The title of this file used in interfaces if its a media upload.
data.original_blob[dim_w]	integer	*	If this type of file has dimentions, the width.
data.original_blob[dim_h]	integer	*	If this type of file has dimentions, the height.
data.original_blob[date_created]	DateTime	*
data.original_blob[is_temp]	boolean	*
data.original_blob[source_ref]	string	*
data.original_blob[labels][]	array of objects (LabelBlob)	*
data.original_blob[labels][][blob]	object (Blob)	*
data.storage_loc	string	*	The storage adapter that knows how to load this file.
data.storage_loc_pref	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.storage_loc_specific	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.save_path	string	*	The path to the file if it's not stored in the database.
data.file_url	string	*	The HTTP link to download the file.
data.blob_hash	string	*
data.is_media_upload	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.title	string	*	The title of this file used in interfaces if its a media upload.
data.dim_w	integer	*	If this type of file has dimentions, the width.
data.dim_h	integer	*	If this type of file has dimentions, the height.
data.date_created	DateTime	*
data.is_temp	boolean	*
data.source_ref	string	*

POST /api/v2/custom_icons/upload

Add a new custom icon

Applicable api modes

session token key oauth

Api tags for this endpoint

content.custom_icons.upload

Response

Parameter	Type	Versions	Description
data.authcode	string	*
data.labels[]	array of objects (LabelBlob)	*
data.labels[][blob]	object (Blob)	*
data.labels[][blob][sys_name]	string	*	A unique system name for the blob.
data.labels[][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][blob][file_url]	string	*	The HTTP link to download the file.
data.labels[][blob][authcode]	string	*
data.labels[][blob][blob_hash]	string	*
data.labels[][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][blob][date_created]	DateTime	*
data.labels[][blob][is_temp]	boolean	*
data.labels[][blob][source_ref]	string	*
data.labels[][blob][labels][]	array of objects (LabelBlob)	*
data.labels[][label]		*
data.sys_name	string	*	A unique system name for the blob.
data.original_blob	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.original_blob[sys_name]	string	*	A unique system name for the blob.
data.original_blob[original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.original_blob[storage_loc]	string	*	The storage adapter that knows how to load this file.
data.original_blob[storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.original_blob[storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.original_blob[save_path]	string	*	The path to the file if it's not stored in the database.
data.original_blob[file_url]	string	*	The HTTP link to download the file.
data.original_blob[authcode]	string	*
data.original_blob[blob_hash]	string	*
data.original_blob[is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.original_blob[title]	string	*	The title of this file used in interfaces if its a media upload.
data.original_blob[dim_w]	integer	*	If this type of file has dimentions, the width.
data.original_blob[dim_h]	integer	*	If this type of file has dimentions, the height.
data.original_blob[date_created]	DateTime	*
data.original_blob[is_temp]	boolean	*
data.original_blob[source_ref]	string	*
data.original_blob[labels][]	array of objects (LabelBlob)	*
data.original_blob[labels][][blob]	object (Blob)	*
data.storage_loc	string	*	The storage adapter that knows how to load this file.
data.storage_loc_pref	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.storage_loc_specific	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.save_path	string	*	The path to the file if it's not stored in the database.
data.file_url	string	*	The HTTP link to download the file.
data.blob_hash	string	*
data.is_media_upload	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.title	string	*	The title of this file used in interfaces if its a media upload.
data.dim_w	integer	*	If this type of file has dimentions, the width.
data.dim_h	integer	*	If this type of file has dimentions, the height.
data.date_created	DateTime	*
data.is_temp	boolean	*
data.source_ref	string	*

GET /api/v2/download_categories CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.download_categories.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (DownloadCategory)	*
data[][id]	integer	*	The unique id of the category.
data[][title]	string	*	Category`s title.
data[][title_translations][]	array of objects (Phrase)	*
data[][title_translations][][language]	integer id (Language)	*	The language this phrase belongs to.
data[][title_translations][][value]	string	*
data[][slug]	string	*	Category`s slug.
data[][display_order]	integer	*	Display order.
data[][parent]	integer id (DownloadCategory)	*	Category`s parent.
data[][children][]	array of integer ids (DownloadCategory)	*	Category`s children.
data[][usergroups][]	array of integer ids (Usergroup)	*	Usergroups that has access to this category.
data[][brand]	integer id (Brand)	*	Brand linked to the category.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/download_categories CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.download_categories.post

Parameters
Response
Status Codes

Parameter	Type	Required?
title	string	true
title_translations[][language]	choice	true
title_translations[][value]	string	true
brand	choice	false
usergroups[]	array of choices	false
parent	choice	false

Parameter	Type	Versions	Description
data.id	integer	*	The unique id of the category.
data.title	string	*	Category`s title.
data.title_translations[]	array of objects (Phrase)	*
data.title_translations[][language]	integer id (Language)	*	The language this phrase belongs to.
data.title_translations[][value]	string	*
data.slug	string	*	Category`s slug.
data.display_order	integer	*	Display order.
data.parent	integer id (DownloadCategory)	*	Category`s parent.
data.children[]	array of integer ids (DownloadCategory)	*	Category`s children.
data.usergroups[]	array of integer ids (Usergroup)	*	Usergroups that has access to this category.
data.brand	integer id (Brand)	*	Brand linked to the category.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/download_categories/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.download_categories.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/download_categories/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.download_categories.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/download_categories/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.download_categories.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.id	integer	*	The unique id of the category.
data.title	string	*	Category`s title.
data.title_translations[]	array of objects (Phrase)	*
data.title_translations[][language]	integer id (Language)	*	The language this phrase belongs to.
data.title_translations[][value]	string	*
data.slug	string	*	Category`s slug.
data.display_order	integer	*	Display order.
data.parent	integer id (DownloadCategory)	*	Category`s parent.
data.children[]	array of integer ids (DownloadCategory)	*	Category`s children.
data.usergroups[]	array of integer ids (Usergroup)	*	Usergroups that has access to this category.
data.brand	integer id (Brand)	*	Brand linked to the category.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/download_categories/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.download_categories.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?
title	string	false
title_translations[][language]	choice	false
title_translations[][value]	string	false
brand	choice	false
usergroups[]	array of choices	false
parent	choice	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

POST /api/v2/download_comments CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.comments.downloads_all_comments.post

Response
Status Codes

Parameter	Type	Versions	Description
data.status	string	*	Comment`s status.
data.id	integer	*	The unique ID.
data.person	integer id (Person)	*	The id of person that wrote this comment.
data.ip_address	string	*	IP address with which comment was written.
data.email	string	*	Person`s email.
data.name	string	*	Person`s name.
data.website	string	*	Website where comment was written.
data.content	string	*	Comment`s content itself.
data.is_reviewed	boolean	*	Has this comment been reviewed by an agent?
data.date_created	DateTime	*	When this comment was created.
data.content_type	string	*	Content Type for this comment.
data.rating	integer	*	Total rating for this comment.
data.download	integer id (Download)	*	The download this comment belongs to.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

PUT /api/v2/download_comments/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.comments.downloads_all_comments.put

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/downloads CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

content.downloads.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

author

Datatype	string
Pattern	\d+\|me
Description	filter by author, provide an id or 'me' for current user

category

Datatype	integer
Pattern	\d+\|[\d+]
Description	filter category, could be an array or just digit

group_by

Datatype	string
Pattern	author\|category\|period_created\|period_updated
Description	how to group downloads

status

Datatype	string
Pattern	published\|archived\|hidden
Description	filter by status

hidden_status

Datatype	integer
Pattern	unpublished\|deleted\|spam\|draft
Description	select for article with given id

period_created

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by period when content was created

period_last_comment

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by period when content was last commented

period_published

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by py period when content was published

period_updated

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by py period when content was updated

order_by

Datatype	integer
Pattern	date_created\|date_updated\|person
Description	how to order

Parameter	Type	Versions	Description
data[]	array of objects (Download)	*
data[][labels][]	array of objects (LabelDownload)	*	String array of labels associated with this download.
data[][labels][][download]	object (Download)	*
data[][labels][][download][category]	object (DownloadCategory)	*
data[][labels][][download][revisions][]	array of objects (DownloadRevision)	*	Revisions of this download.
data[][labels][][download][blob]	object (Blob)	*
data[][labels][][download][fileurl]	string	*
data[][labels][][download][filesize]	integer	*
data[][labels][][download][filename]	string	*
data[][labels][][download][display_order]	integer	*
data[][labels][][download][num_downloads]	integer	*	Total number of downloads.
data[][labels][][download][custom_data][]	array of objects (CustomDataDownload)	*
data[][labels][][download][labels][]	array of objects (LabelDownload)	*	String array of labels associated with this download.
data[][labels][][download][content_format]	string	*
data[][labels][][download][content_data]	array	*
data[][labels][][download][date_end]	DateTime	*
data[][labels][][download][end_action]	string	*
data[][title]		*
data[][content]		*
data[][comments]		*
data[][status]		*
data[][category]	object (DownloadCategory)	*
data[][category][parent]	object (DownloadCategory)	*	Category`s parent.
data[][category][children][]	array of objects (DownloadCategory)	*	Category`s children.
data[][category][downloads][]	array of objects (Download)	*	Downloads belong this category.
data[][category][downloads][][category]	object (DownloadCategory)	*
data[][category][downloads][][revisions][]	array of objects (DownloadRevision)	*	Revisions of this download.
data[][category][downloads][][revisions][][id]	integer	*	The unique ID.
data[][category][downloads][][revisions][][person]	integer id (Person)	*	Person who made the revision.
data[][category][downloads][][revisions][][date_created]	DateTime	*	DateTime the revision was created.
data[][category][downloads][][blob]	object (Blob)	*
data[][category][downloads][][blob][sys_name]	string	*	A unique system name for the blob.
data[][category][downloads][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][category][downloads][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][category][downloads][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][category][downloads][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][category][downloads][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][category][downloads][][blob][file_url]	string	*	The HTTP link to download the file.
data[][category][downloads][][blob][authcode]	string	*
data[][category][downloads][][blob][blob_hash]	string	*
data[][category][downloads][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][category][downloads][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][category][downloads][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][category][downloads][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][category][downloads][][blob][date_created]	DateTime	*
data[][category][downloads][][blob][is_temp]	boolean	*
data[][category][downloads][][blob][source_ref]	string	*
data[][category][downloads][][blob][labels][]	array of objects (LabelBlob)	*
data[][category][downloads][][blob][labels][][blob]	object (Blob)	*
data[][category][downloads][][fileurl]	string	*
data[][category][downloads][][filesize]	integer	*
data[][category][downloads][][filename]	string	*
data[][category][downloads][][display_order]	integer	*
data[][category][downloads][][num_downloads]	integer	*	Total number of downloads.
data[][category][downloads][][custom_data][]	array of objects (CustomDataDownload)	*
data[][category][downloads][][custom_data][][download]	object (Download)	*
data[][category][downloads][][custom_data][][field]	object (CustomDefDownload)	*
data[][category][downloads][][custom_data][][field][parent]	object (CustomDefDownload)	*
data[][category][downloads][][custom_data][][field][children][]	array of objects (CustomDefDownload)	*	Field children.
data[][category][downloads][][custom_data][][root_field]	object (CustomDefDownload)	*
data[][category][downloads][][labels][]	array of objects (LabelDownload)	*	String array of labels associated with this download.
data[][category][downloads][][labels][][download]	object (Download)	*
data[][category][downloads][][content_format]	string	*
data[][category][downloads][][content_data]	array	*
data[][category][downloads][][date_end]	DateTime	*
data[][category][downloads][][end_action]	string	*
data[][category][usergroups][]	array of objects (Usergroup)	*	Usergroups that has access to this category.
data[][category][usergroups][][id]	integer	*	The unique ID, DB-generated.
data[][category][usergroups][][title]	string	*	Title of the usergroup.
data[][category][usergroups][][note]	string	*	A note or description about the usergroup.
data[][category][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data[][category][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data[][category][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data[][category][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data[][category][usergroups][][permissions][][id]	integer	*	The unique ID.
data[][category][usergroups][][permissions][][name]	string	*	The name of the permission.
data[][category][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][category][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data[][category][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data[][category][usergroups][][department_permissions][][department]	integer id (Department)	*
data[][category][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][category][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data[][category][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][category][usergroups][][department_permissions][][is_active]	boolean	*
data[][category][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data[][category][brand]	object (Brand)	*	Brand linked to the category.
data[][category][brand][id]	integer	*	The unique ID.
data[][category][brand][name]	string	*	The brand name.
data[][category][brand][slug]	string	*
data[][category][brand][url]	string	*	The brand url.
data[][category][brand][theme_set]	object (ThemeSet)	*
data[][category][brand][theme_set][id]	integer	*
data[][category][brand][theme_set][theme_id]	string	*
data[][category][brand][theme_set][title]	string	*
data[][category][brand][edit_theme_set]	object (ThemeSet)	*
data[][category][brand][departments][]	array of objects (Department)	*
data[][category][brand][departments][][id]	integer	*
data[][category][brand][departments][][parent]	object (Department)	*
data[][category][brand][departments][][children][]	array of objects (Department)	*
data[][category][brand][departments][][title]	string	*
data[][category][brand][departments][][user_title]	string	*
data[][category][brand][departments][][is_tickets_enabled]	boolean	*
data[][category][brand][departments][][is_chat_enabled]	boolean	*
data[][category][brand][departments][][display_order]	integer	*
data[][category][brand][departments][][avatar]	object (Blob)	*
data[][category][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data[][category][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][category][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][category][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][category][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][category][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data[][category][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data[][category][brand][departments][][avatar][authcode]	string	*
data[][category][brand][departments][][avatar][blob_hash]	string	*
data[][category][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][category][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][category][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][category][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][category][brand][departments][][avatar][date_created]	DateTime	*
data[][category][brand][departments][][avatar][is_temp]	boolean	*
data[][category][brand][departments][][avatar][source_ref]	string	*
data[][category][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data[][category][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data[][category][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][category][brand][departments][][brands][]	array of objects (Brand)	*
data[][category][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data[][category][brand][departments][][permissions][][department]	integer id (Department)	*
data[][category][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][category][brand][departments][][permissions][][name]	string	*	The name of the permission.
data[][category][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][category][brand][departments][][permissions][][is_active]	boolean	*
data[][category][brand][departments][][chat_queue]	object (UserChatQueue)	*
data[][category][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data[][category][brand][departments][][chat_queue][name]	string	*
data[][category][brand][departments][][chat_queue][routing_model]	string	*
data[][category][brand][departments][][chat_queue][answer_timeout]	integer	*
data[][category][brand][departments][][chat_queue][is_all_agents]	boolean	*
data[][category][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data[][category][brand][departments][][chat_queue][max_queue_size]	integer	*
data[][category][brand][theme_sets][]	array of objects (ThemeSet)	*
data[][revisions][]	array of objects (DownloadRevision)	*	Revisions of this download.
data[][revisions][][id]	integer	*	The unique ID.
data[][revisions][][person]	integer id (Person)	*	Person who made the revision.
data[][revisions][][date_created]	DateTime	*	DateTime the revision was created.
data[][blob]	object (Blob)	*
data[][blob][sys_name]	string	*	A unique system name for the blob.
data[][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][blob][file_url]	string	*	The HTTP link to download the file.
data[][blob][authcode]	string	*
data[][blob][blob_hash]	string	*
data[][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][blob][date_created]	DateTime	*
data[][blob][is_temp]	boolean	*
data[][blob][source_ref]	string	*
data[][blob][labels][]	array of objects (LabelBlob)	*
data[][blob][labels][][blob]	object (Blob)	*
data[][fileurl]	string	*
data[][filesize]	integer	*
data[][filename]	string	*
data[][display_order]	integer	*
data[][num_downloads]	integer	*	Total number of downloads.
data[][custom_data][]	array of objects (CustomDataDownload)	*
data[][custom_data][][download]	object (Download)	*
data[][custom_data][][download][category]	object (DownloadCategory)	*
data[][custom_data][][download][revisions][]	array of objects (DownloadRevision)	*	Revisions of this download.
data[][custom_data][][download][blob]	object (Blob)	*
data[][custom_data][][download][fileurl]	string	*
data[][custom_data][][download][filesize]	integer	*
data[][custom_data][][download][filename]	string	*
data[][custom_data][][download][display_order]	integer	*
data[][custom_data][][download][num_downloads]	integer	*	Total number of downloads.
data[][custom_data][][download][custom_data][]	array of objects (CustomDataDownload)	*
data[][custom_data][][download][labels][]	array of objects (LabelDownload)	*	String array of labels associated with this download.
data[][custom_data][][download][labels][][download]	object (Download)	*
data[][custom_data][][download][content_format]	string	*
data[][custom_data][][download][content_data]	array	*
data[][custom_data][][download][date_end]	DateTime	*
data[][custom_data][][download][end_action]	string	*
data[][custom_data][][field]	object (CustomDefDownload)	*
data[][custom_data][][field][parent]	object (CustomDefDownload)	*
data[][custom_data][][field][children][]	array of objects (CustomDefDownload)	*	Field children.
data[][custom_data][][root_field]	object (CustomDefDownload)	*
data[][content_format]	string	*
data[][content_data]	array	*
data[][date_end]	DateTime	*
data[][end_action]	string	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/downloads CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.downloads.post

Response
Status Codes

Parameter	Type	Versions	Description
data.labels[]	array of objects (LabelDownload)	*	String array of labels associated with this download.
data.labels[][download]	object (Download)	*
data.labels[][download][category]	object (DownloadCategory)	*
data.labels[][download][category][parent]	object (DownloadCategory)	*	Category`s parent.
data.labels[][download][category][children][]	array of objects (DownloadCategory)	*	Category`s children.
data.labels[][download][category][downloads][]	array of objects (Download)	*	Downloads belong this category.
data.labels[][download][category][usergroups][]	array of objects (Usergroup)	*	Usergroups that has access to this category.
data.labels[][download][category][usergroups][][id]	integer	*	The unique ID, DB-generated.
data.labels[][download][category][usergroups][][title]	string	*	Title of the usergroup.
data.labels[][download][category][usergroups][][note]	string	*	A note or description about the usergroup.
data.labels[][download][category][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.labels[][download][category][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.labels[][download][category][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.labels[][download][category][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.labels[][download][category][usergroups][][permissions][][id]	integer	*	The unique ID.
data.labels[][download][category][usergroups][][permissions][][name]	string	*	The name of the permission.
data.labels[][download][category][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.labels[][download][category][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.labels[][download][category][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.labels[][download][category][usergroups][][department_permissions][][department]	integer id (Department)	*
data.labels[][download][category][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.labels[][download][category][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.labels[][download][category][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.labels[][download][category][usergroups][][department_permissions][][is_active]	boolean	*
data.labels[][download][category][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.labels[][download][category][brand]	object (Brand)	*	Brand linked to the category.
data.labels[][download][category][brand][id]	integer	*	The unique ID.
data.labels[][download][category][brand][name]	string	*	The brand name.
data.labels[][download][category][brand][slug]	string	*
data.labels[][download][category][brand][url]	string	*	The brand url.
data.labels[][download][category][brand][theme_set]	object (ThemeSet)	*
data.labels[][download][category][brand][theme_set][id]	integer	*
data.labels[][download][category][brand][theme_set][theme_id]	string	*
data.labels[][download][category][brand][theme_set][title]	string	*
data.labels[][download][category][brand][edit_theme_set]	object (ThemeSet)	*
data.labels[][download][category][brand][departments][]	array of objects (Department)	*
data.labels[][download][category][brand][departments][][id]	integer	*
data.labels[][download][category][brand][departments][][parent]	object (Department)	*
data.labels[][download][category][brand][departments][][children][]	array of objects (Department)	*
data.labels[][download][category][brand][departments][][title]	string	*
data.labels[][download][category][brand][departments][][user_title]	string	*
data.labels[][download][category][brand][departments][][is_tickets_enabled]	boolean	*
data.labels[][download][category][brand][departments][][is_chat_enabled]	boolean	*
data.labels[][download][category][brand][departments][][display_order]	integer	*
data.labels[][download][category][brand][departments][][avatar]	object (Blob)	*
data.labels[][download][category][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.labels[][download][category][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][download][category][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][download][category][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][download][category][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][download][category][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][download][category][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.labels[][download][category][brand][departments][][avatar][authcode]	string	*
data.labels[][download][category][brand][departments][][avatar][blob_hash]	string	*
data.labels[][download][category][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][download][category][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][download][category][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][download][category][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][download][category][brand][departments][][avatar][date_created]	DateTime	*
data.labels[][download][category][brand][departments][][avatar][is_temp]	boolean	*
data.labels[][download][category][brand][departments][][avatar][source_ref]	string	*
data.labels[][download][category][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.labels[][download][category][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.labels[][download][category][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.labels[][download][category][brand][departments][][brands][]	array of objects (Brand)	*
data.labels[][download][category][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.labels[][download][category][brand][departments][][permissions][][department]	integer id (Department)	*
data.labels[][download][category][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.labels[][download][category][brand][departments][][permissions][][name]	string	*	The name of the permission.
data.labels[][download][category][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.labels[][download][category][brand][departments][][permissions][][is_active]	boolean	*
data.labels[][download][category][brand][departments][][chat_queue]	object (UserChatQueue)	*
data.labels[][download][category][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.labels[][download][category][brand][departments][][chat_queue][name]	string	*
data.labels[][download][category][brand][departments][][chat_queue][routing_model]	string	*
data.labels[][download][category][brand][departments][][chat_queue][answer_timeout]	integer	*
data.labels[][download][category][brand][departments][][chat_queue][is_all_agents]	boolean	*
data.labels[][download][category][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.labels[][download][category][brand][departments][][chat_queue][max_queue_size]	integer	*
data.labels[][download][category][brand][theme_sets][]	array of objects (ThemeSet)	*
data.labels[][download][revisions][]	array of objects (DownloadRevision)	*	Revisions of this download.
data.labels[][download][revisions][][id]	integer	*	The unique ID.
data.labels[][download][revisions][][person]	integer id (Person)	*	Person who made the revision.
data.labels[][download][revisions][][date_created]	DateTime	*	DateTime the revision was created.
data.labels[][download][blob]	object (Blob)	*
data.labels[][download][blob][sys_name]	string	*	A unique system name for the blob.
data.labels[][download][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][download][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][download][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][download][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][download][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][download][blob][file_url]	string	*	The HTTP link to download the file.
data.labels[][download][blob][authcode]	string	*
data.labels[][download][blob][blob_hash]	string	*
data.labels[][download][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][download][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][download][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][download][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][download][blob][date_created]	DateTime	*
data.labels[][download][blob][is_temp]	boolean	*
data.labels[][download][blob][source_ref]	string	*
data.labels[][download][blob][labels][]	array of objects (LabelBlob)	*
data.labels[][download][blob][labels][][blob]	object (Blob)	*
data.labels[][download][fileurl]	string	*
data.labels[][download][filesize]	integer	*
data.labels[][download][filename]	string	*
data.labels[][download][display_order]	integer	*
data.labels[][download][num_downloads]	integer	*	Total number of downloads.
data.labels[][download][custom_data][]	array of objects (CustomDataDownload)	*
data.labels[][download][custom_data][][download]	object (Download)	*
data.labels[][download][custom_data][][field]	object (CustomDefDownload)	*
data.labels[][download][custom_data][][field][parent]	object (CustomDefDownload)	*
data.labels[][download][custom_data][][field][children][]	array of objects (CustomDefDownload)	*	Field children.
data.labels[][download][custom_data][][root_field]	object (CustomDefDownload)	*
data.labels[][download][labels][]	array of objects (LabelDownload)	*	String array of labels associated with this download.
data.labels[][download][content_format]	string	*
data.labels[][download][content_data]	array	*
data.labels[][download][date_end]	DateTime	*
data.labels[][download][end_action]	string	*
data.labels[][download][title]		*
data.labels[][download][content]		*
data.labels[][download][comments]		*
data.labels[][download][status]		*
data.labels[][label]		*
data.title		*
data.content		*
data.comments		*
data.status		*
data.category	object (DownloadCategory)	*
data.category[parent]	object (DownloadCategory)	*	Category`s parent.
data.category[children][]	array of objects (DownloadCategory)	*	Category`s children.
data.category[downloads][]	array of objects (Download)	*	Downloads belong this category.
data.category[downloads][][category]	object (DownloadCategory)	*
data.category[downloads][][revisions][]	array of objects (DownloadRevision)	*	Revisions of this download.
data.category[downloads][][revisions][][id]	integer	*	The unique ID.
data.category[downloads][][revisions][][person]	integer id (Person)	*	Person who made the revision.
data.category[downloads][][revisions][][date_created]	DateTime	*	DateTime the revision was created.
data.category[downloads][][blob]	object (Blob)	*
data.category[downloads][][blob][sys_name]	string	*	A unique system name for the blob.
data.category[downloads][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.category[downloads][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.category[downloads][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.category[downloads][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.category[downloads][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.category[downloads][][blob][file_url]	string	*	The HTTP link to download the file.
data.category[downloads][][blob][authcode]	string	*
data.category[downloads][][blob][blob_hash]	string	*
data.category[downloads][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.category[downloads][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.category[downloads][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.category[downloads][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.category[downloads][][blob][date_created]	DateTime	*
data.category[downloads][][blob][is_temp]	boolean	*
data.category[downloads][][blob][source_ref]	string	*
data.category[downloads][][blob][labels][]	array of objects (LabelBlob)	*
data.category[downloads][][blob][labels][][blob]	object (Blob)	*
data.category[downloads][][fileurl]	string	*
data.category[downloads][][filesize]	integer	*
data.category[downloads][][filename]	string	*
data.category[downloads][][display_order]	integer	*
data.category[downloads][][num_downloads]	integer	*	Total number of downloads.
data.category[downloads][][custom_data][]	array of objects (CustomDataDownload)	*
data.category[downloads][][custom_data][][download]	object (Download)	*
data.category[downloads][][custom_data][][field]	object (CustomDefDownload)	*
data.category[downloads][][custom_data][][field][parent]	object (CustomDefDownload)	*
data.category[downloads][][custom_data][][field][children][]	array of objects (CustomDefDownload)	*	Field children.
data.category[downloads][][custom_data][][field][title]		*
data.category[downloads][][custom_data][][root_field]	object (CustomDefDownload)	*
data.category[downloads][][labels][]	array of objects (LabelDownload)	*	String array of labels associated with this download.
data.category[downloads][][labels][][download]	object (Download)	*
data.category[downloads][][content_format]	string	*
data.category[downloads][][content_data]	array	*
data.category[downloads][][date_end]	DateTime	*
data.category[downloads][][end_action]	string	*
data.category[downloads][][title]		*
data.category[downloads][][content]		*
data.category[downloads][][comments]		*
data.category[downloads][][status]		*
data.category[usergroups][]	array of objects (Usergroup)	*	Usergroups that has access to this category.
data.category[usergroups][][id]	integer	*	The unique ID, DB-generated.
data.category[usergroups][][title]	string	*	Title of the usergroup.
data.category[usergroups][][note]	string	*	A note or description about the usergroup.
data.category[usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.category[usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.category[usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.category[usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.category[usergroups][][permissions][][id]	integer	*	The unique ID.
data.category[usergroups][][permissions][][name]	string	*	The name of the permission.
data.category[usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.category[usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.category[usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.category[usergroups][][department_permissions][][department]	integer id (Department)	*
data.category[usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.category[usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.category[usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.category[usergroups][][department_permissions][][is_active]	boolean	*
data.category[usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.category[usergroups][][people][][emails]		*
data.category[usergroups][][people][][labels]		*
data.category[usergroups][][people][][teams]		*
data.category[usergroups][][people][][primary_team]		*
data.category[usergroups][][people][][agentData]		*
data.category[usergroups][][people][][publicUsergroups]		*
data.category[usergroups][][people][][publicAgentgroups]		*
data.category[brand]	object (Brand)	*	Brand linked to the category.
data.category[brand][id]	integer	*	The unique ID.
data.category[brand][name]	string	*	The brand name.
data.category[brand][slug]	string	*
data.category[brand][url]	string	*	The brand url.
data.category[brand][theme_set]	object (ThemeSet)	*
data.category[brand][theme_set][id]	integer	*
data.category[brand][theme_set][theme_id]	string	*
data.category[brand][theme_set][title]	string	*
data.category[brand][theme_set][options]		*
data.category[brand][edit_theme_set]	object (ThemeSet)	*
data.category[brand][departments][]	array of objects (Department)	*
data.category[brand][departments][][id]	integer	*
data.category[brand][departments][][parent]	object (Department)	*
data.category[brand][departments][][children][]	array of objects (Department)	*
data.category[brand][departments][][title]	string	*
data.category[brand][departments][][user_title]	string	*
data.category[brand][departments][][is_tickets_enabled]	boolean	*
data.category[brand][departments][][is_chat_enabled]	boolean	*
data.category[brand][departments][][display_order]	integer	*
data.category[brand][departments][][avatar]	object (Blob)	*
data.category[brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.category[brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.category[brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.category[brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.category[brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.category[brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.category[brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.category[brand][departments][][avatar][authcode]	string	*
data.category[brand][departments][][avatar][blob_hash]	string	*
data.category[brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.category[brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.category[brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.category[brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.category[brand][departments][][avatar][date_created]	DateTime	*
data.category[brand][departments][][avatar][is_temp]	boolean	*
data.category[brand][departments][][avatar][source_ref]	string	*
data.category[brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.category[brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.category[brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.category[brand][departments][][brands][]	array of objects (Brand)	*
data.category[brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.category[brand][departments][][permissions][][department]	integer id (Department)	*
data.category[brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.category[brand][departments][][permissions][][name]	string	*	The name of the permission.
data.category[brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.category[brand][departments][][permissions][][is_active]	boolean	*
data.category[brand][departments][][chat_queue]	object (UserChatQueue)	*
data.category[brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.category[brand][departments][][chat_queue][name]	string	*
data.category[brand][departments][][chat_queue][routing_model]	string	*
data.category[brand][departments][][chat_queue][answer_timeout]	integer	*
data.category[brand][departments][][chat_queue][is_all_agents]	boolean	*
data.category[brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.category[brand][departments][][chat_queue][max_queue_size]	integer	*
data.category[brand][departments][][chat_queue][routingModel]		*
data.category[brand][theme_sets][]	array of objects (ThemeSet)	*
data.category[title]		*
data.revisions[]	array of objects (DownloadRevision)	*	Revisions of this download.
data.revisions[][id]	integer	*	The unique ID.
data.revisions[][person]	integer id (Person)	*	Person who made the revision.
data.revisions[][date_created]	DateTime	*	DateTime the revision was created.
data.blob	object (Blob)	*
data.blob[sys_name]	string	*	A unique system name for the blob.
data.blob[original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.blob[storage_loc]	string	*	The storage adapter that knows how to load this file.
data.blob[storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.blob[storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.blob[save_path]	string	*	The path to the file if it's not stored in the database.
data.blob[file_url]	string	*	The HTTP link to download the file.
data.blob[authcode]	string	*
data.blob[blob_hash]	string	*
data.blob[is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.blob[title]	string	*	The title of this file used in interfaces if its a media upload.
data.blob[dim_w]	integer	*	If this type of file has dimentions, the width.
data.blob[dim_h]	integer	*	If this type of file has dimentions, the height.
data.blob[date_created]	DateTime	*
data.blob[is_temp]	boolean	*
data.blob[source_ref]	string	*
data.blob[labels][]	array of objects (LabelBlob)	*
data.blob[labels][][blob]	object (Blob)	*
data.fileurl	string	*
data.filesize	integer	*
data.filename	string	*
data.display_order	integer	*
data.num_downloads	integer	*	Total number of downloads.
data.custom_data[]	array of objects (CustomDataDownload)	*
data.custom_data[][download]	object (Download)	*
data.custom_data[][download][category]	object (DownloadCategory)	*
data.custom_data[][download][revisions][]	array of objects (DownloadRevision)	*	Revisions of this download.
data.custom_data[][download][blob]	object (Blob)	*
data.custom_data[][download][fileurl]	string	*
data.custom_data[][download][filesize]	integer	*
data.custom_data[][download][filename]	string	*
data.custom_data[][download][display_order]	integer	*
data.custom_data[][download][num_downloads]	integer	*	Total number of downloads.
data.custom_data[][download][custom_data][]	array of objects (CustomDataDownload)	*
data.custom_data[][download][labels][]	array of objects (LabelDownload)	*	String array of labels associated with this download.
data.custom_data[][download][labels][][download]	object (Download)	*
data.custom_data[][download][content_format]	string	*
data.custom_data[][download][content_data]	array	*
data.custom_data[][download][date_end]	DateTime	*
data.custom_data[][download][end_action]	string	*
data.custom_data[][download][title]		*
data.custom_data[][download][content]		*
data.custom_data[][download][comments]		*
data.custom_data[][download][status]		*
data.custom_data[][field]	object (CustomDefDownload)	*
data.custom_data[][field][parent]	object (CustomDefDownload)	*
data.custom_data[][field][children][]	array of objects (CustomDefDownload)	*	Field children.
data.custom_data[][field][title]		*
data.custom_data[][root_field]	object (CustomDefDownload)	*
data.content_format	string	*
data.content_data	array	*
data.date_end	DateTime	*
data.end_action	string	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/downloads/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

content.downloads.count

Filters
Response
Status Codes

Name

Information

author

Datatype	string
Pattern	\d+\|me
Description	filter by author, provide an id or 'me' for current user

category

Datatype	integer
Pattern	\d+\|[\d+]
Description	filter category, could be an array or just digit

group_by

Datatype	string
Pattern	author\|category\|period_created\|period_updated
Description	how to group counters

status

Datatype	string
Pattern	published\|archived\|hidden
Description	filter by status

hidden_status

Datatype	integer
Pattern	unpublished\|deleted\|spam\|draft
Description	select for article with given id

period_created

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by period when content was created

period_last_comment

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by period when content was last commented

period_published

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by py period when content was published

period_updated

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by py period when content was updated

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/downloads/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.downloads.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/downloads/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.downloads.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.labels[]	array of objects (LabelDownload)	*	String array of labels associated with this download.
data.labels[][download]	object (Download)	*
data.labels[][download][category]	object (DownloadCategory)	*
data.labels[][download][category][parent]	object (DownloadCategory)	*	Category`s parent.
data.labels[][download][category][children][]	array of objects (DownloadCategory)	*	Category`s children.
data.labels[][download][category][downloads][]	array of objects (Download)	*	Downloads belong this category.
data.labels[][download][category][usergroups][]	array of objects (Usergroup)	*	Usergroups that has access to this category.
data.labels[][download][category][usergroups][][id]	integer	*	The unique ID, DB-generated.
data.labels[][download][category][usergroups][][title]	string	*	Title of the usergroup.
data.labels[][download][category][usergroups][][note]	string	*	A note or description about the usergroup.
data.labels[][download][category][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.labels[][download][category][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.labels[][download][category][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.labels[][download][category][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.labels[][download][category][usergroups][][permissions][][id]	integer	*	The unique ID.
data.labels[][download][category][usergroups][][permissions][][name]	string	*	The name of the permission.
data.labels[][download][category][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.labels[][download][category][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.labels[][download][category][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.labels[][download][category][usergroups][][department_permissions][][department]	integer id (Department)	*
data.labels[][download][category][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.labels[][download][category][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.labels[][download][category][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.labels[][download][category][usergroups][][department_permissions][][is_active]	boolean	*
data.labels[][download][category][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.labels[][download][category][brand]	object (Brand)	*	Brand linked to the category.
data.labels[][download][category][brand][id]	integer	*	The unique ID.
data.labels[][download][category][brand][name]	string	*	The brand name.
data.labels[][download][category][brand][slug]	string	*
data.labels[][download][category][brand][url]	string	*	The brand url.
data.labels[][download][category][brand][theme_set]	object (ThemeSet)	*
data.labels[][download][category][brand][theme_set][id]	integer	*
data.labels[][download][category][brand][theme_set][theme_id]	string	*
data.labels[][download][category][brand][theme_set][title]	string	*
data.labels[][download][category][brand][edit_theme_set]	object (ThemeSet)	*
data.labels[][download][category][brand][departments][]	array of objects (Department)	*
data.labels[][download][category][brand][departments][][id]	integer	*
data.labels[][download][category][brand][departments][][parent]	object (Department)	*
data.labels[][download][category][brand][departments][][children][]	array of objects (Department)	*
data.labels[][download][category][brand][departments][][title]	string	*
data.labels[][download][category][brand][departments][][user_title]	string	*
data.labels[][download][category][brand][departments][][is_tickets_enabled]	boolean	*
data.labels[][download][category][brand][departments][][is_chat_enabled]	boolean	*
data.labels[][download][category][brand][departments][][display_order]	integer	*
data.labels[][download][category][brand][departments][][avatar]	object (Blob)	*
data.labels[][download][category][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.labels[][download][category][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][download][category][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][download][category][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][download][category][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][download][category][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][download][category][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.labels[][download][category][brand][departments][][avatar][authcode]	string	*
data.labels[][download][category][brand][departments][][avatar][blob_hash]	string	*
data.labels[][download][category][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][download][category][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][download][category][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][download][category][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][download][category][brand][departments][][avatar][date_created]	DateTime	*
data.labels[][download][category][brand][departments][][avatar][is_temp]	boolean	*
data.labels[][download][category][brand][departments][][avatar][source_ref]	string	*
data.labels[][download][category][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.labels[][download][category][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.labels[][download][category][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.labels[][download][category][brand][departments][][brands][]	array of objects (Brand)	*
data.labels[][download][category][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.labels[][download][category][brand][departments][][permissions][][department]	integer id (Department)	*
data.labels[][download][category][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.labels[][download][category][brand][departments][][permissions][][name]	string	*	The name of the permission.
data.labels[][download][category][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.labels[][download][category][brand][departments][][permissions][][is_active]	boolean	*
data.labels[][download][category][brand][departments][][chat_queue]	object (UserChatQueue)	*
data.labels[][download][category][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.labels[][download][category][brand][departments][][chat_queue][name]	string	*
data.labels[][download][category][brand][departments][][chat_queue][routing_model]	string	*
data.labels[][download][category][brand][departments][][chat_queue][answer_timeout]	integer	*
data.labels[][download][category][brand][departments][][chat_queue][is_all_agents]	boolean	*
data.labels[][download][category][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.labels[][download][category][brand][departments][][chat_queue][max_queue_size]	integer	*
data.labels[][download][category][brand][theme_sets][]	array of objects (ThemeSet)	*
data.labels[][download][revisions][]	array of objects (DownloadRevision)	*	Revisions of this download.
data.labels[][download][revisions][][id]	integer	*	The unique ID.
data.labels[][download][revisions][][person]	integer id (Person)	*	Person who made the revision.
data.labels[][download][revisions][][date_created]	DateTime	*	DateTime the revision was created.
data.labels[][download][blob]	object (Blob)	*
data.labels[][download][blob][sys_name]	string	*	A unique system name for the blob.
data.labels[][download][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][download][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][download][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][download][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][download][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][download][blob][file_url]	string	*	The HTTP link to download the file.
data.labels[][download][blob][authcode]	string	*
data.labels[][download][blob][blob_hash]	string	*
data.labels[][download][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][download][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][download][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][download][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][download][blob][date_created]	DateTime	*
data.labels[][download][blob][is_temp]	boolean	*
data.labels[][download][blob][source_ref]	string	*
data.labels[][download][blob][labels][]	array of objects (LabelBlob)	*
data.labels[][download][blob][labels][][blob]	object (Blob)	*
data.labels[][download][fileurl]	string	*
data.labels[][download][filesize]	integer	*
data.labels[][download][filename]	string	*
data.labels[][download][display_order]	integer	*
data.labels[][download][num_downloads]	integer	*	Total number of downloads.
data.labels[][download][custom_data][]	array of objects (CustomDataDownload)	*
data.labels[][download][custom_data][][download]	object (Download)	*
data.labels[][download][custom_data][][field]	object (CustomDefDownload)	*
data.labels[][download][custom_data][][field][parent]	object (CustomDefDownload)	*
data.labels[][download][custom_data][][field][children][]	array of objects (CustomDefDownload)	*	Field children.
data.labels[][download][custom_data][][root_field]	object (CustomDefDownload)	*
data.labels[][download][labels][]	array of objects (LabelDownload)	*	String array of labels associated with this download.
data.labels[][download][content_format]	string	*
data.labels[][download][content_data]	array	*
data.labels[][download][date_end]	DateTime	*
data.labels[][download][end_action]	string	*
data.labels[][download][title]		*
data.labels[][download][content]		*
data.labels[][download][comments]		*
data.labels[][download][status]		*
data.labels[][label]		*
data.title		*
data.content		*
data.comments		*
data.status		*
data.category	object (DownloadCategory)	*
data.category[parent]	object (DownloadCategory)	*	Category`s parent.
data.category[children][]	array of objects (DownloadCategory)	*	Category`s children.
data.category[downloads][]	array of objects (Download)	*	Downloads belong this category.
data.category[downloads][][category]	object (DownloadCategory)	*
data.category[downloads][][revisions][]	array of objects (DownloadRevision)	*	Revisions of this download.
data.category[downloads][][revisions][][id]	integer	*	The unique ID.
data.category[downloads][][revisions][][person]	integer id (Person)	*	Person who made the revision.
data.category[downloads][][revisions][][date_created]	DateTime	*	DateTime the revision was created.
data.category[downloads][][blob]	object (Blob)	*
data.category[downloads][][blob][sys_name]	string	*	A unique system name for the blob.
data.category[downloads][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.category[downloads][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.category[downloads][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.category[downloads][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.category[downloads][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.category[downloads][][blob][file_url]	string	*	The HTTP link to download the file.
data.category[downloads][][blob][authcode]	string	*
data.category[downloads][][blob][blob_hash]	string	*
data.category[downloads][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.category[downloads][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.category[downloads][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.category[downloads][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.category[downloads][][blob][date_created]	DateTime	*
data.category[downloads][][blob][is_temp]	boolean	*
data.category[downloads][][blob][source_ref]	string	*
data.category[downloads][][blob][labels][]	array of objects (LabelBlob)	*
data.category[downloads][][blob][labels][][blob]	object (Blob)	*
data.category[downloads][][fileurl]	string	*
data.category[downloads][][filesize]	integer	*
data.category[downloads][][filename]	string	*
data.category[downloads][][display_order]	integer	*
data.category[downloads][][num_downloads]	integer	*	Total number of downloads.
data.category[downloads][][custom_data][]	array of objects (CustomDataDownload)	*
data.category[downloads][][custom_data][][download]	object (Download)	*
data.category[downloads][][custom_data][][field]	object (CustomDefDownload)	*
data.category[downloads][][custom_data][][field][parent]	object (CustomDefDownload)	*
data.category[downloads][][custom_data][][field][children][]	array of objects (CustomDefDownload)	*	Field children.
data.category[downloads][][custom_data][][field][title]		*
data.category[downloads][][custom_data][][root_field]	object (CustomDefDownload)	*
data.category[downloads][][labels][]	array of objects (LabelDownload)	*	String array of labels associated with this download.
data.category[downloads][][labels][][download]	object (Download)	*
data.category[downloads][][content_format]	string	*
data.category[downloads][][content_data]	array	*
data.category[downloads][][date_end]	DateTime	*
data.category[downloads][][end_action]	string	*
data.category[downloads][][title]		*
data.category[downloads][][content]		*
data.category[downloads][][comments]		*
data.category[downloads][][status]		*
data.category[usergroups][]	array of objects (Usergroup)	*	Usergroups that has access to this category.
data.category[usergroups][][id]	integer	*	The unique ID, DB-generated.
data.category[usergroups][][title]	string	*	Title of the usergroup.
data.category[usergroups][][note]	string	*	A note or description about the usergroup.
data.category[usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.category[usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.category[usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.category[usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.category[usergroups][][permissions][][id]	integer	*	The unique ID.
data.category[usergroups][][permissions][][name]	string	*	The name of the permission.
data.category[usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.category[usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.category[usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.category[usergroups][][department_permissions][][department]	integer id (Department)	*
data.category[usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.category[usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.category[usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.category[usergroups][][department_permissions][][is_active]	boolean	*
data.category[usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.category[usergroups][][people][][emails]		*
data.category[usergroups][][people][][labels]		*
data.category[usergroups][][people][][teams]		*
data.category[usergroups][][people][][primary_team]		*
data.category[usergroups][][people][][agentData]		*
data.category[usergroups][][people][][publicUsergroups]		*
data.category[usergroups][][people][][publicAgentgroups]		*
data.category[brand]	object (Brand)	*	Brand linked to the category.
data.category[brand][id]	integer	*	The unique ID.
data.category[brand][name]	string	*	The brand name.
data.category[brand][slug]	string	*
data.category[brand][url]	string	*	The brand url.
data.category[brand][theme_set]	object (ThemeSet)	*
data.category[brand][theme_set][id]	integer	*
data.category[brand][theme_set][theme_id]	string	*
data.category[brand][theme_set][title]	string	*
data.category[brand][theme_set][options]		*
data.category[brand][edit_theme_set]	object (ThemeSet)	*
data.category[brand][departments][]	array of objects (Department)	*
data.category[brand][departments][][id]	integer	*
data.category[brand][departments][][parent]	object (Department)	*
data.category[brand][departments][][children][]	array of objects (Department)	*
data.category[brand][departments][][title]	string	*
data.category[brand][departments][][user_title]	string	*
data.category[brand][departments][][is_tickets_enabled]	boolean	*
data.category[brand][departments][][is_chat_enabled]	boolean	*
data.category[brand][departments][][display_order]	integer	*
data.category[brand][departments][][avatar]	object (Blob)	*
data.category[brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.category[brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.category[brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.category[brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.category[brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.category[brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.category[brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.category[brand][departments][][avatar][authcode]	string	*
data.category[brand][departments][][avatar][blob_hash]	string	*
data.category[brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.category[brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.category[brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.category[brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.category[brand][departments][][avatar][date_created]	DateTime	*
data.category[brand][departments][][avatar][is_temp]	boolean	*
data.category[brand][departments][][avatar][source_ref]	string	*
data.category[brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.category[brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.category[brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.category[brand][departments][][brands][]	array of objects (Brand)	*
data.category[brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.category[brand][departments][][permissions][][department]	integer id (Department)	*
data.category[brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.category[brand][departments][][permissions][][name]	string	*	The name of the permission.
data.category[brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.category[brand][departments][][permissions][][is_active]	boolean	*
data.category[brand][departments][][chat_queue]	object (UserChatQueue)	*
data.category[brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.category[brand][departments][][chat_queue][name]	string	*
data.category[brand][departments][][chat_queue][routing_model]	string	*
data.category[brand][departments][][chat_queue][answer_timeout]	integer	*
data.category[brand][departments][][chat_queue][is_all_agents]	boolean	*
data.category[brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.category[brand][departments][][chat_queue][max_queue_size]	integer	*
data.category[brand][departments][][chat_queue][routingModel]		*
data.category[brand][theme_sets][]	array of objects (ThemeSet)	*
data.category[title]		*
data.revisions[]	array of objects (DownloadRevision)	*	Revisions of this download.
data.revisions[][id]	integer	*	The unique ID.
data.revisions[][person]	integer id (Person)	*	Person who made the revision.
data.revisions[][date_created]	DateTime	*	DateTime the revision was created.
data.blob	object (Blob)	*
data.blob[sys_name]	string	*	A unique system name for the blob.
data.blob[original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.blob[storage_loc]	string	*	The storage adapter that knows how to load this file.
data.blob[storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.blob[storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.blob[save_path]	string	*	The path to the file if it's not stored in the database.
data.blob[file_url]	string	*	The HTTP link to download the file.
data.blob[authcode]	string	*
data.blob[blob_hash]	string	*
data.blob[is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.blob[title]	string	*	The title of this file used in interfaces if its a media upload.
data.blob[dim_w]	integer	*	If this type of file has dimentions, the width.
data.blob[dim_h]	integer	*	If this type of file has dimentions, the height.
data.blob[date_created]	DateTime	*
data.blob[is_temp]	boolean	*
data.blob[source_ref]	string	*
data.blob[labels][]	array of objects (LabelBlob)	*
data.blob[labels][][blob]	object (Blob)	*
data.fileurl	string	*
data.filesize	integer	*
data.filename	string	*
data.display_order	integer	*
data.num_downloads	integer	*	Total number of downloads.
data.custom_data[]	array of objects (CustomDataDownload)	*
data.custom_data[][download]	object (Download)	*
data.custom_data[][download][category]	object (DownloadCategory)	*
data.custom_data[][download][revisions][]	array of objects (DownloadRevision)	*	Revisions of this download.
data.custom_data[][download][blob]	object (Blob)	*
data.custom_data[][download][fileurl]	string	*
data.custom_data[][download][filesize]	integer	*
data.custom_data[][download][filename]	string	*
data.custom_data[][download][display_order]	integer	*
data.custom_data[][download][num_downloads]	integer	*	Total number of downloads.
data.custom_data[][download][custom_data][]	array of objects (CustomDataDownload)	*
data.custom_data[][download][labels][]	array of objects (LabelDownload)	*	String array of labels associated with this download.
data.custom_data[][download][labels][][download]	object (Download)	*
data.custom_data[][download][content_format]	string	*
data.custom_data[][download][content_data]	array	*
data.custom_data[][download][date_end]	DateTime	*
data.custom_data[][download][end_action]	string	*
data.custom_data[][download][title]		*
data.custom_data[][download][content]		*
data.custom_data[][download][comments]		*
data.custom_data[][download][status]		*
data.custom_data[][field]	object (CustomDefDownload)	*
data.custom_data[][field][parent]	object (CustomDefDownload)	*
data.custom_data[][field][children][]	array of objects (CustomDefDownload)	*	Field children.
data.custom_data[][field][title]		*
data.custom_data[][root_field]	object (CustomDefDownload)	*
data.content_format	string	*
data.content_data	array	*
data.date_end	DateTime	*
data.end_action	string	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/downloads/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.downloads.put

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/guides CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.guide.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (Guide)	*
data[][title]	string	*	Category's title.
data[][id]	integer	*	The unique id of the guide.
data[][description]	string	*	Category's description.
data[][slug]	string	*
data[][display_order]	integer	*	Display order.
data[][topics][]	array of integer ids (Topic)	*	Manual topics in this manual.
data[][use_volumes]	boolean	*
data[][usergroups][]	array of integer ids (Usergroup)	*	Usergroups that has access to this category.
data[][brand]	integer id (Brand)	*	Brand linked to the category.
data[][color]	string	*
data[][icon_property]	integer id (IconProperty)	*
data[][splash_image_property]	integer id (SplashImageProperty)	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/guides CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.guide.post

Parameters
Response
Status Codes

Parameter	Type	Required?
title	string	true
display_order	string	true
brand	choice	true

Parameter	Type	Versions	Description
data.title	string	*	Category's title.
data.id	integer	*	The unique id of the guide.
data.description	string	*	Category's description.
data.slug	string	*
data.display_order	integer	*	Display order.
data.topics[]	array of integer ids (Topic)	*	Manual topics in this manual.
data.use_volumes	boolean	*
data.usergroups[]	array of integer ids (Usergroup)	*	Usergroups that has access to this category.
data.brand	integer id (Brand)	*	Brand linked to the category.
data.color	string	*
data.icon_property	integer id (IconProperty)	*
data.splash_image_property	integer id (SplashImageProperty)	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/guides/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.guide.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

GET /api/v2/guides/{guideId}/export

export a full json of the guide

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.guide.export

Requirements
Response
Status Codes

Name	Requirement	Type	Description
guideId

Parameter	Type	Versions	Description
data.title	string	*	Category's title.
data.id	integer	*	The unique id of the guide.
data.description	string	*	Category's description.
data.slug	string	*
data.display_order	integer	*	Display order.
data.topics[]	array of integer ids (Topic)	*	Manual topics in this manual.
data.use_volumes	boolean	*
data.usergroups[]	array of integer ids (Usergroup)	*	Usergroups that has access to this category.
data.brand	integer id (Brand)	*	Brand linked to the category.
data.color	string	*
data.icon_property	integer id (IconProperty)	*
data.splash_image_property	integer id (SplashImageProperty)	*

Status Code	Description
201	Created
400	Bad Request

GET /api/v2/guides/{guideId}/tree

give a topics tree list of a guide

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.guide.get_tree

Requirements
Status Codes

Name	Requirement	Type	Description
guideId

Status Code	Description
201	Created
400	Bad Request

PUT /api/v2/guides/{guideId}/tree

save the tree structure

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.guide.put_tree

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
guideId

Parameter	Type	Required?	Format	Description
	array	true

Status Code	Description
201	Created
400	Bad Request

DELETE /api/v2/guides/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.guide.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/guides/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.guide.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.title	string	*	Category's title.
data.id	integer	*	The unique id of the guide.
data.description	string	*	Category's description.
data.slug	string	*
data.display_order	integer	*	Display order.
data.topics[]	array of integer ids (Topic)	*	Manual topics in this manual.
data.use_volumes	boolean	*
data.usergroups[]	array of integer ids (Usergroup)	*	Usergroups that has access to this category.
data.brand	integer id (Brand)	*	Brand linked to the category.
data.color	string	*
data.icon_property	integer id (IconProperty)	*
data.splash_image_property	integer id (SplashImageProperty)	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/guides/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.guide.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?
title	string	false
display_order	string	false
brand	choice	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

POST /api/v2/guides_comments CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.comments.guides_all_comments.post

Response
Status Codes

Parameter	Type	Versions	Description
data.status	string	*	Comment`s status.
data.id	integer	*	The unique ID.
data.person	integer id (Person)	*	The id of person that wrote this comment.
data.ip_address	string	*	IP address with which comment was written.
data.email	string	*	Person`s email.
data.name	string	*	Person`s name.
data.website	string	*	Website where comment was written.
data.content	string	*	Comment`s content itself.
data.is_reviewed	boolean	*	Has this comment been reviewed by an agent?
data.date_created	DateTime	*	When this comment was created.
data.content_type	string	*	Content Type for this comment.
data.rating	integer	*	Total rating for this comment.
data.topic	integer id (Topic)	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

PUT /api/v2/guides_comments/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.comments.guides_all_comments.put

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/news CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

content.news.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

author

Datatype	string
Pattern	\d+\|me
Description	filter by author, provide an id or 'me' for current user

category

Datatype	integer
Pattern	\d+\|[\d+]
Description	filter category, could be an array or just digit

group_by

Datatype	string
Pattern	author\|category\|period_created\|period_updated
Description	how to group downloads

status

Datatype	string
Pattern	published\|archived\|hidden
Description	filter by status

hidden_status

Datatype	integer
Pattern	unpublished\|deleted\|spam\|draft
Description	select for article with given id

period_created

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by period when content was created

period_last_comment

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by period when content was last commented

period_published

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by py period when content was published

period_updated

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by py period when content was updated

order_by

Datatype	integer
Pattern	date_created\|date_updated\|person
Description	how to order

Parameter	Type	Versions	Description
data[]	array of objects (News)	*
data[][attachments][]	array of objects (NewsAttachment)	*
data[][attachments][][id]	integer	*
data[][attachments][][news]	integer id (News)	*
data[][attachments][][person]	integer id (Person)	*	Who created the attachment.
data[][attachments][][blob]	object (Blob)	*
data[][attachments][][blob][sys_name]	string	*	A unique system name for the blob.
data[][attachments][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][attachments][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][attachments][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][attachments][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][attachments][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][attachments][][blob][file_url]	string	*	The HTTP link to download the file.
data[][attachments][][blob][authcode]	string	*
data[][attachments][][blob][blob_hash]	string	*
data[][attachments][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][attachments][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][attachments][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][attachments][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][attachments][][blob][date_created]	DateTime	*
data[][attachments][][blob][is_temp]	boolean	*
data[][attachments][][blob][source_ref]	string	*
data[][attachments][][blob][labels][]	array of objects (LabelBlob)	*
data[][attachments][][blob][labels][][blob]	object (Blob)	*
data[][labels][]	array of objects (LabelNews)	*	String array of labels associated with this news.
data[][labels][][news]	object (News)	*
data[][labels][][news][category]	object (NewsCategory)	*
data[][labels][][news][revisions][]	array of objects (NewsRevision)	*	Revisions of this news.
data[][labels][][news][attachments][]	array of objects (NewsAttachment)	*
data[][labels][][news][labels][]	array of objects (LabelNews)	*	String array of labels associated with this news.
data[][labels][][news][display_order]	integer	*
data[][labels][][news][date_end]	DateTime	*
data[][labels][][news][end_action]	string	*
data[][labels][][news][content_format]	string	*
data[][labels][][news][content_data]	array	*
data[][title]		*
data[][content]		*
data[][comments]		*
data[][status]		*
data[][category]	object (NewsCategory)	*
data[][category][parent]	object (NewsCategory)	*	Category`s parent.
data[][category][children][]	array of objects (NewsCategory)	*	Category`s children.
data[][category][articles][]	array of objects (News)	*	Articles belongs this category.
data[][category][articles][][category]	object (NewsCategory)	*
data[][category][articles][][revisions][]	array of objects (NewsRevision)	*	Revisions of this news.
data[][category][articles][][revisions][][id]	integer	*	The unique ID.
data[][category][articles][][revisions][][person]	integer id (Person)	*	Person who made the revision.
data[][category][articles][][revisions][][date_created]	DateTime	*	DateTime the revision was created.
data[][category][articles][][attachments][]	array of objects (NewsAttachment)	*
data[][category][articles][][attachments][][id]	integer	*
data[][category][articles][][attachments][][news]	integer id (News)	*
data[][category][articles][][attachments][][person]	integer id (Person)	*	Who created the attachment.
data[][category][articles][][attachments][][blob]	object (Blob)	*
data[][category][articles][][attachments][][blob][sys_name]	string	*	A unique system name for the blob.
data[][category][articles][][attachments][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][category][articles][][attachments][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][category][articles][][attachments][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][category][articles][][attachments][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][category][articles][][attachments][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][category][articles][][attachments][][blob][file_url]	string	*	The HTTP link to download the file.
data[][category][articles][][attachments][][blob][authcode]	string	*
data[][category][articles][][attachments][][blob][blob_hash]	string	*
data[][category][articles][][attachments][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][category][articles][][attachments][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][category][articles][][attachments][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][category][articles][][attachments][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][category][articles][][attachments][][blob][date_created]	DateTime	*
data[][category][articles][][attachments][][blob][is_temp]	boolean	*
data[][category][articles][][attachments][][blob][source_ref]	string	*
data[][category][articles][][attachments][][blob][labels][]	array of objects (LabelBlob)	*
data[][category][articles][][attachments][][blob][labels][][blob]	object (Blob)	*
data[][category][articles][][labels][]	array of objects (LabelNews)	*	String array of labels associated with this news.
data[][category][articles][][labels][][news]	object (News)	*
data[][category][articles][][display_order]	integer	*
data[][category][articles][][date_end]	DateTime	*
data[][category][articles][][end_action]	string	*
data[][category][articles][][content_format]	string	*
data[][category][articles][][content_data]	array	*
data[][category][usergroups][]	array of objects (Usergroup)	*	Usergroups that has access to this category.
data[][category][usergroups][][id]	integer	*	The unique ID, DB-generated.
data[][category][usergroups][][title]	string	*	Title of the usergroup.
data[][category][usergroups][][note]	string	*	A note or description about the usergroup.
data[][category][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data[][category][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data[][category][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data[][category][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data[][category][usergroups][][permissions][][id]	integer	*	The unique ID.
data[][category][usergroups][][permissions][][name]	string	*	The name of the permission.
data[][category][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][category][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data[][category][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data[][category][usergroups][][department_permissions][][department]	integer id (Department)	*
data[][category][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][category][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data[][category][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][category][usergroups][][department_permissions][][is_active]	boolean	*
data[][category][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data[][category][brand]	object (Brand)	*	Brand linked to the category.
data[][category][brand][id]	integer	*	The unique ID.
data[][category][brand][name]	string	*	The brand name.
data[][category][brand][slug]	string	*
data[][category][brand][url]	string	*	The brand url.
data[][category][brand][theme_set]	object (ThemeSet)	*
data[][category][brand][theme_set][id]	integer	*
data[][category][brand][theme_set][theme_id]	string	*
data[][category][brand][theme_set][title]	string	*
data[][category][brand][edit_theme_set]	object (ThemeSet)	*
data[][category][brand][departments][]	array of objects (Department)	*
data[][category][brand][departments][][id]	integer	*
data[][category][brand][departments][][parent]	object (Department)	*
data[][category][brand][departments][][children][]	array of objects (Department)	*
data[][category][brand][departments][][title]	string	*
data[][category][brand][departments][][user_title]	string	*
data[][category][brand][departments][][is_tickets_enabled]	boolean	*
data[][category][brand][departments][][is_chat_enabled]	boolean	*
data[][category][brand][departments][][display_order]	integer	*
data[][category][brand][departments][][avatar]	object (Blob)	*
data[][category][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data[][category][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][category][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][category][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][category][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][category][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data[][category][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data[][category][brand][departments][][avatar][authcode]	string	*
data[][category][brand][departments][][avatar][blob_hash]	string	*
data[][category][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][category][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][category][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][category][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][category][brand][departments][][avatar][date_created]	DateTime	*
data[][category][brand][departments][][avatar][is_temp]	boolean	*
data[][category][brand][departments][][avatar][source_ref]	string	*
data[][category][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data[][category][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data[][category][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][category][brand][departments][][brands][]	array of objects (Brand)	*
data[][category][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data[][category][brand][departments][][permissions][][department]	integer id (Department)	*
data[][category][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][category][brand][departments][][permissions][][name]	string	*	The name of the permission.
data[][category][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][category][brand][departments][][permissions][][is_active]	boolean	*
data[][category][brand][departments][][chat_queue]	object (UserChatQueue)	*
data[][category][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data[][category][brand][departments][][chat_queue][name]	string	*
data[][category][brand][departments][][chat_queue][routing_model]	string	*
data[][category][brand][departments][][chat_queue][answer_timeout]	integer	*
data[][category][brand][departments][][chat_queue][is_all_agents]	boolean	*
data[][category][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data[][category][brand][departments][][chat_queue][max_queue_size]	integer	*
data[][category][brand][theme_sets][]	array of objects (ThemeSet)	*
data[][revisions][]	array of objects (NewsRevision)	*	Revisions of this news.
data[][revisions][][id]	integer	*	The unique ID.
data[][revisions][][person]	integer id (Person)	*	Person who made the revision.
data[][revisions][][date_created]	DateTime	*	DateTime the revision was created.
data[][display_order]	integer	*
data[][date_end]	DateTime	*
data[][end_action]	string	*
data[][content_format]	string	*
data[][content_data]	array	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/news CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.news.post

Parameters
Response
Status Codes

Parameter	Type	Required?	Format
title	string	true
content	string	true
person[id]	string	false
person[name]	string	false
person[email]	string	false
person[fieldId]	string	false
person[key]	string	false
language	choice	false
content_input_type	choice	false	["markdown","rte","dped_v1","html"]
status	choice	true	["archived","published","hidden.deleted","hidden.draft","hidden.pending","hidden.spam","hidden.unpublished"]
category	choice	false
date_published	datetime	false	yyyy-MM-dd'T'HH:mm:ss
title_translations[][language]	choice	true
title_translations[][value]	string	true
content_translations[][language]	choice	true
content_translations[][value]	string	true

Parameter	Type	Versions	Description
data.attachments[]	array of objects (NewsAttachment)	*
data.attachments[][id]	integer	*
data.attachments[][news]	integer id (News)	*
data.attachments[][person]	integer id (Person)	*	Who created the attachment.
data.attachments[][blob]	object (Blob)	*
data.attachments[][blob][sys_name]	string	*	A unique system name for the blob.
data.attachments[][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.attachments[][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.attachments[][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.attachments[][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.attachments[][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.attachments[][blob][file_url]	string	*	The HTTP link to download the file.
data.attachments[][blob][authcode]	string	*
data.attachments[][blob][blob_hash]	string	*
data.attachments[][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.attachments[][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.attachments[][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.attachments[][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.attachments[][blob][date_created]	DateTime	*
data.attachments[][blob][is_temp]	boolean	*
data.attachments[][blob][source_ref]	string	*
data.attachments[][blob][labels][]	array of objects (LabelBlob)	*
data.attachments[][blob][labels][][blob]	object (Blob)	*
data.labels[]	array of objects (LabelNews)	*	String array of labels associated with this news.
data.labels[][news]	object (News)	*
data.labels[][news][category]	object (NewsCategory)	*
data.labels[][news][category][parent]	object (NewsCategory)	*	Category`s parent.
data.labels[][news][category][children][]	array of objects (NewsCategory)	*	Category`s children.
data.labels[][news][category][articles][]	array of objects (News)	*	Articles belongs this category.
data.labels[][news][category][usergroups][]	array of objects (Usergroup)	*	Usergroups that has access to this category.
data.labels[][news][category][usergroups][][id]	integer	*	The unique ID, DB-generated.
data.labels[][news][category][usergroups][][title]	string	*	Title of the usergroup.
data.labels[][news][category][usergroups][][note]	string	*	A note or description about the usergroup.
data.labels[][news][category][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.labels[][news][category][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.labels[][news][category][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.labels[][news][category][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.labels[][news][category][usergroups][][permissions][][id]	integer	*	The unique ID.
data.labels[][news][category][usergroups][][permissions][][name]	string	*	The name of the permission.
data.labels[][news][category][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.labels[][news][category][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.labels[][news][category][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.labels[][news][category][usergroups][][department_permissions][][department]	integer id (Department)	*
data.labels[][news][category][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.labels[][news][category][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.labels[][news][category][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.labels[][news][category][usergroups][][department_permissions][][is_active]	boolean	*
data.labels[][news][category][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.labels[][news][category][brand]	object (Brand)	*	Brand linked to the category.
data.labels[][news][category][brand][id]	integer	*	The unique ID.
data.labels[][news][category][brand][name]	string	*	The brand name.
data.labels[][news][category][brand][slug]	string	*
data.labels[][news][category][brand][url]	string	*	The brand url.
data.labels[][news][category][brand][theme_set]	object (ThemeSet)	*
data.labels[][news][category][brand][theme_set][id]	integer	*
data.labels[][news][category][brand][theme_set][theme_id]	string	*
data.labels[][news][category][brand][theme_set][title]	string	*
data.labels[][news][category][brand][edit_theme_set]	object (ThemeSet)	*
data.labels[][news][category][brand][departments][]	array of objects (Department)	*
data.labels[][news][category][brand][departments][][id]	integer	*
data.labels[][news][category][brand][departments][][parent]	object (Department)	*
data.labels[][news][category][brand][departments][][children][]	array of objects (Department)	*
data.labels[][news][category][brand][departments][][title]	string	*
data.labels[][news][category][brand][departments][][user_title]	string	*
data.labels[][news][category][brand][departments][][is_tickets_enabled]	boolean	*
data.labels[][news][category][brand][departments][][is_chat_enabled]	boolean	*
data.labels[][news][category][brand][departments][][display_order]	integer	*
data.labels[][news][category][brand][departments][][avatar]	object (Blob)	*
data.labels[][news][category][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.labels[][news][category][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][news][category][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][news][category][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][news][category][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][news][category][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][news][category][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.labels[][news][category][brand][departments][][avatar][authcode]	string	*
data.labels[][news][category][brand][departments][][avatar][blob_hash]	string	*
data.labels[][news][category][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][news][category][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][news][category][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][news][category][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][news][category][brand][departments][][avatar][date_created]	DateTime	*
data.labels[][news][category][brand][departments][][avatar][is_temp]	boolean	*
data.labels[][news][category][brand][departments][][avatar][source_ref]	string	*
data.labels[][news][category][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.labels[][news][category][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.labels[][news][category][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.labels[][news][category][brand][departments][][brands][]	array of objects (Brand)	*
data.labels[][news][category][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.labels[][news][category][brand][departments][][permissions][][department]	integer id (Department)	*
data.labels[][news][category][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.labels[][news][category][brand][departments][][permissions][][name]	string	*	The name of the permission.
data.labels[][news][category][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.labels[][news][category][brand][departments][][permissions][][is_active]	boolean	*
data.labels[][news][category][brand][departments][][chat_queue]	object (UserChatQueue)	*
data.labels[][news][category][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.labels[][news][category][brand][departments][][chat_queue][name]	string	*
data.labels[][news][category][brand][departments][][chat_queue][routing_model]	string	*
data.labels[][news][category][brand][departments][][chat_queue][answer_timeout]	integer	*
data.labels[][news][category][brand][departments][][chat_queue][is_all_agents]	boolean	*
data.labels[][news][category][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.labels[][news][category][brand][departments][][chat_queue][max_queue_size]	integer	*
data.labels[][news][category][brand][theme_sets][]	array of objects (ThemeSet)	*
data.labels[][news][revisions][]	array of objects (NewsRevision)	*	Revisions of this news.
data.labels[][news][revisions][][id]	integer	*	The unique ID.
data.labels[][news][revisions][][person]	integer id (Person)	*	Person who made the revision.
data.labels[][news][revisions][][date_created]	DateTime	*	DateTime the revision was created.
data.labels[][news][attachments][]	array of objects (NewsAttachment)	*
data.labels[][news][labels][]	array of objects (LabelNews)	*	String array of labels associated with this news.
data.labels[][news][display_order]	integer	*
data.labels[][news][date_end]	DateTime	*
data.labels[][news][end_action]	string	*
data.labels[][news][content_format]	string	*
data.labels[][news][content_data]	array	*
data.labels[][news][title]		*
data.labels[][news][content]		*
data.labels[][news][comments]		*
data.labels[][news][status]		*
data.labels[][label]		*
data.title		*
data.content		*
data.comments		*
data.status		*
data.category	object (NewsCategory)	*
data.category[parent]	object (NewsCategory)	*	Category`s parent.
data.category[children][]	array of objects (NewsCategory)	*	Category`s children.
data.category[articles][]	array of objects (News)	*	Articles belongs this category.
data.category[articles][][category]	object (NewsCategory)	*
data.category[articles][][revisions][]	array of objects (NewsRevision)	*	Revisions of this news.
data.category[articles][][revisions][][id]	integer	*	The unique ID.
data.category[articles][][revisions][][person]	integer id (Person)	*	Person who made the revision.
data.category[articles][][revisions][][date_created]	DateTime	*	DateTime the revision was created.
data.category[articles][][attachments][]	array of objects (NewsAttachment)	*
data.category[articles][][attachments][][id]	integer	*
data.category[articles][][attachments][][news]	integer id (News)	*
data.category[articles][][attachments][][person]	integer id (Person)	*	Who created the attachment.
data.category[articles][][attachments][][blob]	object (Blob)	*
data.category[articles][][attachments][][blob][sys_name]	string	*	A unique system name for the blob.
data.category[articles][][attachments][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.category[articles][][attachments][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.category[articles][][attachments][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.category[articles][][attachments][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.category[articles][][attachments][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.category[articles][][attachments][][blob][file_url]	string	*	The HTTP link to download the file.
data.category[articles][][attachments][][blob][authcode]	string	*
data.category[articles][][attachments][][blob][blob_hash]	string	*
data.category[articles][][attachments][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.category[articles][][attachments][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.category[articles][][attachments][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.category[articles][][attachments][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.category[articles][][attachments][][blob][date_created]	DateTime	*
data.category[articles][][attachments][][blob][is_temp]	boolean	*
data.category[articles][][attachments][][blob][source_ref]	string	*
data.category[articles][][attachments][][blob][labels][]	array of objects (LabelBlob)	*
data.category[articles][][attachments][][blob][labels][][blob]	object (Blob)	*
data.category[articles][][labels][]	array of objects (LabelNews)	*	String array of labels associated with this news.
data.category[articles][][labels][][news]	object (News)	*
data.category[articles][][display_order]	integer	*
data.category[articles][][date_end]	DateTime	*
data.category[articles][][end_action]	string	*
data.category[articles][][content_format]	string	*
data.category[articles][][content_data]	array	*
data.category[articles][][title]		*
data.category[articles][][content]		*
data.category[articles][][comments]		*
data.category[articles][][status]		*
data.category[usergroups][]	array of objects (Usergroup)	*	Usergroups that has access to this category.
data.category[usergroups][][id]	integer	*	The unique ID, DB-generated.
data.category[usergroups][][title]	string	*	Title of the usergroup.
data.category[usergroups][][note]	string	*	A note or description about the usergroup.
data.category[usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.category[usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.category[usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.category[usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.category[usergroups][][permissions][][id]	integer	*	The unique ID.
data.category[usergroups][][permissions][][name]	string	*	The name of the permission.
data.category[usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.category[usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.category[usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.category[usergroups][][department_permissions][][department]	integer id (Department)	*
data.category[usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.category[usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.category[usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.category[usergroups][][department_permissions][][is_active]	boolean	*
data.category[usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.category[usergroups][][people][][emails]		*
data.category[usergroups][][people][][labels]		*
data.category[usergroups][][people][][teams]		*
data.category[usergroups][][people][][primary_team]		*
data.category[usergroups][][people][][agentData]		*
data.category[usergroups][][people][][publicUsergroups]		*
data.category[usergroups][][people][][publicAgentgroups]		*
data.category[brand]	object (Brand)	*	Brand linked to the category.
data.category[brand][id]	integer	*	The unique ID.
data.category[brand][name]	string	*	The brand name.
data.category[brand][slug]	string	*
data.category[brand][url]	string	*	The brand url.
data.category[brand][theme_set]	object (ThemeSet)	*
data.category[brand][theme_set][id]	integer	*
data.category[brand][theme_set][theme_id]	string	*
data.category[brand][theme_set][title]	string	*
data.category[brand][theme_set][options]		*
data.category[brand][edit_theme_set]	object (ThemeSet)	*
data.category[brand][departments][]	array of objects (Department)	*
data.category[brand][departments][][id]	integer	*
data.category[brand][departments][][parent]	object (Department)	*
data.category[brand][departments][][children][]	array of objects (Department)	*
data.category[brand][departments][][title]	string	*
data.category[brand][departments][][user_title]	string	*
data.category[brand][departments][][is_tickets_enabled]	boolean	*
data.category[brand][departments][][is_chat_enabled]	boolean	*
data.category[brand][departments][][display_order]	integer	*
data.category[brand][departments][][avatar]	object (Blob)	*
data.category[brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.category[brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.category[brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.category[brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.category[brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.category[brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.category[brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.category[brand][departments][][avatar][authcode]	string	*
data.category[brand][departments][][avatar][blob_hash]	string	*
data.category[brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.category[brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.category[brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.category[brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.category[brand][departments][][avatar][date_created]	DateTime	*
data.category[brand][departments][][avatar][is_temp]	boolean	*
data.category[brand][departments][][avatar][source_ref]	string	*
data.category[brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.category[brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.category[brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.category[brand][departments][][brands][]	array of objects (Brand)	*
data.category[brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.category[brand][departments][][permissions][][department]	integer id (Department)	*
data.category[brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.category[brand][departments][][permissions][][name]	string	*	The name of the permission.
data.category[brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.category[brand][departments][][permissions][][is_active]	boolean	*
data.category[brand][departments][][chat_queue]	object (UserChatQueue)	*
data.category[brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.category[brand][departments][][chat_queue][name]	string	*
data.category[brand][departments][][chat_queue][routing_model]	string	*
data.category[brand][departments][][chat_queue][answer_timeout]	integer	*
data.category[brand][departments][][chat_queue][is_all_agents]	boolean	*
data.category[brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.category[brand][departments][][chat_queue][max_queue_size]	integer	*
data.category[brand][departments][][chat_queue][routingModel]		*
data.category[brand][theme_sets][]	array of objects (ThemeSet)	*
data.category[title]		*
data.revisions[]	array of objects (NewsRevision)	*	Revisions of this news.
data.revisions[][id]	integer	*	The unique ID.
data.revisions[][person]	integer id (Person)	*	Person who made the revision.
data.revisions[][date_created]	DateTime	*	DateTime the revision was created.
data.display_order	integer	*
data.date_end	DateTime	*
data.end_action	string	*
data.content_format	string	*
data.content_data	array	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/news/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

content.news.count

Filters
Response
Status Codes

Name

Information

author

Datatype	string
Pattern	\d+\|me
Description	filter by author, provide an id or 'me' for current user

category

Datatype	integer
Pattern	\d+\|[\d+]
Description	filter category, could be an array or just digit

group_by

Datatype	string
Pattern	author\|category\|period_created\|period_updated
Description	how to group counters

status

Datatype	string
Pattern	published\|archived\|hidden
Description	filter by status

hidden_status

Datatype	integer
Pattern	unpublished\|deleted\|spam\|draft
Description	select for article with given id

period_created

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by period when content was created

period_last_comment

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by period when content was last commented

period_published

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by py period when content was published

period_updated

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by py period when content was updated

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/news/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.news.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/news/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.news.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.attachments[]	array of objects (NewsAttachment)	*
data.attachments[][id]	integer	*
data.attachments[][news]	integer id (News)	*
data.attachments[][person]	integer id (Person)	*	Who created the attachment.
data.attachments[][blob]	object (Blob)	*
data.attachments[][blob][sys_name]	string	*	A unique system name for the blob.
data.attachments[][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.attachments[][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.attachments[][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.attachments[][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.attachments[][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.attachments[][blob][file_url]	string	*	The HTTP link to download the file.
data.attachments[][blob][authcode]	string	*
data.attachments[][blob][blob_hash]	string	*
data.attachments[][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.attachments[][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.attachments[][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.attachments[][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.attachments[][blob][date_created]	DateTime	*
data.attachments[][blob][is_temp]	boolean	*
data.attachments[][blob][source_ref]	string	*
data.attachments[][blob][labels][]	array of objects (LabelBlob)	*
data.attachments[][blob][labels][][blob]	object (Blob)	*
data.labels[]	array of objects (LabelNews)	*	String array of labels associated with this news.
data.labels[][news]	object (News)	*
data.labels[][news][category]	object (NewsCategory)	*
data.labels[][news][category][parent]	object (NewsCategory)	*	Category`s parent.
data.labels[][news][category][children][]	array of objects (NewsCategory)	*	Category`s children.
data.labels[][news][category][articles][]	array of objects (News)	*	Articles belongs this category.
data.labels[][news][category][usergroups][]	array of objects (Usergroup)	*	Usergroups that has access to this category.
data.labels[][news][category][usergroups][][id]	integer	*	The unique ID, DB-generated.
data.labels[][news][category][usergroups][][title]	string	*	Title of the usergroup.
data.labels[][news][category][usergroups][][note]	string	*	A note or description about the usergroup.
data.labels[][news][category][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.labels[][news][category][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.labels[][news][category][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.labels[][news][category][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.labels[][news][category][usergroups][][permissions][][id]	integer	*	The unique ID.
data.labels[][news][category][usergroups][][permissions][][name]	string	*	The name of the permission.
data.labels[][news][category][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.labels[][news][category][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.labels[][news][category][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.labels[][news][category][usergroups][][department_permissions][][department]	integer id (Department)	*
data.labels[][news][category][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.labels[][news][category][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.labels[][news][category][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.labels[][news][category][usergroups][][department_permissions][][is_active]	boolean	*
data.labels[][news][category][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.labels[][news][category][brand]	object (Brand)	*	Brand linked to the category.
data.labels[][news][category][brand][id]	integer	*	The unique ID.
data.labels[][news][category][brand][name]	string	*	The brand name.
data.labels[][news][category][brand][slug]	string	*
data.labels[][news][category][brand][url]	string	*	The brand url.
data.labels[][news][category][brand][theme_set]	object (ThemeSet)	*
data.labels[][news][category][brand][theme_set][id]	integer	*
data.labels[][news][category][brand][theme_set][theme_id]	string	*
data.labels[][news][category][brand][theme_set][title]	string	*
data.labels[][news][category][brand][edit_theme_set]	object (ThemeSet)	*
data.labels[][news][category][brand][departments][]	array of objects (Department)	*
data.labels[][news][category][brand][departments][][id]	integer	*
data.labels[][news][category][brand][departments][][parent]	object (Department)	*
data.labels[][news][category][brand][departments][][children][]	array of objects (Department)	*
data.labels[][news][category][brand][departments][][title]	string	*
data.labels[][news][category][brand][departments][][user_title]	string	*
data.labels[][news][category][brand][departments][][is_tickets_enabled]	boolean	*
data.labels[][news][category][brand][departments][][is_chat_enabled]	boolean	*
data.labels[][news][category][brand][departments][][display_order]	integer	*
data.labels[][news][category][brand][departments][][avatar]	object (Blob)	*
data.labels[][news][category][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.labels[][news][category][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][news][category][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][news][category][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][news][category][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][news][category][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][news][category][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.labels[][news][category][brand][departments][][avatar][authcode]	string	*
data.labels[][news][category][brand][departments][][avatar][blob_hash]	string	*
data.labels[][news][category][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][news][category][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][news][category][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][news][category][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][news][category][brand][departments][][avatar][date_created]	DateTime	*
data.labels[][news][category][brand][departments][][avatar][is_temp]	boolean	*
data.labels[][news][category][brand][departments][][avatar][source_ref]	string	*
data.labels[][news][category][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.labels[][news][category][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.labels[][news][category][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.labels[][news][category][brand][departments][][brands][]	array of objects (Brand)	*
data.labels[][news][category][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.labels[][news][category][brand][departments][][permissions][][department]	integer id (Department)	*
data.labels[][news][category][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.labels[][news][category][brand][departments][][permissions][][name]	string	*	The name of the permission.
data.labels[][news][category][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.labels[][news][category][brand][departments][][permissions][][is_active]	boolean	*
data.labels[][news][category][brand][departments][][chat_queue]	object (UserChatQueue)	*
data.labels[][news][category][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.labels[][news][category][brand][departments][][chat_queue][name]	string	*
data.labels[][news][category][brand][departments][][chat_queue][routing_model]	string	*
data.labels[][news][category][brand][departments][][chat_queue][answer_timeout]	integer	*
data.labels[][news][category][brand][departments][][chat_queue][is_all_agents]	boolean	*
data.labels[][news][category][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.labels[][news][category][brand][departments][][chat_queue][max_queue_size]	integer	*
data.labels[][news][category][brand][theme_sets][]	array of objects (ThemeSet)	*
data.labels[][news][revisions][]	array of objects (NewsRevision)	*	Revisions of this news.
data.labels[][news][revisions][][id]	integer	*	The unique ID.
data.labels[][news][revisions][][person]	integer id (Person)	*	Person who made the revision.
data.labels[][news][revisions][][date_created]	DateTime	*	DateTime the revision was created.
data.labels[][news][attachments][]	array of objects (NewsAttachment)	*
data.labels[][news][labels][]	array of objects (LabelNews)	*	String array of labels associated with this news.
data.labels[][news][display_order]	integer	*
data.labels[][news][date_end]	DateTime	*
data.labels[][news][end_action]	string	*
data.labels[][news][content_format]	string	*
data.labels[][news][content_data]	array	*
data.labels[][news][title]		*
data.labels[][news][content]		*
data.labels[][news][comments]		*
data.labels[][news][status]		*
data.labels[][label]		*
data.title		*
data.content		*
data.comments		*
data.status		*
data.category	object (NewsCategory)	*
data.category[parent]	object (NewsCategory)	*	Category`s parent.
data.category[children][]	array of objects (NewsCategory)	*	Category`s children.
data.category[articles][]	array of objects (News)	*	Articles belongs this category.
data.category[articles][][category]	object (NewsCategory)	*
data.category[articles][][revisions][]	array of objects (NewsRevision)	*	Revisions of this news.
data.category[articles][][revisions][][id]	integer	*	The unique ID.
data.category[articles][][revisions][][person]	integer id (Person)	*	Person who made the revision.
data.category[articles][][revisions][][date_created]	DateTime	*	DateTime the revision was created.
data.category[articles][][attachments][]	array of objects (NewsAttachment)	*
data.category[articles][][attachments][][id]	integer	*
data.category[articles][][attachments][][news]	integer id (News)	*
data.category[articles][][attachments][][person]	integer id (Person)	*	Who created the attachment.
data.category[articles][][attachments][][blob]	object (Blob)	*
data.category[articles][][attachments][][blob][sys_name]	string	*	A unique system name for the blob.
data.category[articles][][attachments][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.category[articles][][attachments][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.category[articles][][attachments][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.category[articles][][attachments][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.category[articles][][attachments][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.category[articles][][attachments][][blob][file_url]	string	*	The HTTP link to download the file.
data.category[articles][][attachments][][blob][authcode]	string	*
data.category[articles][][attachments][][blob][blob_hash]	string	*
data.category[articles][][attachments][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.category[articles][][attachments][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.category[articles][][attachments][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.category[articles][][attachments][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.category[articles][][attachments][][blob][date_created]	DateTime	*
data.category[articles][][attachments][][blob][is_temp]	boolean	*
data.category[articles][][attachments][][blob][source_ref]	string	*
data.category[articles][][attachments][][blob][labels][]	array of objects (LabelBlob)	*
data.category[articles][][attachments][][blob][labels][][blob]	object (Blob)	*
data.category[articles][][labels][]	array of objects (LabelNews)	*	String array of labels associated with this news.
data.category[articles][][labels][][news]	object (News)	*
data.category[articles][][display_order]	integer	*
data.category[articles][][date_end]	DateTime	*
data.category[articles][][end_action]	string	*
data.category[articles][][content_format]	string	*
data.category[articles][][content_data]	array	*
data.category[articles][][title]		*
data.category[articles][][content]		*
data.category[articles][][comments]		*
data.category[articles][][status]		*
data.category[usergroups][]	array of objects (Usergroup)	*	Usergroups that has access to this category.
data.category[usergroups][][id]	integer	*	The unique ID, DB-generated.
data.category[usergroups][][title]	string	*	Title of the usergroup.
data.category[usergroups][][note]	string	*	A note or description about the usergroup.
data.category[usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.category[usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.category[usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.category[usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.category[usergroups][][permissions][][id]	integer	*	The unique ID.
data.category[usergroups][][permissions][][name]	string	*	The name of the permission.
data.category[usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.category[usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.category[usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.category[usergroups][][department_permissions][][department]	integer id (Department)	*
data.category[usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.category[usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.category[usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.category[usergroups][][department_permissions][][is_active]	boolean	*
data.category[usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.category[usergroups][][people][][emails]		*
data.category[usergroups][][people][][labels]		*
data.category[usergroups][][people][][teams]		*
data.category[usergroups][][people][][primary_team]		*
data.category[usergroups][][people][][agentData]		*
data.category[usergroups][][people][][publicUsergroups]		*
data.category[usergroups][][people][][publicAgentgroups]		*
data.category[brand]	object (Brand)	*	Brand linked to the category.
data.category[brand][id]	integer	*	The unique ID.
data.category[brand][name]	string	*	The brand name.
data.category[brand][slug]	string	*
data.category[brand][url]	string	*	The brand url.
data.category[brand][theme_set]	object (ThemeSet)	*
data.category[brand][theme_set][id]	integer	*
data.category[brand][theme_set][theme_id]	string	*
data.category[brand][theme_set][title]	string	*
data.category[brand][theme_set][options]		*
data.category[brand][edit_theme_set]	object (ThemeSet)	*
data.category[brand][departments][]	array of objects (Department)	*
data.category[brand][departments][][id]	integer	*
data.category[brand][departments][][parent]	object (Department)	*
data.category[brand][departments][][children][]	array of objects (Department)	*
data.category[brand][departments][][title]	string	*
data.category[brand][departments][][user_title]	string	*
data.category[brand][departments][][is_tickets_enabled]	boolean	*
data.category[brand][departments][][is_chat_enabled]	boolean	*
data.category[brand][departments][][display_order]	integer	*
data.category[brand][departments][][avatar]	object (Blob)	*
data.category[brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.category[brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.category[brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.category[brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.category[brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.category[brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.category[brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.category[brand][departments][][avatar][authcode]	string	*
data.category[brand][departments][][avatar][blob_hash]	string	*
data.category[brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.category[brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.category[brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.category[brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.category[brand][departments][][avatar][date_created]	DateTime	*
data.category[brand][departments][][avatar][is_temp]	boolean	*
data.category[brand][departments][][avatar][source_ref]	string	*
data.category[brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.category[brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.category[brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.category[brand][departments][][brands][]	array of objects (Brand)	*
data.category[brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.category[brand][departments][][permissions][][department]	integer id (Department)	*
data.category[brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.category[brand][departments][][permissions][][name]	string	*	The name of the permission.
data.category[brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.category[brand][departments][][permissions][][is_active]	boolean	*
data.category[brand][departments][][chat_queue]	object (UserChatQueue)	*
data.category[brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.category[brand][departments][][chat_queue][name]	string	*
data.category[brand][departments][][chat_queue][routing_model]	string	*
data.category[brand][departments][][chat_queue][answer_timeout]	integer	*
data.category[brand][departments][][chat_queue][is_all_agents]	boolean	*
data.category[brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.category[brand][departments][][chat_queue][max_queue_size]	integer	*
data.category[brand][departments][][chat_queue][routingModel]		*
data.category[brand][theme_sets][]	array of objects (ThemeSet)	*
data.category[title]		*
data.revisions[]	array of objects (NewsRevision)	*	Revisions of this news.
data.revisions[][id]	integer	*	The unique ID.
data.revisions[][person]	integer id (Person)	*	Person who made the revision.
data.revisions[][date_created]	DateTime	*	DateTime the revision was created.
data.display_order	integer	*
data.date_end	DateTime	*
data.end_action	string	*
data.content_format	string	*
data.content_data	array	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/news/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.news.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format
title	string	false
content	string	false
person[id]	string	false
person[name]	string	false
person[email]	string	false
person[fieldId]	string	false
person[key]	string	false
language	choice	false
content_input_type	choice	false	["markdown","rte","dped_v1","html"]
status	choice	false	["archived","published","hidden.deleted","hidden.draft","hidden.pending","hidden.spam","hidden.unpublished"]
category	choice	false
date_published	datetime	false	yyyy-MM-dd'T'HH:mm:ss
title_translations[][language]	choice	false
title_translations[][value]	string	false
content_translations[][language]	choice	false
content_translations[][value]	string	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/news_categories CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.news_categories.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (NewsCategory)	*
data[][id]	integer	*	The unique id of the category.
data[][title]	string	*	Category`s title.
data[][title_translations][]	array of objects (Phrase)	*
data[][title_translations][][language]	integer id (Language)	*	The language this phrase belongs to.
data[][title_translations][][value]	string	*
data[][slug]	string	*	Category`s slug.
data[][display_order]	integer	*	Display order.
data[][parent]	integer id (NewsCategory)	*	Category`s parent.
data[][children][]	array of integer ids (NewsCategory)	*	Category`s children.
data[][usergroups][]	array of integer ids (Usergroup)	*	Usergroups that has access to this category.
data[][brand]	integer id (Brand)	*	Brand linked to the category.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/news_categories CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.news_categories.post

Parameters
Response
Status Codes

Parameter	Type	Required?
title	string	true
title_translations[][language]	choice	true
title_translations[][value]	string	true
brand	choice	false
usergroups[]	array of choices	false
parent	choice	false

Parameter	Type	Versions	Description
data.id	integer	*	The unique id of the category.
data.title	string	*	Category`s title.
data.title_translations[]	array of objects (Phrase)	*
data.title_translations[][language]	integer id (Language)	*	The language this phrase belongs to.
data.title_translations[][value]	string	*
data.slug	string	*	Category`s slug.
data.display_order	integer	*	Display order.
data.parent	integer id (NewsCategory)	*	Category`s parent.
data.children[]	array of integer ids (NewsCategory)	*	Category`s children.
data.usergroups[]	array of integer ids (Usergroup)	*	Usergroups that has access to this category.
data.brand	integer id (Brand)	*	Brand linked to the category.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/news_categories/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.news_categories.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/news_categories/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.news_categories.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/news_categories/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.news_categories.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.id	integer	*	The unique id of the category.
data.title	string	*	Category`s title.
data.title_translations[]	array of objects (Phrase)	*
data.title_translations[][language]	integer id (Language)	*	The language this phrase belongs to.
data.title_translations[][value]	string	*
data.slug	string	*	Category`s slug.
data.display_order	integer	*	Display order.
data.parent	integer id (NewsCategory)	*	Category`s parent.
data.children[]	array of integer ids (NewsCategory)	*	Category`s children.
data.usergroups[]	array of integer ids (Usergroup)	*	Usergroups that has access to this category.
data.brand	integer id (Brand)	*	Brand linked to the category.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/news_categories/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.news_categories.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?
title	string	false
title_translations[][language]	choice	false
title_translations[][value]	string	false
brand	choice	false
usergroups[]	array of choices	false
parent	choice	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

POST /api/v2/news_comments CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.comments.news_all_comments.post

Response
Status Codes

Parameter	Type	Versions	Description
data.status	string	*	Comment`s status.
data.id	integer	*	The unique ID.
data.person	integer id (Person)	*	The id of person that wrote this comment.
data.ip_address	string	*	IP address with which comment was written.
data.email	string	*	Person`s email.
data.name	string	*	Person`s name.
data.website	string	*	Website where comment was written.
data.content	string	*	Comment`s content itself.
data.is_reviewed	boolean	*	Has this comment been reviewed by an agent?
data.date_created	DateTime	*	When this comment was created.
data.content_type	string	*	Content Type for this comment.
data.rating	integer	*	Total rating for this comment.
data.news	integer id (News)	*	The news this comment belongs to.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

PUT /api/v2/news_comments/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.comments.news_all_comments.put

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/topics CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

content.topics.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

author

Datatype	string
Pattern	\d+\|me
Description	filter by author, provide an id or 'me' for current user

guide

Datatype	integer
Pattern	\d+\|[\d+]
Description	filter category, could be an array or just digit

group_by

Datatype	string
Pattern	author\|category\|period_created\|period_updated
Description	how to group downloads

status

Datatype	string
Pattern	published\|archived\|hidden
Description	filter by status

hidden_status

Datatype	integer
Pattern	unpublished\|deleted\|spam\|draft
Description	select for article with given id

period_created

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by period when content was created

period_last_comment

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by period when content was last commented

period_published

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by py period when content was published

period_updated

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by py period when content was updated

order_by

Datatype	integer
Pattern	date_created\|date_updated\|person
Description	how to order

Parameter	Type	Versions	Description
data[]	array of objects (Topic)	*
data[][title]		*
data[][content]		*
data[][comments]		*
data[][status]		*
data[][content_input_type]	string	*	The main content originally input type, markdown or HTML.
data[][guide]	object (Guide)	*
data[][guide][id]	integer	*	The unique id of the guide.
data[][guide][title]	string	*	Category's title.
data[][guide][description]	string	*	Category's description.
data[][guide][slug]	string	*
data[][guide][display_order]	integer	*	Display order.
data[][guide][topics][]	array of integer ids (Topic)	*	Manual topics in this manual.
data[][guide][use_volumes]	boolean	*
data[][guide][usergroups][]	array of integer ids (Usergroup)	*	Usergroups that has access to this category.
data[][guide][brand]	integer id (Brand)	*	Brand linked to the category.
data[][guide][color]	string	*
data[][guide][icon_property]	integer id (IconProperty)	*
data[][guide][splash_image_property]	integer id (SplashImageProperty)	*
data[][revisions][]	array of objects (TopicRevision)	*	Revisions of this Manual Topic.
data[][revisions][][id]	integer	*	The unique ID.
data[][revisions][][person]	integer id (Person)	*	Person who made the revision.
data[][revisions][][date_created]	DateTime	*	DateTime the revision was created.
data[][revisions][][topic]	integer id (Topic)	*
data[][revisions][][title]	string	*	Revision title of topic.
data[][revisions][][content]	string	*	Revision content of topic.
data[][display_order]	integer	*	Display order.
data[][parent]	object (Topic)	*	Topic's parent.
data[][parent][content_input_type]	string	*	The main content originally input type, markdown or HTML.
data[][parent][guide]	object (Guide)	*
data[][parent][revisions][]	array of objects (TopicRevision)	*	Revisions of this Manual Topic.
data[][parent][display_order]	integer	*	Display order.
data[][parent][parent]	object (Topic)	*	Topic's parent.
data[][parent][children][]	array of objects (Topic)	*	Topic's children.
data[][parent][no_content]	boolean	*	Topic without content used for structure.
data[][parent][date_end]	DateTime	*
data[][parent][end_action]	string	*
data[][children][]	array of objects (Topic)	*	Topic's children.
data[][no_content]	boolean	*	Topic without content used for structure.
data[][date_end]	DateTime	*
data[][end_action]	string	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/topics CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.topics.post

Parameters
Response
Status Codes

Parameter	Type	Required?	Format
title	string	true
slug	string	false
display_order	string	false
content	string	true
content_input	string	false
content_input_type	choice	false	["rte","markdown"]
title_translations[][language]	choice	true
title_translations[][value]	string	true
content_translations[][language]	choice	true
content_translations[][value]	string	true
status	choice	false	["published","archived","hidden"]
guide	choice	true
parent	choice	false
author[id]	string	false
author[name]	string	false
author[email]	string	false
author[fieldId]	string	false
author[key]	string	false
language	choice	false

Parameter	Type	Versions	Description
data.title		*
data.content		*
data.comments		*
data.status		*
data.content_input_type	string	*	The main content originally input type, markdown or HTML.
data.guide	object (Guide)	*
data.guide[id]	integer	*	The unique id of the guide.
data.guide[title]	string	*	Category's title.
data.guide[description]	string	*	Category's description.
data.guide[slug]	string	*
data.guide[display_order]	integer	*	Display order.
data.guide[topics][]	array of integer ids (Topic)	*	Manual topics in this manual.
data.guide[use_volumes]	boolean	*
data.guide[usergroups][]	array of integer ids (Usergroup)	*	Usergroups that has access to this category.
data.guide[brand]	integer id (Brand)	*	Brand linked to the category.
data.guide[color]	string	*
data.guide[icon_property]	integer id (IconProperty)	*
data.guide[splash_image_property]	integer id (SplashImageProperty)	*
data.revisions[]	array of objects (TopicRevision)	*	Revisions of this Manual Topic.
data.revisions[][id]	integer	*	The unique ID.
data.revisions[][person]	integer id (Person)	*	Person who made the revision.
data.revisions[][date_created]	DateTime	*	DateTime the revision was created.
data.revisions[][topic]	integer id (Topic)	*
data.revisions[][title]	string	*	Revision title of topic.
data.revisions[][content]	string	*	Revision content of topic.
data.display_order	integer	*	Display order.
data.parent	object (Topic)	*	Topic's parent.
data.parent[content_input_type]	string	*	The main content originally input type, markdown or HTML.
data.parent[guide]	object (Guide)	*
data.parent[revisions][]	array of objects (TopicRevision)	*	Revisions of this Manual Topic.
data.parent[display_order]	integer	*	Display order.
data.parent[parent]	object (Topic)	*	Topic's parent.
data.parent[children][]	array of objects (Topic)	*	Topic's children.
data.parent[no_content]	boolean	*	Topic without content used for structure.
data.parent[date_end]	DateTime	*
data.parent[end_action]	string	*
data.parent[title]		*
data.parent[content]		*
data.parent[comments]		*
data.parent[status]		*
data.children[]	array of objects (Topic)	*	Topic's children.
data.no_content	boolean	*	Topic without content used for structure.
data.date_end	DateTime	*
data.end_action	string	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/topics/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

content.topics.count

Filters
Response
Status Codes

Name

Information

author

Datatype	string
Pattern	\d+\|me
Description	filter by author, provide an id or 'me' for current user

guide

Datatype	integer
Pattern	\d+\|[\d+]
Description	filter category, could be an array or just digit

group_by

Datatype	string
Pattern	author\|category\|period_created\|period_updated
Description	how to group counters

status

Datatype	string
Pattern	published\|archived\|hidden
Description	filter by status

hidden_status

Datatype	integer
Pattern	unpublished\|deleted\|spam\|draft
Description	select for article with given id

period_created

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by period when content was created

period_last_comment

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by period when content was last commented

period_published

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by py period when content was published

period_updated

Datatype	integer
Pattern	today\|yesterday\|this_week\|this_month\|last_month\|this_year\|ever
Description	filter by py period when content was updated

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/topics/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.topics.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/topics/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

content.topics.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.title		*
data.content		*
data.comments		*
data.status		*
data.content_input_type	string	*	The main content originally input type, markdown or HTML.
data.guide	object (Guide)	*
data.guide[id]	integer	*	The unique id of the guide.
data.guide[title]	string	*	Category's title.
data.guide[description]	string	*	Category's description.
data.guide[slug]	string	*
data.guide[display_order]	integer	*	Display order.
data.guide[topics][]	array of integer ids (Topic)	*	Manual topics in this manual.
data.guide[use_volumes]	boolean	*
data.guide[usergroups][]	array of integer ids (Usergroup)	*	Usergroups that has access to this category.
data.guide[brand]	integer id (Brand)	*	Brand linked to the category.
data.guide[color]	string	*
data.guide[icon_property]	integer id (IconProperty)	*
data.guide[splash_image_property]	integer id (SplashImageProperty)	*
data.revisions[]	array of objects (TopicRevision)	*	Revisions of this Manual Topic.
data.revisions[][id]	integer	*	The unique ID.
data.revisions[][person]	integer id (Person)	*	Person who made the revision.
data.revisions[][date_created]	DateTime	*	DateTime the revision was created.
data.revisions[][topic]	integer id (Topic)	*
data.revisions[][title]	string	*	Revision title of topic.
data.revisions[][content]	string	*	Revision content of topic.
data.display_order	integer	*	Display order.
data.parent	object (Topic)	*	Topic's parent.
data.parent[content_input_type]	string	*	The main content originally input type, markdown or HTML.
data.parent[guide]	object (Guide)	*
data.parent[revisions][]	array of objects (TopicRevision)	*	Revisions of this Manual Topic.
data.parent[display_order]	integer	*	Display order.
data.parent[parent]	object (Topic)	*	Topic's parent.
data.parent[children][]	array of objects (Topic)	*	Topic's children.
data.parent[no_content]	boolean	*	Topic without content used for structure.
data.parent[date_end]	DateTime	*
data.parent[end_action]	string	*
data.parent[title]		*
data.parent[content]		*
data.parent[comments]		*
data.parent[status]		*
data.children[]	array of objects (Topic)	*	Topic's children.
data.no_content	boolean	*	Topic without content used for structure.
data.date_end	DateTime	*
data.end_action	string	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

Show/hide List Operations Expand Operations

Cryptography

GET /api/v2/crypto/keypairs

Creates a new RSA keypair

Applicable api modes

session token key oauth

Api tags for this endpoint

crypto.key_pairs.post

Response
Status Codes

Parameter	Type	Versions	Description
data.public_key	string	*
data.private_key	string	*

Status Code	Description
200	Returned in case of successful resource creation
500	Returned when keypair generation fails

POST /api/v2/crypto/keypairs

Creates a new RSA keypair

Applicable api modes

session token key oauth

Api tags for this endpoint

crypto.key_pairs.post

Response
Status Codes

Parameter	Type	Versions	Description
data.public_key	string	*
data.private_key	string	*

Status Code	Description
200	Returned in case of successful resource creation
500	Returned when keypair generation fails

GET /api/v2/sign/token

Creates a signed token for the user

Show/hide List Operations Expand Operations

Currencies

GET /api/v2/currencies CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

currencies.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions
data[]	array of objects (Currency)	*
data[][id]	integer	*
data[][currency_code]	string	*
data[][name]	string	*
data[][symbol]	string	*
data[][decimal_places]	integer	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

GET /api/v2/currencies/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

currencies.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

GET /api/v2/currencies/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

currencies.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions
data.id	integer	*
data.currency_code	string	*
data.name	string	*
data.symbol	string	*
data.decimal_places	integer	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

Show/hide List Operations Expand Operations

Departments

GET /api/v2/chat_departments CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.chat_departments.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (Department)	*
data[][id]	integer	*	The unique ID.
data[][parent]	integer id (Department)	*	Parent Department entity.
data[][children][]	array of integer ids (Department)	*	Children Department entity.
data[][title]	string	*	Department`s title.
data[][user_title]	string	*	Given by user Department`s title.
data[][full_title]	string	*	Department`s full title.
data[][is_tickets_enabled]	boolean	*	Are tickets enabled for this Department?
data[][is_chat_enabled]	boolean	*	Are chats enabled for this Department?
data[][display_order]	integer	*	Department display order.
data[][avatar]	object (Avatar)	*	Avatar for this department.
data[][avatar][default_url_pattern]	string	*	Default pattern used if there is no custom one.
data[][avatar][url_pattern]	string	*	Url pattern for avatar gathering.
data[][avatar][base_gravatar_url]	string	*	Url to gravatar.
data[][brands][]	array of integer ids (Brand)	*	Department brands.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/chat_departments CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.chat_departments.post

Parameters
Response
Status Codes

Parameter	Type	Required?
title	string	true
user_title	string	false
parent	choice	false
avatar	string	false
display_order	integer	false
brands[]	array of choices	false

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.parent	integer id (Department)	*	Parent Department entity.
data.children[]	array of integer ids (Department)	*	Children Department entity.
data.title	string	*	Department`s title.
data.user_title	string	*	Given by user Department`s title.
data.full_title	string	*	Department`s full title.
data.is_tickets_enabled	boolean	*	Are tickets enabled for this Department?
data.is_chat_enabled	boolean	*	Are chats enabled for this Department?
data.display_order	integer	*	Department display order.
data.avatar	object (Avatar)	*	Avatar for this department.
data.avatar[default_url_pattern]	string	*	Default pattern used if there is no custom one.
data.avatar[url_pattern]	string	*	Url pattern for avatar gathering.
data.avatar[base_gravatar_url]	string	*	Url to gravatar.
data.brands[]	array of integer ids (Brand)	*	Department brands.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/chat_departments/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.chat_departments.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/chat_departments/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.chat_departments.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/chat_departments/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.chat_departments.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.parent	integer id (Department)	*	Parent Department entity.
data.children[]	array of integer ids (Department)	*	Children Department entity.
data.title	string	*	Department`s title.
data.user_title	string	*	Given by user Department`s title.
data.full_title	string	*	Department`s full title.
data.is_tickets_enabled	boolean	*	Are tickets enabled for this Department?
data.is_chat_enabled	boolean	*	Are chats enabled for this Department?
data.display_order	integer	*	Department display order.
data.avatar	object (Avatar)	*	Avatar for this department.
data.avatar[default_url_pattern]	string	*	Default pattern used if there is no custom one.
data.avatar[url_pattern]	string	*	Url pattern for avatar gathering.
data.avatar[base_gravatar_url]	string	*	Url to gravatar.
data.brands[]	array of integer ids (Brand)	*	Department brands.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/chat_departments/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.chat_departments.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?
title	string	false
user_title	string	false
parent	choice	false
avatar	string	false
display_order	integer	false
brands[]	array of choices	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/chat_departments/{id}/agents

Get agents belongs to department

Applicable api modes

session token key oauth

Api tags for this endpoint

chats.chat_departments.get_agents

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	the id of the department

Parameter	Type	Versions	Description
data[]	array of objects (Person)	*
data[][id]	integer	*	The unique ID of person.
data[][primary_email]	string representation (PersonEmail)	*	Emails belong to user.
data[][first_name]	string	*	The users name (best guess from other sources etc).
data[][last_name]	string	*	The users name (best guess from other sources etc).
data[][title_prefix]	string	*	The users title.
data[][name]	string	*	The users name (best guess from other sources etc).
data[][display_name]	string	*	Person name.
data[][is_agent]	boolean	*	True if person is agent.
data[][avatar]	object (Avatar)	*	Person`s avatar.
data[][avatar][default_url_pattern]	string	*	Default pattern used if there is no custom one.
data[][avatar][url_pattern]	string	*	Url pattern for avatar gathering.
data[][avatar][base_gravatar_url]	string	*	Url to gravatar.
data[][online]	boolean	*	Is user online?
data[][online_for_chat]	boolean	*	Is user online for chat?
data[][last_seen]	DateTime	*	Date when user was last seen online.
data[][agent_data]	object (AgentData)	*	Agent data.
data[][agent_data][extension_number]	integer	*
data[][agent_data][available_status]	string	*
data[][agent_data][agent_calls_enabled]	boolean	*
data[][agent_data][agent_chat_enabled]	boolean	*
data[][agent_data][agent_can_use_forwarding]	boolean	*
data[][agent_data][forwarding_number]	string	*
data[][agent_data][forwarding_ring_timeout]	integer	*
data[][agent_data][forwarding_number_type]	string	*
data[][agent_data][forwarding_logged_out]	boolean	*
data[][agent_data][work_status_enabled]	boolean	*
data[][agent_data][work_status_managed_after]	DateTime	*
data[][agent_data][login_status]	string	*
data[][was_agent]	boolean	*	Was this person an agent?
data[][can_agent]	boolean	*	Is person allowed to use agent interface.
data[][can_admin]	boolean	*	Is person allowed to use admin interface.
data[][can_billing]	boolean	*	Is person allowed to use billing interface.
data[][can_reports]	boolean	*	Is person allowed to use reports interface.
data[][picture_blob]	integer id (Blob)	*	The user`s profile picture.
data[][disable_picture]	boolean	*	True if user`s picture disabled.
data[][gravatar_url]	string	*	The URL to the users gravatar if any.
data[][is_contact]	boolean	*	Is this person a contact?
data[][disable_autoresponses]	boolean	*	Are autoresponses disabled?
data[][disable_autoresponses_log]	string	*	Disabled autoresponses log.
data[][is_confirmed]	boolean	*	Has person confirmed their email?
data[][is_deleted]	boolean	*	Is the user deleted?
data[][is_disabled]	boolean	*	Is the user disabled?
data[][creation_system]	string	*	The way person was created.
data[][override_display_name]	string	*	Overrides the display name of an person in the user interface (agents only).
data[][display_contact]	string	*	Person name and email address.
data[][summary]	string	*	The summary field as filled in by agents.
data[][language]	integer id (Language)	*	Default person`s language.
data[][organization]	integer id (Organization)	*	The person`s organization.
data[][organization_members][]	array of integer ids (OrganizationMember)	*	Organizations the person is member of.
data[][organization_position]	string	*	The persons position at the organization.
data[][organization_manager]	boolean	*	True if the person is a manager of their organization.
data[][timezone]	string	*	The timezone associated with this user.
data[][date_created]	DateTime	*	The date the user was inserted into the system.
data[][date_last_login]	DateTime	*	The date the user was logged in last time.
data[][browser]	string	*	The browser person was used last time.
data[][all_user_groups][]	array of integer ids (Usergroup)	*	Usergroups the user belongs to including through connections like org groups.
data[][user_groups][]	array of integer ids (Usergroup)	*	Usergroups the user belongs to.
data[][agent_groups][]	array of integer ids (Usergroup)	*	Usergroups the user belongs to.
data[][labels][]	array of objects (label)	*	Labels associated with this user.
data[][emails][]	array of string representations (PersonEmail)	*	Emails belong to user.
data[][phone_numbers][]	array of objects (PersonPhoneNumber)	*	Phone numbers belong to user.
data[][phone_numbers][][number]	string	*	The number, stored in E.164 string format, ie. +19021111111.
data[][phone_numbers][][label]	string	*	A human-defined (optional) label to describe what this phone number is.
data[][phone_numbers][][extension]	string	*	An extension for the number - optional.
data[][phone_numbers][][person]	integer id (Person)	*
data[][tickets_count]	integer	*	Overall tickets count assigned to user.
data[][chats_count]	integer	*	Overall count of chats user participating.
data[][fields][]	dynamically declared custom fields (person)	*	Custom persons data.
data[][contextual_options]	custom handler result for (contextual_options)	*	Contextual person options.
data[][contact_data]	array	*	Contacts for this user.
data[][teams][]	array of integer ids (AgentTeam)	*	Agent teams.
data[][primary_team]	integer id (AgentTeam)	*	Primary agent team.
data[][brands][]	array of integer ids (Brand)	*	Brands.
data[][preferences]	array	*	Prefs.

Status Code	Description
200	Returned if everything is OK
404	Returned if department wasn't found

GET /api/v2/ticket_departments CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_departments.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (Department)	*
data[][id]	integer	*	The unique ID.
data[][parent]	integer id (Department)	*	Parent Department entity.
data[][children][]	array of integer ids (Department)	*	Children Department entity.
data[][title]	string	*	Department`s title.
data[][user_title]	string	*	Given by user Department`s title.
data[][full_title]	string	*	Department`s full title.
data[][is_tickets_enabled]	boolean	*	Are tickets enabled for this Department?
data[][is_chat_enabled]	boolean	*	Are chats enabled for this Department?
data[][display_order]	integer	*	Department display order.
data[][avatar]	object (Avatar)	*	Avatar for this department.
data[][avatar][default_url_pattern]	string	*	Default pattern used if there is no custom one.
data[][avatar][url_pattern]	string	*	Url pattern for avatar gathering.
data[][avatar][base_gravatar_url]	string	*	Url to gravatar.
data[][brands][]	array of integer ids (Brand)	*	Department brands.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/ticket_departments CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_departments.post

Parameters
Response
Status Codes

Parameter	Type	Required?
title	string	true
user_title	string	false
parent	choice	false
avatar	string	false
display_order	integer	false
brands[]	array of choices	false

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.parent	integer id (Department)	*	Parent Department entity.
data.children[]	array of integer ids (Department)	*	Children Department entity.
data.title	string	*	Department`s title.
data.user_title	string	*	Given by user Department`s title.
data.full_title	string	*	Department`s full title.
data.is_tickets_enabled	boolean	*	Are tickets enabled for this Department?
data.is_chat_enabled	boolean	*	Are chats enabled for this Department?
data.display_order	integer	*	Department display order.
data.avatar	object (Avatar)	*	Avatar for this department.
data.avatar[default_url_pattern]	string	*	Default pattern used if there is no custom one.
data.avatar[url_pattern]	string	*	Url pattern for avatar gathering.
data.avatar[base_gravatar_url]	string	*	Url to gravatar.
data.brands[]	array of integer ids (Brand)	*	Department brands.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/ticket_departments/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_departments.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/ticket_departments/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_departments.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/ticket_departments/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_departments.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.parent	integer id (Department)	*	Parent Department entity.
data.children[]	array of integer ids (Department)	*	Children Department entity.
data.title	string	*	Department`s title.
data.user_title	string	*	Given by user Department`s title.
data.full_title	string	*	Department`s full title.
data.is_tickets_enabled	boolean	*	Are tickets enabled for this Department?
data.is_chat_enabled	boolean	*	Are chats enabled for this Department?
data.display_order	integer	*	Department display order.
data.avatar	object (Avatar)	*	Avatar for this department.
data.avatar[default_url_pattern]	string	*	Default pattern used if there is no custom one.
data.avatar[url_pattern]	string	*	Url pattern for avatar gathering.
data.avatar[base_gravatar_url]	string	*	Url to gravatar.
data.brands[]	array of integer ids (Brand)	*	Department brands.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/ticket_departments/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_departments.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?
title	string	false
user_title	string	false
parent	choice	false
avatar	string	false
display_order	integer	false
brands[]	array of choices	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/ticket_departments/{id}/agents

Get agents belongs to department

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_departments.get_agents

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	the id of the department

Parameter	Type	Versions	Description
data[]	array of objects (Person)	*
data[][id]	integer	*	The unique ID of person.
data[][primary_email]	string representation (PersonEmail)	*	Emails belong to user.
data[][first_name]	string	*	The users name (best guess from other sources etc).
data[][last_name]	string	*	The users name (best guess from other sources etc).
data[][title_prefix]	string	*	The users title.
data[][name]	string	*	The users name (best guess from other sources etc).
data[][display_name]	string	*	Person name.
data[][is_agent]	boolean	*	True if person is agent.
data[][avatar]	object (Avatar)	*	Person`s avatar.
data[][avatar][default_url_pattern]	string	*	Default pattern used if there is no custom one.
data[][avatar][url_pattern]	string	*	Url pattern for avatar gathering.
data[][avatar][base_gravatar_url]	string	*	Url to gravatar.
data[][online]	boolean	*	Is user online?
data[][online_for_chat]	boolean	*	Is user online for chat?
data[][last_seen]	DateTime	*	Date when user was last seen online.
data[][agent_data]	object (AgentData)	*	Agent data.
data[][agent_data][extension_number]	integer	*
data[][agent_data][available_status]	string	*
data[][agent_data][agent_calls_enabled]	boolean	*
data[][agent_data][agent_chat_enabled]	boolean	*
data[][agent_data][agent_can_use_forwarding]	boolean	*
data[][agent_data][forwarding_number]	string	*
data[][agent_data][forwarding_ring_timeout]	integer	*
data[][agent_data][forwarding_number_type]	string	*
data[][agent_data][forwarding_logged_out]	boolean	*
data[][agent_data][work_status_enabled]	boolean	*
data[][agent_data][work_status_managed_after]	DateTime	*
data[][agent_data][login_status]	string	*
data[][was_agent]	boolean	*	Was this person an agent?
data[][can_agent]	boolean	*	Is person allowed to use agent interface.
data[][can_admin]	boolean	*	Is person allowed to use admin interface.
data[][can_billing]	boolean	*	Is person allowed to use billing interface.
data[][can_reports]	boolean	*	Is person allowed to use reports interface.
data[][picture_blob]	integer id (Blob)	*	The user`s profile picture.
data[][disable_picture]	boolean	*	True if user`s picture disabled.
data[][gravatar_url]	string	*	The URL to the users gravatar if any.
data[][is_contact]	boolean	*	Is this person a contact?
data[][disable_autoresponses]	boolean	*	Are autoresponses disabled?
data[][disable_autoresponses_log]	string	*	Disabled autoresponses log.
data[][is_confirmed]	boolean	*	Has person confirmed their email?
data[][is_deleted]	boolean	*	Is the user deleted?
data[][is_disabled]	boolean	*	Is the user disabled?
data[][creation_system]	string	*	The way person was created.
data[][override_display_name]	string	*	Overrides the display name of an person in the user interface (agents only).
data[][display_contact]	string	*	Person name and email address.
data[][summary]	string	*	The summary field as filled in by agents.
data[][language]	integer id (Language)	*	Default person`s language.
data[][organization]	integer id (Organization)	*	The person`s organization.
data[][organization_members][]	array of integer ids (OrganizationMember)	*	Organizations the person is member of.
data[][organization_position]	string	*	The persons position at the organization.
data[][organization_manager]	boolean	*	True if the person is a manager of their organization.
data[][timezone]	string	*	The timezone associated with this user.
data[][date_created]	DateTime	*	The date the user was inserted into the system.
data[][date_last_login]	DateTime	*	The date the user was logged in last time.
data[][browser]	string	*	The browser person was used last time.
data[][all_user_groups][]	array of integer ids (Usergroup)	*	Usergroups the user belongs to including through connections like org groups.
data[][user_groups][]	array of integer ids (Usergroup)	*	Usergroups the user belongs to.
data[][agent_groups][]	array of integer ids (Usergroup)	*	Usergroups the user belongs to.
data[][labels][]	array of objects (label)	*	Labels associated with this user.
data[][emails][]	array of string representations (PersonEmail)	*	Emails belong to user.
data[][phone_numbers][]	array of objects (PersonPhoneNumber)	*	Phone numbers belong to user.
data[][phone_numbers][][number]	string	*	The number, stored in E.164 string format, ie. +19021111111.
data[][phone_numbers][][label]	string	*	A human-defined (optional) label to describe what this phone number is.
data[][phone_numbers][][extension]	string	*	An extension for the number - optional.
data[][phone_numbers][][person]	integer id (Person)	*
data[][tickets_count]	integer	*	Overall tickets count assigned to user.
data[][chats_count]	integer	*	Overall count of chats user participating.
data[][fields][]	dynamically declared custom fields (person)	*	Custom persons data.
data[][contextual_options]	custom handler result for (contextual_options)	*	Contextual person options.
data[][contact_data]	array	*	Contacts for this user.
data[][teams][]	array of integer ids (AgentTeam)	*	Agent teams.
data[][primary_team]	integer id (AgentTeam)	*	Primary agent team.
data[][brands][]	array of integer ids (Brand)	*	Brands.
data[][preferences]	array	*	Prefs.

Status Code	Description
200	Returned if everything is OK
404	Returned if department wasn't found

Show/hide List Operations Expand Operations

Download

POST /api/v2/downloads/{download}/icon

set Icon

Documentation

Set icon for download.

Applicable api modes

session token key oauth

Api tags for this endpoint

content.downloads.set_icon

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
download	\d+	integer	the id of download

Parameter	Type	Required?
urn	string	true
style	string	true
color	string	true

Status Code	Description
200	Returned if everything is OK

Show/hide List Operations Expand Operations

Downloads

POST /api/v2/download_comments/{download}/rate

rate download comment

Documentation

Rate download.

Applicable api modes

session token key oauth

Api tags for this endpoint

content.comments.downloads_all_comments.rate_download_content

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
downloads	\d+	integer	the id of download
download		DownloadComment

Parameter	Type	Required?	Format	Description
upvote	choice	true	[0,1]

Status Code	Description
200	Returned if everything is OK

POST /api/v2/downloads/{download}/splash_image

set Splash Image

Documentation

Set splash image for downloads.

Applicable api modes

session token key oauth

Api tags for this endpoint

content.downloads.select_splash_image

Requirements
Status Codes

Name	Requirement	Type	Description
downloads	\d+	integer	the id of downloads
download

Status Code	Description
200	Returned if everything is OK

POST /api/v2/downloads/{download}/splash_image_upload

Upload Splash Image For Download

Applicable api modes

session token key oauth

Api tags for this endpoint

content.downloads.upload_splash_image

Requirements
Status Codes

Name	Requirement	Type	Description
download	\d+	integer	the id of download

Status Code	Description
200	Returned if everything is OK

Show/hide List Operations Expand Operations

Email Templates

DELETE /api/v2/email_templates/email_assets/{id} CRUD

Delete an email asset

Documentation

Obviously it's an ability to erase what you've done. Be careful there is no CTRL+Z shortcut.

Applicable api modes

session token key oauth

Api tags for this endpoint

email_templates.assets.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the asset

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either asset already deleted either it doesn't exists at all

GET /api/v2/email_templates/email_assets/{type} CRUD

Add a new asset

Applicable api modes

session token key oauth

Api tags for this endpoint

email_templates.assets.list

Requirements
Response

Name	Requirement	Type	Description
type		string	The asset type 'inline-image' or 'attachment'

Parameter	Type	Versions	Description
data[]	array of objects (Blob)	*
data[][authcode]	string	*
data[][labels][]	array of objects (LabelBlob)	*
data[][labels][][blob]	object (Blob)	*
data[][sys_name]	string	*	A unique system name for the blob.
data[][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][original_blob][sys_name]	string	*	A unique system name for the blob.
data[][original_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][original_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][original_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][original_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][original_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][original_blob][file_url]	string	*	The HTTP link to download the file.
data[][original_blob][authcode]	string	*
data[][original_blob][blob_hash]	string	*
data[][original_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][original_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][original_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][original_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][original_blob][date_created]	DateTime	*
data[][original_blob][is_temp]	boolean	*
data[][original_blob][source_ref]	string	*
data[][original_blob][labels][]	array of objects (LabelBlob)	*
data[][original_blob][labels][][blob]	object (Blob)	*
data[][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][save_path]	string	*	The path to the file if it's not stored in the database.
data[][file_url]	string	*	The HTTP link to download the file.
data[][blob_hash]	string	*
data[][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][date_created]	DateTime	*
data[][is_temp]	boolean	*
data[][source_ref]	string	*

POST /api/v2/email_templates/email_assets/{type} CRUD

Add a new asset

Applicable api modes

session token key oauth

Api tags for this endpoint

email_templates.assets.post

Requirements
Response

Name	Requirement	Type	Description
type		string	The asset type 'inline-image' or 'attachment'

Parameter	Type	Versions	Description
data.authcode	string	*
data.labels[]	array of objects (LabelBlob)	*
data.labels[][blob]	object (Blob)	*
data.labels[][blob][sys_name]	string	*	A unique system name for the blob.
data.labels[][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][blob][file_url]	string	*	The HTTP link to download the file.
data.labels[][blob][authcode]	string	*
data.labels[][blob][blob_hash]	string	*
data.labels[][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][blob][date_created]	DateTime	*
data.labels[][blob][is_temp]	boolean	*
data.labels[][blob][source_ref]	string	*
data.labels[][blob][labels][]	array of objects (LabelBlob)	*
data.labels[][label]		*
data.sys_name	string	*	A unique system name for the blob.
data.original_blob	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.original_blob[sys_name]	string	*	A unique system name for the blob.
data.original_blob[original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.original_blob[storage_loc]	string	*	The storage adapter that knows how to load this file.
data.original_blob[storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.original_blob[storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.original_blob[save_path]	string	*	The path to the file if it's not stored in the database.
data.original_blob[file_url]	string	*	The HTTP link to download the file.
data.original_blob[authcode]	string	*
data.original_blob[blob_hash]	string	*
data.original_blob[is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.original_blob[title]	string	*	The title of this file used in interfaces if its a media upload.
data.original_blob[dim_w]	integer	*	If this type of file has dimentions, the width.
data.original_blob[dim_h]	integer	*	If this type of file has dimentions, the height.
data.original_blob[date_created]	DateTime	*
data.original_blob[is_temp]	boolean	*
data.original_blob[source_ref]	string	*
data.original_blob[labels][]	array of objects (LabelBlob)	*
data.original_blob[labels][][blob]	object (Blob)	*
data.storage_loc	string	*	The storage adapter that knows how to load this file.
data.storage_loc_pref	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.storage_loc_specific	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.save_path	string	*	The path to the file if it's not stored in the database.
data.file_url	string	*	The HTTP link to download the file.
data.blob_hash	string	*
data.is_media_upload	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.title	string	*	The title of this file used in interfaces if its a media upload.
data.dim_w	integer	*	If this type of file has dimentions, the width.
data.dim_h	integer	*	If this type of file has dimentions, the height.
data.date_created	DateTime	*
data.is_temp	boolean	*
data.source_ref	string	*

GET /api/v2/email_templates/info

get templates

DELETE /api/v2/email_templates/legacy_template/{id}

Delete legacy template

GET /api/v2/email_templates/legacy_templates
- Get legacy templates to upgrade
Applicable api modes
session token key oauth
Api tags for this endpoint
email_templates.template.get_legacy_templates

GET /api/v2/email_templates/mark_as_converted/{name}

Mark a legacy template as converted

POST /api/v2/email_templates/render_template unstable
- Render a template to preview
Applicable api modes
session token key oauth
Api tags for this endpoint
email_templates.template.post_render_template

GET /api/v2/email_templates/revert_legacy_template/{id}

Revert legacy template to hardcoded template

POST /api/v2/email_templates/send_preview unstable
- Send preview of a template
Applicable api modes
session token key oauth
Api tags for this endpoint
email_templates.template.post_send_preview_email

DELETE /api/v2/email_templates/template/{name} unstable

Delete a custom template and retrieve the original one

GET /api/v2/email_templates/template/{name}

Retrieve a template

POST /api/v2/email_templates/template/{name} unstable

Save a template

Applicable api modes

session token key oauth

Api tags for this endpoint

email_templates.template.set_template

Requirements
Parameters

Name	Requirement	Type	Description
name		string	The template name

Parameter	Type	Required?
subject	string	true
body	string	true
create_new	string	false

GET /api/v2/email_templates/view_model/variables/{className} unstable

list of a variables available for a view model

DELETE /api/v2/portal_templates/legacy_template/{id}

Delete legacy template

GET /api/v2/portal_templates/legacy_templates
- Get legacy templates to upgrade
Applicable api modes
session token key oauth
Api tags for this endpoint
portal_interface.template.get_legacy_templates
POST /api/v2/portal_templates/render_template unstable
- Render a template to preview
Applicable api modes
session token key oauth
Api tags for this endpoint
portal_interface.template.post_render_template

GET /api/v2/portal_templates/revert_legacy_template/{id}

Revert legacy template to hardcoded template

POST /api/v2/portal_templates/send_preview unstable
- Send preview of a template
Applicable api modes
session token key oauth
Api tags for this endpoint
portal_interface.template.post_send_preview_email

DELETE /api/v2/portal_templates/template/{brandId}/{name} unstable

Delete a custom template and retrieve the original one

DELETE /api/v2/portal_templates/template/{name} unstable

Delete a custom template and retrieve the original one

GET /api/v2/portal_templates/template/{name}

Retrieve a template

POST /api/v2/portal_templates/template/{name} unstable

Save a template

Applicable api modes

session token key oauth

Api tags for this endpoint

portal_interface.template.set_template

Requirements
Parameters

Name	Requirement	Type	Description
name		string	The template name

Parameter	Type	Required?
subject	string	true
body	string	true
create_new	string	false

Show/hide List Operations Expand Operations

Email accounts

GET /api/v2/email_accounts CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

email_accounts.email_accounts.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (EmailAccount)	*
data[][id]	integer	*
data[][account_type]	string	*
data[][is_enabled]	boolean	*
data[][address]	string	*
data[][cert_blob]	object (Blob)	*
data[][cert_blob][sys_name]	string	*	A unique system name for the blob.
data[][cert_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][cert_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][cert_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][cert_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][cert_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][cert_blob][file_url]	string	*	The HTTP link to download the file.
data[][cert_blob][authcode]	string	*
data[][cert_blob][blob_hash]	string	*
data[][cert_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][cert_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][cert_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][cert_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][cert_blob][date_created]	DateTime	*
data[][cert_blob][is_temp]	boolean	*
data[][cert_blob][source_ref]	string	*
data[][cert_blob][labels][]	array of objects (LabelBlob)	*
data[][cert_blob][labels][][blob]	object (Blob)	*
data[][key_blob]	object (Blob)	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

DELETE /api/v2/email_accounts/{id}/certificate

Delete a certificate

Documentation

Get resource with provided id.

Applicable api modes

session token key oauth

Api tags for this endpoint

email_accounts.email_accounts.delete_certificate

Requirements
Status Codes

Name	Requirement	Type	Description
id	default\|\d+	integer	The id of the email account

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

POST /api/v2/email_accounts/{id}/encryption

Upload a certificate and a key

Documentation

Get resource with provided id.

Applicable api modes

session token key oauth

Api tags for this endpoint

email_accounts.email_accounts.upload_certificate

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	default\|\d+	integer	The id of the email account

Parameter	Type	Versions	Description
data.id	integer	*
data.account_type	string	*
data.is_enabled	boolean	*
data.address	string	*
data.cert_blob	object (Blob)	*
data.cert_blob[sys_name]	string	*	A unique system name for the blob.
data.cert_blob[original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.cert_blob[storage_loc]	string	*	The storage adapter that knows how to load this file.
data.cert_blob[storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.cert_blob[storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.cert_blob[save_path]	string	*	The path to the file if it's not stored in the database.
data.cert_blob[file_url]	string	*	The HTTP link to download the file.
data.cert_blob[authcode]	string	*
data.cert_blob[blob_hash]	string	*
data.cert_blob[is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.cert_blob[title]	string	*	The title of this file used in interfaces if its a media upload.
data.cert_blob[dim_w]	integer	*	If this type of file has dimentions, the width.
data.cert_blob[dim_h]	integer	*	If this type of file has dimentions, the height.
data.cert_blob[date_created]	DateTime	*
data.cert_blob[is_temp]	boolean	*
data.cert_blob[source_ref]	string	*
data.cert_blob[labels][]	array of objects (LabelBlob)	*
data.cert_blob[labels][][blob]	object (Blob)	*
data.key_blob	object (Blob)	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

DELETE /api/v2/email_accounts/{id}/key

Delete a key

Documentation

Get resource with provided id.

Applicable api modes

session token key oauth

Api tags for this endpoint

email_accounts.email_accounts.delete_key

Requirements
Status Codes

Name	Requirement	Type	Description
id	default\|\d+	integer	The id of the email account

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

Show/hide List Operations Expand Operations

External events

DELETE /api/v2/external_events/popup/dismiss/{uuid}

An endpoint to dismiss previously raised popup.

Documentation

An endpoint to dismiss previously raised popup.

Applicable api modes

session token key oauth

Api tags for this endpoint

external_events.popup.dismiss

Requirements
Status Codes

Name	Requirement	Type	Description
uuid		string

Status Code	Description
200	Returned if everything is ok

POST /api/v2/external_events/popup/raise

Raise a popup with given parameters.

Documentation

Raise a popup with given parameters.

Applicable api modes

session token key oauth

Api tags for this endpoint

external_events.popup.raise

Parameters
Status Codes

Parameter	Type	Required?	Format
external_id	string	false
target[type]	choice	true	["list","query"]
display[][type]	choice	true	["html","person","organization","ticket"]
actions[][type]	choice	true	["dismiss","create_ticket","webhook"]
actions[][title]	string	true

Status Code	Description
200	Returned if everything is ok

POST /api/v2/external_events/popup/webhook

Just a callback action for webhook in popup.

Documentation

Just a callback action for webhook in popup.

Applicable api modes

session token key oauth

Api tags for this endpoint

external_events.popup.webhook

Parameters
Status Codes

Parameter	Type	Required?	Format
url	string	true
type	choice	true	["POST","GET","DELETE","PUT"]
title	string	true
data	string	true

Status Code	Description
200	Returned if everything is ok

Show/hide List Operations Expand Operations

Glossary

GET /api/v2/glossary CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

glossary.glossary.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (GlossaryWordDefinition)	*
data[][definition]	string	*	Word definition itself.
data[][id]	integer	*	The unique id.
data[][words][]	array of string representations (GlossaryWord)	*	An array of words belongs this definition.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/glossary CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

glossary.glossary.post

Parameters
Response
Status Codes

Parameter	Type	Required?
definition	string	true
words[][word]	string	true
words[][definition]	choice	true

Parameter	Type	Versions	Description
data.definition	string	*	Word definition itself.
data.id	integer	*	The unique id.
data.words[]	array of string representations (GlossaryWord)	*	An array of words belongs this definition.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/glossary/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

glossary.glossary.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

GET /api/v2/glossary/words CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

glossary.glossary_word.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (GlossaryWord)	*
data[][word]	string	*	The word itself.
data[][definition]	string representation (GlossaryWordDefinition)	*	This word definition string representation.
data[][id]	integer	*	The unique word ID.
data[][brand]	integer id (Brand)	*	Brand linked to the glossary word.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/glossary/words CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

glossary.glossary_word.post

Parameters
Response
Status Codes

Parameter	Type	Required?	Format	Description
word	string	true
definition	choice	true

Parameter	Type	Versions	Description
data.word	string	*	The word itself.
data.definition	string representation (GlossaryWordDefinition)	*	This word definition string representation.
data.id	integer	*	The unique word ID.
data.brand	integer id (Brand)	*	Brand linked to the glossary word.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/glossary/words/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

glossary.glossary_word.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/glossary/words/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

glossary.glossary_word.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/glossary/words/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

glossary.glossary_word.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.word	string	*	The word itself.
data.definition	string representation (GlossaryWordDefinition)	*	This word definition string representation.
data.id	integer	*	The unique word ID.
data.brand	integer id (Brand)	*	Brand linked to the glossary word.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/glossary/words/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

glossary.glossary_word.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format	Description
word	string	false
definition	choice	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/glossary/words/{word}

Get a definition of the word

Documentation

You can try to search the word and it's definition.

Applicable api modes

session token key oauth

Api tags for this endpoint

glossary.glossary_word.get_by_string

Requirements
Response
Status Codes

Name	Requirement	Type	Description
word	\w+	string	The word

Parameter	Type	Versions	Description
data.word	string	*	The word itself.
data.definition	string representation (GlossaryWordDefinition)	*	This word definition string representation.
data.id	integer	*	The unique word ID.
data.brand	integer id (Brand)	*	Brand linked to the glossary word.

Status Code	Description
200	All looks good, we found what you want
404	Sorry we can find nothing with given parameters

DELETE /api/v2/glossary/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

glossary.glossary.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/glossary/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

glossary.glossary.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.definition	string	*	Word definition itself.
data.id	integer	*	The unique id.
data.words[]	array of string representations (GlossaryWord)	*	An array of words belongs this definition.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/glossary/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

glossary.glossary.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?
definition	string	false
words[][word]	string	false
words[][definition]	choice	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

Show/hide List Operations Expand Operations

Guide

POST /api/v2/guides/{guide}/icon

set Icon

Documentation

Set icon for guide.

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.guide.set_icon

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
guide	\d+	integer	the id of guide

Parameter	Type	Required?
urn	string	true
style	string	true
color	string	true

Status Code	Description
200	Returned if everything is OK

POST /api/v2/guides_comments/{comment}/rate

rate guide comment

Documentation

Rate guide comment.

Applicable api modes

session token key oauth

Api tags for this endpoint

content.comments.guides_all_comments.rate_guide_content

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
guide	\d+	integer	the id of guide comment
comment		TopicComment

Parameter	Type	Required?	Format	Description
upvote	choice	true	[0,1]

Status Code	Description
200	Returned if everything is OK

Show/hide List Operations Expand Operations

Guides

POST /api/v2/guides/{guide}/splash_image

set Splash Image

Documentation

Set splash image for guide.

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.guide.select_splash_image

Requirements
Status Codes

Name	Requirement	Type	Description
forum	\d+	integer	the id of guide
guide		Guide

Status Code	Description
200	Returned if everything is OK

POST /api/v2/guides/{guide}/splash_image_upload

Upload Guide Splash Image

Applicable api modes

session token key oauth

Api tags for this endpoint

content.categories.guide.upload_splash_image

Requirements
Status Codes

Name	Requirement	Type	Description
guide	\d+	integer	the id of guide

Status Code	Description
200	Returned if everything is OK

Show/hide List Operations Expand Operations

Helpdesk

GET /api/v2/helpdesk/agent-client/info

Used by apps when they need to know general information about a helpdesk such as which features are enabled

Documentation

Used by apps when they need to know general information about a helpdesk such as which features are enabled.

Applicable api modes

session token key oauth

Api tags for this endpoint

helpdesk.discovery.agent_client_info

Response
Status Codes

Parameter	Type	Versions	Description
data.settings	object (CoreSettings)	*
data.settings[multi_lang]	boolean	*
data.settings[brands]	boolean	*
data.settings[helpdesk_name]	string	*
data.settings[attachments]	object (AttachmentsSettings)	*
data.settings[attachments][agents]	object (AttachmentSettings)	*
data.settings[attachments][agents][max_size]	integer	*
data.settings[attachments][agents][whitelist][]	array of strings	*
data.settings[attachments][agents][blacklist][]	array of strings	*
data.settings[date]	object (DateSettings)	*
data.settings[features][]	array of strings	*
data.account_info	object (AccountInfo)	*
data.account_info[timezone]	string	*
data.account_info[language]	integer id (Language)	*	Default person`s language.
data.account_info[signature_html]	string	*
data.chat	object (ChatSettings)	*
data.chat[enabled]	boolean	*	True of enabled.
data.chat[permissions]	object (ChatPermissionSettings)	*
data.chat[permissions][view_transcripts]	boolean	*
data.chat[permissions][view_unassigned]	boolean	*
data.chat[permissions][view_others]	boolean	*
data.chat[permissions][create_labels]	boolean	*
data.chat[permissions][delete]	boolean	*
data.crm	object (CRMSettings)	*
data.crm[enabled]	boolean	*	True of enabled.
data.crm[permissions]	object (CRMPermissionSettings)	*
data.crm[permissions][person]	object (CRMPeoplePermissionSettings)	*
data.crm[permissions][person][create]	boolean	*
data.crm[permissions][person][edit]	boolean	*
data.crm[permissions][person][validate]	boolean	*
data.crm[permissions][person][manage_emails]	boolean	*
data.crm[permissions][person][reset_password]	boolean	*
data.crm[permissions][person][create_labels]	boolean	*
data.crm[permissions][person][notes]	boolean	*
data.crm[permissions][person][delete]	boolean	*
data.crm[permissions][person][disable]	boolean	*
data.crm[permissions][person][login_as]	boolean	*
data.crm[permissions][person][merge]	boolean	*
data.crm[permissions][organization]	object (CRMOrganizationPermissionSettings)	*
data.crm[permissions][organization][create]	boolean	*
data.crm[permissions][organization][edit]	boolean	*
data.crm[permissions][organization][notes]	boolean	*
data.crm[permissions][organization][create_labels]	boolean	*
data.crm[permissions][organization][delete]	boolean	*
data.community	object (CommunitySettings)	*
data.community[enabled]	boolean	*	True of enabled.
data.community[permissions]	object (CommunityPermissionSettings)	*
data.community[permissions][create_labels]	boolean	*
data.publish	object (PublishSettings)	*
data.publish[enabled]	boolean	*	True of enabled.
data.publish[permissions]	object (PublishPermissionSettings)	*
data.publish[permissions][use]	boolean	*
data.publish[permissions][create]	boolean	*
data.publish[permissions][delete]	boolean	*
data.publish[permissions][edit]	boolean	*
data.publish[permissions][can_insert_html]	boolean	*
data.publish[permissions][validate]	boolean	*
data.tasks	object (TasksSettings)	*
data.tasks[enabled]	boolean	*	True of enabled.
data.tickets	object (TicketsSettings)	*
data.tickets[enabled]	boolean	*	True of enabled.
data.tickets[ref_code]	string	*
data.tickets[archiving]	boolean	*
data.tickets[field_info]	object (TicketFieldsInfoSettings)	*
data.tickets[field_info][product]	object (TicketFieldInfoSettings)	*
data.tickets[field_info][product][default_id]	integer	*
data.tickets[field_info][product][enabled]	boolean	*	True of enabled.
data.tickets[field_info][category]	object (TicketFieldInfoSettings)	*
data.tickets[field_info][workflow]	object (TicketFieldInfoSettings)	*
data.tickets[field_info][priority]	object (TicketFieldInfoSettings)	*
data.tickets[field_info][custom]	object (TicketCustomFieldInfoSettings)	*
data.tickets[field_info][custom][has_any]	boolean	*
data.tickets[billing]	object (TicketBillingSettings)	*
data.tickets[billing][currency_name]	string	*
data.tickets[billing][enabled]	boolean	*	True of enabled.
data.tickets[timelog]	object (TicketTimelogSettings)	*
data.tickets[timelog][enabled]	boolean	*	True of enabled.
data.tickets[group_fields][]	array of objects (TicketGroupFieldSettings)	*
data.tickets[group_fields][][id]	string	*
data.tickets[group_fields][][type]	string	*
data.tickets[group_fields][][field_id]	integer	*
data.tickets[order_fields][]	array of objects (TicketOrderFieldSettings)	*
data.tickets[order_fields][][id]	string	*
data.tickets[order_fields][][type]	string	*
data.tickets[permissions]	object (TicketPermissionSettings)	*
data.tickets[permissions][create]	boolean	*
data.tickets[permissions][reply_mass]	boolean	*
data.tickets[permissions][modify_set_archived]	boolean	*
data.tickets[permissions][create_labels]	boolean	*
data.tickets[permissions][modify]	object (TicketModifyPermissionSettings)	*
data.tickets[permissions][modify][own]	object (TicketModifyPermissionGroupSettings)	*
data.tickets[permissions][modify][own][view]	boolean	*
data.tickets[permissions][modify][own][reply]	boolean	*
data.tickets[permissions][modify][own][modify]	boolean	*
data.tickets[permissions][modify][own][modify_messages]	boolean	*
data.tickets[permissions][modify][own][delete]	boolean	*
data.tickets[permissions][modify][following]	object (TicketModifyPermissionGroupSettings)	*
data.tickets[permissions][modify][unassing]	object (TicketModifyPermissionGroupSettings)	*
data.tickets[permissions][modify][others]	object (TicketModifyPermissionGroupSettings)	*
data.tickets[ticket_statuses][]	array of objects (TicketStatus)	*
data.tickets[ticket_statuses][][id]	integer	*
data.tickets[ticket_statuses][][status_type]	string	*
data.tickets[ticket_statuses][][status_code]	string	*
data.tickets[ticket_statuses][][sys_id]	string	*
data.tickets[ticket_statuses][][title]	string	*
data.tickets[ticket_statuses][][display_order]	integer	*
data.tickets[ticket_statuses][][pending_waiting_time_mode]	string	*	Where to count time spending in pending status. Check PENDING_WAITING_TIME_MODE_ constants
data.tickets[ticket_statuses][][children][]	array of objects (TicketStatus)	*
data.tickets[ticket_statuses][][options]	array	*
data.tickets[ticket_statuses][][statusType]		*
data.tickets[ticket_statuses][][displayOrder]	integer	*

Status Code	Description
200	Success

GET /api/v2/helpdesk/agent-client/settings unstable

Get current user personal settings

GET /api/v2/helpdesk/discover

Used by apps to detect that this is a real helpdesk

Documentation

Used by apps to detect that this is a real helpdesk.

Applicable api modes

session token key oauth

Api tags for this endpoint

helpdesk.discovery.discover

Response
Status Codes

Parameter	Type	Versions
data.helpdesk_uuid	string	*
data.is_deskpro	boolean	*
data.is_cloud	boolean	*
data.helpdesk_url	string	*
data.base_api_url	string	*
data.build	string	*
data.build_id	integer	*
data.build_name	string	*
data.version	string	*
data.apps_oauth_proxy_url	string	*
data.apps_http_proxy_url	string	*
data.requirements	array	*
data.build_info	array	*

Status Code	Description
200	Success

POST /api/v2/helpdesk/updater/manual-schedule unstable

Manually schedule an upgrade to run right now

Applicable api modes

session token key oauth

Api tags for this endpoint

helpdesk.updater.manual_schedule

Parameters
Status Codes

Parameter	Type	Required?	Format	Description
	integer	false		delay before start

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/helpdesk/updater/settings unstable

Get the updater settings

Applicable api modes

session token key oauth

Api tags for this endpoint

helpdesk.updater.updater_settings

Response
Status Codes

Parameter	Type	Versions
data.is_enabled	boolean	*
data.interval_days	integer	*
data.time_of_day	string	*
data.timezone	string representation (DateTimeZone)	*

Status Code	Description
200	Success

PUT /api/v2/helpdesk/updater/settings unstable

Set updater settings

Applicable api modes

session token key oauth

Api tags for this endpoint

helpdesk.updater.put

Parameters
Status Codes

Parameter	Type	Required?	Format
is_enabled	boolean	false
interval_days	float	false
time_of_day	string	false
timezone	choice	false	{"Africa":{"Abidjan":"Africa\/Abidjan","Accra":"Africa\/Accra","Addis Ababa":"Africa\/Addis_Ababa","Algiers":"Africa\/Algiers","Asmara":"Africa\/Asmara","Bamako":"Africa\/Bamako","Bangui":"Africa\/Bangui","Banjul":"Africa\/Banjul","Bissau":"Africa\/Bissau","Blantyre":"Africa\/Blantyre","Brazzaville":"Africa\/Brazzaville","Bujumbura":"Africa\/Bujumbura","Cairo":"Africa\/Cairo","Casablanca":"Africa\/Casablanca","Ceuta":"Africa\/Ceuta","Conakry":"Africa\/Conakry","Dakar":"Africa\/Dakar","Dar es Salaam":"Africa\/Dar_es_Salaam","Djibouti":"Africa\/Djibouti","Douala":"Africa\/Douala","El Aaiun":"Africa\/El_Aaiun","Freetown":"Africa\/Freetown","Gaborone":"Africa\/Gaborone","Harare":"Africa\/Harare","Johannesburg":"Africa\/Johannesburg","Juba":"Africa\/Juba","Kampala":"Africa\/Kampala","Khartoum":"Africa\/Khartoum","Kigali":"Africa\/Kigali","Kinshasa":"Africa\/Kinshasa","Lagos":"Africa\/Lagos","Libreville":"Africa\/Libreville","Lome":"Africa\/Lome","Luanda":"Africa\/Luanda","Lubumbashi":"Africa\/Lubumbashi","Lusaka":"Africa\/Lusaka","Malabo":"Africa\/Malabo","Maputo":"Africa\/Maputo","Maseru":"Africa\/Maseru","Mbabane":"Africa\/Mbabane","Mogadishu":"Africa\/Mogadishu","Monrovia":"Africa\/Monrovia","Nairobi":"Africa\/Nairobi","Ndjamena":"Africa\/Ndjamena","Niamey":"Africa\/Niamey","Nouakchott":"Africa\/Nouakchott","Ouagadougou":"Africa\/Ouagadougou","Porto-Novo":"Africa\/Porto-Novo","Sao Tome":"Africa\/Sao_Tome","Tripoli":"Africa\/Tripoli","Tunis":"Africa\/Tunis","Windhoek":"Africa\/Windhoek"},"America":{"Adak":"America\/Adak","Anchorage":"America\/Anchorage","Anguilla":"America\/Anguilla","Antigua":"America\/Antigua","Araguaina":"America\/Araguaina","Argentina - Buenos Aires":"America\/Argentina\/Buenos_Aires","Argentina - Catamarca":"America\/Argentina\/Catamarca","Argentina - Cordoba":"America\/Argentina\/Cordoba","Argentina - Jujuy":"America\/Argentina\/Jujuy","Argentina - La Rioja":"America\/Argentina\/La_Rioja","Argentina - Mendoza":"America\/Argentina\/Mendoza","Argentina - Rio Gallegos":"America\/Argentina\/Rio_Gallegos","Argentina - Salta":"America\/Argentina\/Salta","Argentina - San Juan":"America\/Argentina\/San_Juan","Argentina - San Luis":"America\/Argentina\/San_Luis","Argentina - Tucuman":"America\/Argentina\/Tucuman","Argentina - Ushuaia":"America\/Argentina\/Ushuaia","Aruba":"America\/Aruba","Asuncion":"America\/Asuncion","Atikokan":"America\/Atikokan","Bahia":"America\/Bahia","Bahia Banderas":"America\/Bahia_Banderas","Barbados":"America\/Barbados","Belem":"America\/Belem","Belize":"America\/Belize","Blanc-Sablon":"America\/Blanc-Sablon","Boa Vista":"America\/Boa_Vista","Bogota":"America\/Bogota","Boise":"America\/Boise","Cambridge Bay":"America\/Cambridge_Bay","Campo Grande":"America\/Campo_Grande","Cancun":"America\/Cancun","Caracas":"America\/Caracas","Cayenne":"America\/Cayenne","Cayman":"America\/Cayman","Chicago":"America\/Chicago","Chihuahua":"America\/Chihuahua","Ciudad Juarez":"America\/Ciudad_Juarez","Costa Rica":"America\/Costa_Rica","Creston":"America\/Creston","Cuiaba":"America\/Cuiaba","Curacao":"America\/Curacao","Danmarkshavn":"America\/Danmarkshavn","Dawson":"America\/Dawson","Dawson Creek":"America\/Dawson_Creek","Denver":"America\/Denver","Detroit":"America\/Detroit","Dominica":"America\/Dominica","Edmonton":"America\/Edmonton","Eirunepe":"America\/Eirunepe","El Salvador":"America\/El_Salvador","Fort Nelson":"America\/Fort_Nelson","Fortaleza":"America\/Fortaleza","Glace Bay":"America\/Glace_Bay","Goose Bay":"America\/Goose_Bay","Grand Turk":"America\/Grand_Turk","Grenada":"America\/Grenada","Guadeloupe":"America\/Guadeloupe","Guatemala":"America\/Guatemala","Guayaquil":"America\/Guayaquil","Guyana":"America\/Guyana","Halifax":"America\/Halifax","Havana":"America\/Havana","Hermosillo":"America\/Hermosillo","Indiana - Indianapolis":"America\/Indiana\/Indianapolis","Indiana - Knox":"America\/Indiana\/Knox","Indiana - Marengo":"America\/Indiana\/Marengo","Indiana - Petersburg":"America\/Indiana\/Petersburg","Indiana - Tell City":"America\/Indiana\/Tell_City","Indiana - Vevay":"America\/Indiana\/Vevay","Indiana - Vincennes":"America\/Indiana\/Vincennes","Indiana - Winamac":"America\/Indiana\/Winamac","Inuvik":"America\/Inuvik","Iqaluit":"America\/Iqaluit","Jamaica":"America\/Jamaica","Juneau":"America\/Juneau","Kentucky - Louisville":"America\/Kentucky\/Louisville","Kentucky - Monticello":"America\/Kentucky\/Monticello","Kralendijk":"America\/Kralendijk","La Paz":"America\/La_Paz","Lima":"America\/Lima","Los Angeles":"America\/Los_Angeles","Lower Princes":"America\/Lower_Princes","Maceio":"America\/Maceio","Managua":"America\/Managua","Manaus":"America\/Manaus","Marigot":"America\/Marigot","Martinique":"America\/Martinique","Matamoros":"America\/Matamoros","Mazatlan":"America\/Mazatlan","Menominee":"America\/Menominee","Merida":"America\/Merida","Metlakatla":"America\/Metlakatla","Mexico City":"America\/Mexico_City","Miquelon":"America\/Miquelon","Moncton":"America\/Moncton","Monterrey":"America\/Monterrey","Montevideo":"America\/Montevideo","Montserrat":"America\/Montserrat","Nassau":"America\/Nassau","New York":"America\/New_York","Nome":"America\/Nome","Noronha":"America\/Noronha","North Dakota - Beulah":"America\/North_Dakota\/Beulah","North Dakota - Center":"America\/North_Dakota\/Center","North Dakota - New Salem":"America\/North_Dakota\/New_Salem","Nuuk":"America\/Nuuk","Ojinaga":"America\/Ojinaga","Panama":"America\/Panama","Paramaribo":"America\/Paramaribo","Phoenix":"America\/Phoenix","Port-au-Prince":"America\/Port-au-Prince","Port of Spain":"America\/Port_of_Spain","Porto Velho":"America\/Porto_Velho","Puerto Rico":"America\/Puerto_Rico","Punta Arenas":"America\/Punta_Arenas","Rankin Inlet":"America\/Rankin_Inlet","Recife":"America\/Recife","Regina":"America\/Regina","Resolute":"America\/Resolute","Rio Branco":"America\/Rio_Branco","Santarem":"America\/Santarem","Santiago":"America\/Santiago","Santo Domingo":"America\/Santo_Domingo","Sao Paulo":"America\/Sao_Paulo","Scoresbysund":"America\/Scoresbysund","Sitka":"America\/Sitka","St Barthelemy":"America\/St_Barthelemy","St Johns":"America\/St_Johns","St Kitts":"America\/St_Kitts","St Lucia":"America\/St_Lucia","St Thomas":"America\/St_Thomas","St Vincent":"America\/St_Vincent","Swift Current":"America\/Swift_Current","Tegucigalpa":"America\/Tegucigalpa","Thule":"America\/Thule","Tijuana":"America\/Tijuana","Toronto":"America\/Toronto","Tortola":"America\/Tortola","Vancouver":"America\/Vancouver","Whitehorse":"America\/Whitehorse","Winnipeg":"America\/Winnipeg","Yakutat":"America\/Yakutat"},"Antarctica":{"Casey":"Antarctica\/Casey","Davis":"Antarctica\/Davis","DumontDUrville":"Antarctica\/DumontDUrville","Macquarie":"Antarctica\/Macquarie","Mawson":"Antarctica\/Mawson","McMurdo":"Antarctica\/McMurdo","Palmer":"Antarctica\/Palmer","Rothera":"Antarctica\/Rothera","Syowa":"Antarctica\/Syowa","Troll":"Antarctica\/Troll","Vostok":"Antarctica\/Vostok"},"Arctic":{"Longyearbyen":"Arctic\/Longyearbyen"},"Asia":{"Aden":"Asia\/Aden","Almaty":"Asia\/Almaty","Amman":"Asia\/Amman","Anadyr":"Asia\/Anadyr","Aqtau":"Asia\/Aqtau","Aqtobe":"Asia\/Aqtobe","Ashgabat":"Asia\/Ashgabat","Atyrau":"Asia\/Atyrau","Baghdad":"Asia\/Baghdad","Bahrain":"Asia\/Bahrain","Baku":"Asia\/Baku","Bangkok":"Asia\/Bangkok","Barnaul":"Asia\/Barnaul","Beirut":"Asia\/Beirut","Bishkek":"Asia\/Bishkek","Brunei":"Asia\/Brunei","Chita":"Asia\/Chita","Choibalsan":"Asia\/Choibalsan","Colombo":"Asia\/Colombo","Damascus":"Asia\/Damascus","Dhaka":"Asia\/Dhaka","Dili":"Asia\/Dili","Dubai":"Asia\/Dubai","Dushanbe":"Asia\/Dushanbe","Famagusta":"Asia\/Famagusta","Gaza":"Asia\/Gaza","Hebron":"Asia\/Hebron","Ho Chi Minh":"Asia\/Ho_Chi_Minh","Hong Kong":"Asia\/Hong_Kong","Hovd":"Asia\/Hovd","Irkutsk":"Asia\/Irkutsk","Jakarta":"Asia\/Jakarta","Jayapura":"Asia\/Jayapura","Jerusalem":"Asia\/Jerusalem","Kabul":"Asia\/Kabul","Kamchatka":"Asia\/Kamchatka","Karachi":"Asia\/Karachi","Kathmandu":"Asia\/Kathmandu","Khandyga":"Asia\/Khandyga","Kolkata":"Asia\/Kolkata","Krasnoyarsk":"Asia\/Krasnoyarsk","Kuala Lumpur":"Asia\/Kuala_Lumpur","Kuching":"Asia\/Kuching","Kuwait":"Asia\/Kuwait","Macau":"Asia\/Macau","Magadan":"Asia\/Magadan","Makassar":"Asia\/Makassar","Manila":"Asia\/Manila","Muscat":"Asia\/Muscat","Nicosia":"Asia\/Nicosia","Novokuznetsk":"Asia\/Novokuznetsk","Novosibirsk":"Asia\/Novosibirsk","Omsk":"Asia\/Omsk","Oral":"Asia\/Oral","Phnom Penh":"Asia\/Phnom_Penh","Pontianak":"Asia\/Pontianak","Pyongyang":"Asia\/Pyongyang","Qatar":"Asia\/Qatar","Qostanay":"Asia\/Qostanay","Qyzylorda":"Asia\/Qyzylorda","Riyadh":"Asia\/Riyadh","Sakhalin":"Asia\/Sakhalin","Samarkand":"Asia\/Samarkand","Seoul":"Asia\/Seoul","Shanghai":"Asia\/Shanghai","Singapore":"Asia\/Singapore","Srednekolymsk":"Asia\/Srednekolymsk","Taipei":"Asia\/Taipei","Tashkent":"Asia\/Tashkent","Tbilisi":"Asia\/Tbilisi","Tehran":"Asia\/Tehran","Thimphu":"Asia\/Thimphu","Tokyo":"Asia\/Tokyo","Tomsk":"Asia\/Tomsk","Ulaanbaatar":"Asia\/Ulaanbaatar","Urumqi":"Asia\/Urumqi","Ust-Nera":"Asia\/Ust-Nera","Vientiane":"Asia\/Vientiane","Vladivostok":"Asia\/Vladivostok","Yakutsk":"Asia\/Yakutsk","Yangon":"Asia\/Yangon","Yekaterinburg":"Asia\/Yekaterinburg","Yerevan":"Asia\/Yerevan"},"Atlantic":{"Azores":"Atlantic\/Azores","Bermuda":"Atlantic\/Bermuda","Canary":"Atlantic\/Canary","Cape Verde":"Atlantic\/Cape_Verde","Faroe":"Atlantic\/Faroe","Madeira":"Atlantic\/Madeira","Reykjavik":"Atlantic\/Reykjavik","South Georgia":"Atlantic\/South_Georgia","St Helena":"Atlantic\/St_Helena","Stanley":"Atlantic\/Stanley"},"Australia":{"Adelaide":"Australia\/Adelaide","Brisbane":"Australia\/Brisbane","Broken Hill":"Australia\/Broken_Hill","Darwin":"Australia\/Darwin","Eucla":"Australia\/Eucla","Hobart":"Australia\/Hobart","Lindeman":"Australia\/Lindeman","Lord Howe":"Australia\/Lord_Howe","Melbourne":"Australia\/Melbourne","Perth":"Australia\/Perth","Sydney":"Australia\/Sydney"},"Europe":{"Amsterdam":"Europe\/Amsterdam","Andorra":"Europe\/Andorra","Astrakhan":"Europe\/Astrakhan","Athens":"Europe\/Athens","Belgrade":"Europe\/Belgrade","Berlin":"Europe\/Berlin","Bratislava":"Europe\/Bratislava","Brussels":"Europe\/Brussels","Bucharest":"Europe\/Bucharest","Budapest":"Europe\/Budapest","Busingen":"Europe\/Busingen","Chisinau":"Europe\/Chisinau","Copenhagen":"Europe\/Copenhagen","Dublin":"Europe\/Dublin","Gibraltar":"Europe\/Gibraltar","Guernsey":"Europe\/Guernsey","Helsinki":"Europe\/Helsinki","Isle of Man":"Europe\/Isle_of_Man","Istanbul":"Europe\/Istanbul","Jersey":"Europe\/Jersey","Kaliningrad":"Europe\/Kaliningrad","Kirov":"Europe\/Kirov","Kyiv":"Europe\/Kyiv","Lisbon":"Europe\/Lisbon","Ljubljana":"Europe\/Ljubljana","London":"Europe\/London","Luxembourg":"Europe\/Luxembourg","Madrid":"Europe\/Madrid","Malta":"Europe\/Malta","Mariehamn":"Europe\/Mariehamn","Minsk":"Europe\/Minsk","Monaco":"Europe\/Monaco","Moscow":"Europe\/Moscow","Oslo":"Europe\/Oslo","Paris":"Europe\/Paris","Podgorica":"Europe\/Podgorica","Prague":"Europe\/Prague","Riga":"Europe\/Riga","Rome":"Europe\/Rome","Samara":"Europe\/Samara","San Marino":"Europe\/San_Marino","Sarajevo":"Europe\/Sarajevo","Saratov":"Europe\/Saratov","Simferopol":"Europe\/Simferopol","Skopje":"Europe\/Skopje","Sofia":"Europe\/Sofia","Stockholm":"Europe\/Stockholm","Tallinn":"Europe\/Tallinn","Tirane":"Europe\/Tirane","Ulyanovsk":"Europe\/Ulyanovsk","Vaduz":"Europe\/Vaduz","Vatican":"Europe\/Vatican","Vienna":"Europe\/Vienna","Vilnius":"Europe\/Vilnius","Volgograd":"Europe\/Volgograd","Warsaw":"Europe\/Warsaw","Zagreb":"Europe\/Zagreb","Zurich":"Europe\/Zurich"},"Indian":{"Antananarivo":"Indian\/Antananarivo","Chagos":"Indian\/Chagos","Christmas":"Indian\/Christmas","Cocos":"Indian\/Cocos","Comoro":"Indian\/Comoro","Kerguelen":"Indian\/Kerguelen","Mahe":"Indian\/Mahe","Maldives":"Indian\/Maldives","Mauritius":"Indian\/Mauritius","Mayotte":"Indian\/Mayotte","Reunion":"Indian\/Reunion"},"Pacific":{"Apia":"Pacific\/Apia","Auckland":"Pacific\/Auckland","Bougainville":"Pacific\/Bougainville","Chatham":"Pacific\/Chatham","Chuuk":"Pacific\/Chuuk","Easter":"Pacific\/Easter","Efate":"Pacific\/Efate","Fakaofo":"Pacific\/Fakaofo","Fiji":"Pacific\/Fiji","Funafuti":"Pacific\/Funafuti","Galapagos":"Pacific\/Galapagos","Gambier":"Pacific\/Gambier","Guadalcanal":"Pacific\/Guadalcanal","Guam":"Pacific\/Guam","Honolulu":"Pacific\/Honolulu","Kanton":"Pacific\/Kanton","Kiritimati":"Pacific\/Kiritimati","Kosrae":"Pacific\/Kosrae","Kwajalein":"Pacific\/Kwajalein","Majuro":"Pacific\/Majuro","Marquesas":"Pacific\/Marquesas","Midway":"Pacific\/Midway","Nauru":"Pacific\/Nauru","Niue":"Pacific\/Niue","Norfolk":"Pacific\/Norfolk","Noumea":"Pacific\/Noumea","Pago Pago":"Pacific\/Pago_Pago","Palau":"Pacific\/Palau","Pitcairn":"Pacific\/Pitcairn","Pohnpei":"Pacific\/Pohnpei","Port Moresby":"Pacific\/Port_Moresby","Rarotonga":"Pacific\/Rarotonga","Saipan":"Pacific\/Saipan","Tahiti":"Pacific\/Tahiti","Tarawa":"Pacific\/Tarawa","Tongatapu":"Pacific\/Tongatapu","Wake":"Pacific\/Wake","Wallis":"Pacific\/Wallis"},"Other":{"UTC":"UTC"}}

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/helpdesk/updater/status unstable

Get the updater status

Applicable api modes

session token key oauth

Api tags for this endpoint

helpdesk.updater.updater_status

Response
Status Codes

Parameter	Type	Versions
data.next_check	DateTime	*
data.next_is_manual	boolean	*
data.cli_command	string	*
data.backup_path	string	*
data.log_url	string	*
data.watcher_url	string	*

Status Code	Description
200	Success

Show/hide List Operations Expand Operations

Importer

POST /api/v2/importer/start_import

Start a new import process from an external data source.

Applicable api modes

session token key oauth

Api tags for this endpoint

importer.importer.start_import

Parameters
Response
Status Codes

Parameter	Type	Required?	Format	Description
type	choice	true	["zendesk","kayako","osticket","advanced"]

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.source_type	string	*
data.status	string	*
data.imported_steps[]	array of strings	*
data.imported_counts	array	*
data.applied_steps[]	array of strings	*
data.applied_counts	array	*
data.date_created	DateTime	*
data.log	string	*

Status Code	Description
200	Returned if everything is ok

GET /api/v2/importer/status

Get progress of current importer process.

Applicable api modes

session token key oauth

Api tags for this endpoint

importer.importer.status

Response
Status Codes

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.source_type	string	*
data.status	string	*
data.imported_steps[]	array of strings	*
data.imported_counts	array	*
data.applied_steps[]	array of strings	*
data.applied_counts	array	*
data.date_created	DateTime	*
data.log	string	*

Status Code	Description
200	Returned if everything is ok

GET /api/v2/importer/status/{job}

Get progress of current importer process.

Applicable api modes

session token key oauth

Api tags for this endpoint

importer.importer.status

Requirements
Response
Status Codes

Name	Requirement	Type	Description
job		Job

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.source_type	string	*
data.status	string	*
data.imported_steps[]	array of strings	*
data.imported_counts	array	*
data.applied_steps[]	array of strings	*
data.applied_counts	array	*
data.date_created	DateTime	*
data.log	string	*

Status Code	Description
200	Returned if everything is ok

POST /api/v2/importer/stop_import

Stop current importer process.

POST /api/v2/importer/test_settings

Check if an external data source connect options are valid.

Applicable api modes

session token key oauth

Api tags for this endpoint

importer.importer.test_settings

Parameters
Status Codes

Parameter	Type	Required?	Format	Description
type	choice	true	["zendesk","kayako","osticket","advanced"]

Status Code	Description
200	Returned if everything is ok

GET /api/v2/importer_logs CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

importer.importer_logs.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (ImportLog)	*
data[][id]	integer	*
data[][type]	string	*
data[][counts]	array	*
data[][log_blobs][]	array of objects (Blob)	*
data[][log_blobs][][sys_name]	string	*	A unique system name for the blob.
data[][log_blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][log_blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][log_blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][log_blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][log_blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data[][log_blobs][][file_url]	string	*	The HTTP link to download the file.
data[][log_blobs][][authcode]	string	*
data[][log_blobs][][blob_hash]	string	*
data[][log_blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][log_blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][log_blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][log_blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][log_blobs][][date_created]	DateTime	*
data[][log_blobs][][is_temp]	boolean	*
data[][log_blobs][][source_ref]	string	*
data[][log_blobs][][labels][]	array of objects (LabelBlob)	*
data[][log_blobs][][labels][][blob]	object (Blob)	*
data[][date_created]	DateTime	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

GET /api/v2/importer_logs/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

importer.importer_logs.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

GET /api/v2/importer_logs/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

importer.importer_logs.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.id	integer	*
data.type	string	*
data.counts	array	*
data.log_blobs[]	array of objects (Blob)	*
data.log_blobs[][sys_name]	string	*	A unique system name for the blob.
data.log_blobs[][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.log_blobs[][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.log_blobs[][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.log_blobs[][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.log_blobs[][save_path]	string	*	The path to the file if it's not stored in the database.
data.log_blobs[][file_url]	string	*	The HTTP link to download the file.
data.log_blobs[][authcode]	string	*
data.log_blobs[][blob_hash]	string	*
data.log_blobs[][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.log_blobs[][title]	string	*	The title of this file used in interfaces if its a media upload.
data.log_blobs[][dim_w]	integer	*	If this type of file has dimentions, the width.
data.log_blobs[][dim_h]	integer	*	If this type of file has dimentions, the height.
data.log_blobs[][date_created]	DateTime	*
data.log_blobs[][is_temp]	boolean	*
data.log_blobs[][source_ref]	string	*
data.log_blobs[][labels][]	array of objects (LabelBlob)	*
data.log_blobs[][labels][][blob]	object (Blob)	*
data.date_created	DateTime	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

Show/hide List Operations Expand Operations

Jobs

GET /api/v2/jobs CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

jobs.list

Response
Status Codes

Parameter	Type	Versions	Description
data[]	array of objects (Job)	*
data[][id]	integer	*	The unique job id.
data[][type]	string	*	The job type, used by the Job Router to find the right Job Processor.
data[][status]	string	*	The status of the job.
data[][status_code]	string	*	Any code to further classify the status.
data[][date_touch]	DateTime	*	Date the last time a process "touched" this ticket.
data[][date_created]	DateTime	*	Date this job entered the "jobs" table.
data[][date_last_try]	DateTime	*	Last time we processed this job.
data[][date_next_try]	DateTime	*	If this DateTime is in the future, it won't be selected for execution.
data[][num_tries]	integer	*	The number of times this job has been executed Job Processor (usually indicated failures if > 1).
data[][log_summary]	string	*	A human readable summary of the job's execution.
data[][log]	string	*	A more verbose log.
data[][data]	array	*	An array of data, or payload, that the job processor needs to execute this job (stored in the db as json). This MUST always be an array, even if its an empty array
data[][original_job]	integer	*	Null unless the job was created as a retry - if so, the originating job ID is stored here so we can query it later. Note: You MUST specify the originating job, do not create a linked list of failed jobs.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

GET /api/v2/jobs/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

jobs.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.id	integer	*	The unique job id.
data.type	string	*	The job type, used by the Job Router to find the right Job Processor.
data.status	string	*	The status of the job.
data.status_code	string	*	Any code to further classify the status.
data.date_touch	DateTime	*	Date the last time a process "touched" this ticket.
data.date_created	DateTime	*	Date this job entered the "jobs" table.
data.date_last_try	DateTime	*	Last time we processed this job.
data.date_next_try	DateTime	*	If this DateTime is in the future, it won't be selected for execution.
data.num_tries	integer	*	The number of times this job has been executed Job Processor (usually indicated failures if > 1).
data.log_summary	string	*	A human readable summary of the job's execution.
data.log	string	*	A more verbose log.
data.data	array	*	An array of data, or payload, that the job processor needs to execute this job (stored in the db as json). This MUST always be an array, even if its an empty array
data.original_job	integer	*	Null unless the job was created as a retry - if so, the originating job ID is stored here so we can query it later. Note: You MUST specify the originating job, do not create a linked list of failed jobs.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

Show/hide List Operations Expand Operations

Labels

GET /api/v2/{type}_labels unstable

Get all labels by types

Documentation

Fetch labels for given entity types and you can filter labels by some term.

Applicable api modes

session token key oauth

Api tags for this endpoint

labels.labels.get_labels

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
type	task\|ticket\|person\|organization\|community\|news\|chat\|article\|download	string	Which entity type labels we are searching?

Name

Information

term

Requirement	\w
Description	Filter label by given word
Datatype	string

Parameter	Type	Versions	Description
data.label_type	string	*	Label type.
data.label	string	*	Label itself.
data.color	string	*	RGB color representation.
data.total	integer	*	Label times used total counter.

Status Code	Description
200	Returned if everything is ok
400	We will return this status in case your {type} wasn't found

Show/hide List Operations Expand Operations

Languages

GET /api/v2/languages CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

languages.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (Language)	*
data[][id]	integer	*	The unique ID.
data[][sys_name]	string	*	The unique sys name assigned to the language.
data[][title]	string	*	Title of the language.
data[][title_local]	string	*	Title of the language.
data[][base_filepath]	string	*	The base filepath for default phrases for this lang.
data[][locale]	string	*	The locale code.
data[][flag_image]	string	*	String path to image.
data[][is_rtl]	boolean	*	True if this is a right-to-left language.
data[][has_user]	boolean	*	True if has user.
data[][has_agent]	boolean	*	True if has agent.
data[][has_admin]	boolean	*	True if has admin.
data[][plural_categories][]	array of strings	*
data[][plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data[][flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

GET /api/v2/languages/admin_phrases

provide admin phrases for frontend

Applicable api modes

session token key oauth

Api tags for this endpoint

languages.admin_phrases

Status Codes

Status Code	Description
201	Created
400	Bad Request

GET /api/v2/languages/agent_phrases

provide agent phrases for frontend

Applicable api modes

session token key oauth

Api tags for this endpoint

languages.agent_phrases

Status Codes

Status Code	Description
201	Created
400	Bad Request

GET /api/v2/languages/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

languages.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

POST /api/v2/languages/custom_phrase

Create new custom phrase in several languages

Applicable api modes

session token key oauth

Api tags for this endpoint

languages.post_custom_phrase

Parameters
Response
Status Codes

Parameter	Type	Required?
name	string	true
phrase_en-US	string	true
phrase_fr	string	true
phrase_ar	string	true

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.language	object (Language)	*	The language this phrase belongs to.
data.language[id]	integer	*	The unique ID.
data.language[sys_name]	string	*	The unique sys name assigned to the language.
data.language[title]	string	*	Title of the language.
data.language[title_local]	string	*	Title of the language.
data.language[base_filepath]	string	*	The base filepath for default phrases for this lang.
data.language[locale]	string	*	The locale code.
data.language[flag_image]	string	*	String path to image.
data.language[is_rtl]	boolean	*	True if this is a right-to-left language.
data.language[has_user]	boolean	*	True if has user.
data.language[has_agent]	boolean	*	True if has agent.
data.language[has_admin]	boolean	*	True if has admin.
data.language[plural_categories][]	array of strings	*
data.language[plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data.language[flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`
data.name	string	*	The name of the phrase.
data.groupname	string	*	Phrases can belong to groups. The group is the string before the first dot in the name. deskpro.profile, the group is 'deskpro'.
data.phrase	string	*
data.original_phrase	string	*
data.original_hash	string	*
data.is_outdated	boolean	*	Is this phrase marked as outdated? This happens when we detect the original hash stored is different from what is on the filesystem.
data.is_managed	boolean	*	True if the phrase is 'managed' by the system and is not a custom user phrase.
data.created_at	DateTime	*
data.updated_at	DateTime	*

Status Code	Description
201	Created
400	Bad Request

GET /api/v2/languages/departments/{languageId}

provide Agent departments phrases for UI

Applicable api modes

session token key oauth

Api tags for this endpoint

languages.departments

Requirements
Status Codes

Name	Requirement	Type	Description
languageId

Status Code	Description
201	Created
400	Bad Request

GET /api/v2/languages/email_phrases/{group}/{languageId}

provide agent phrases for frontend

Applicable api modes

session token key oauth

Api tags for this endpoint

languages.email_phrases

Requirements
Status Codes

Name	Requirement	Type	Description
group		mixed
languageId

Status Code	Description
201	Created
400	Bad Request

GET /api/v2/languages/helpcenter_phrases/{languageId}

provide helpcenter phrases for template editor

Applicable api modes

session token key oauth

Api tags for this endpoint

languages.helpcenter_phrases

Requirements
Status Codes

Name	Requirement	Type	Description
languageId

Status Code	Description
201	Created
400	Bad Request

GET /api/v2/languages/translations/{phraseName}

provide translation of a phrase

Applicable api modes

session token key oauth

Api tags for this endpoint

languages.get_translations

Requirements
Status Codes

Name	Requirement	Type	Description
phraseName

Status Code	Description
201	Created
400	Bad Request

POST /api/v2/languages/translations/{phraseName}

provide translation of a phrase

Applicable api modes

session token key oauth

Api tags for this endpoint

languages.post_translations

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
phraseName

Parameter	Type	Required?	Format	Description
translations	string	true

Status Code	Description
201	Created
400	Bad Request

GET /api/v2/languages/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

languages.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.sys_name	string	*	The unique sys name assigned to the language.
data.title	string	*	Title of the language.
data.title_local	string	*	Title of the language.
data.base_filepath	string	*	The base filepath for default phrases for this lang.
data.locale	string	*	The locale code.
data.flag_image	string	*	String path to image.
data.is_rtl	boolean	*	True if this is a right-to-left language.
data.has_user	boolean	*	True if has user.
data.has_agent	boolean	*	True if has agent.
data.has_admin	boolean	*	True if has admin.
data.plural_categories[]	array of strings	*
data.plural_formula	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data.flag_urn	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

Show/hide List Operations Expand Operations

Logs

GET /api/v2/api_logs CRUD

get api logs collection

Applicable api modes

session token key oauth

Api tags for this endpoint

logs.logs_crud.list

Response
Status Codes

Parameter	Type	Versions	Description
data[]	array of objects (ApiLog)	*
data[][requested_uri]	string	*	Uri that was requested.
data[][method]	string	*	Request method.
data[][request_id]	string	*	Unique request identity (could be provided by client, see docs).
data[][response_data]	array	*	Get already decoded response data as array.
data[][id]	integer	*	The unique log id.
data[][start_time]	integer	*	Timestamp when request was started.
data[][end_time]	integer	*	Timestamp when request was ended.
data[][credentials]	string	*	Credentials with which request was made.
data[][mode]	string	*	Request api mode.
data[][status]	integer	*	HTTP status.
data[][request_data]	array	*	Data which was attached to request.
data[][is_dupe]	boolean	*	Flag indicates that request is dupe.
data[][is_request_truncated]	boolean	*
data[][is_response_truncated]	boolean	*

Status Code	Description
200	Returned if everything is OK

GET /api/v2/api_logs/{id} CRUD

get api log

Applicable api modes

session token key oauth

Api tags for this endpoint

logs.logs_crud.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
page	\d+
id		int

Parameter	Type	Versions	Description
data.requested_uri	string	*	Uri that was requested.
data.method	string	*	Request method.
data.request_id	string	*	Unique request identity (could be provided by client, see docs).
data.response_data	array	*	Get already decoded response data as array.
data.id	integer	*	The unique log id.
data.start_time	integer	*	Timestamp when request was started.
data.end_time	integer	*	Timestamp when request was ended.
data.credentials	string	*	Credentials with which request was made.
data.mode	string	*	Request api mode.
data.status	integer	*	HTTP status.
data.request_data	array	*	Data which was attached to request.
data.is_dupe	boolean	*	Flag indicates that request is dupe.
data.is_request_truncated	boolean	*
data.is_response_truncated	boolean	*

Status Code	Description
200	Returned if everything is OK

POST /api/v2/api_logs/{id}/replay

update logging options

Documentation

This endpoint gives you an ability to replay log entry.

Subrequest mode means that log will be replayed with framework only

Isolated mode means that log will be replayed with curl, make sure you have it

Applicable api modes

session token key oauth

Api tags for this endpoint

logs.logs.replay_log

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
mode	isolated\|subrequest	string	how to replay
id	\d+	integer	id of entry to replay

Parameter	Type	Required?	Format	Description
	string	true

Parameter	Type	Versions	Description
data.requested_uri	string	*	Uri that was requested.
data.method	string	*	Request method.
data.request_id	string	*	Unique request identity (could be provided by client, see docs).
data.response_data	array	*	Get already decoded response data as array.
data.id	integer	*	The unique log id.
data.start_time	integer	*	Timestamp when request was started.
data.end_time	integer	*	Timestamp when request was ended.
data.credentials	string	*	Credentials with which request was made.
data.mode	string	*	Request api mode.
data.status	integer	*	HTTP status.
data.request_data	array	*	Data which was attached to request.
data.is_dupe	boolean	*	Flag indicates that request is dupe.
data.is_request_truncated	boolean	*
data.is_response_truncated	boolean	*

Status Code	Description
200	Returned if everything is OK
400	Returned if mode not equals 'isolated' or 'subrequest'
404	We can't find entry with provided id

GET /api/v2/api_logs_options

get logging options

Documentation

Gather logging options.

Applicable api modes

session token key oauth

Api tags for this endpoint

logs.logs.get_options

Response
Status Codes

Parameter	Type	Versions	Description
data.enabled	boolean	*	Is log enabled.
data.request_length	integer	*	Maximum request body size (in B).
data.response_length	integer	*	Maximum response body size (in B).
data.modes[]	array of strings	*	Which modes to log (if enabled).
data.keep_days	integer	*	How many days keep logs for the key.
data.per_key	integer	*	How many log entries keep for the key.

Status Code	Description
200	Returned if everything is OK

PUT /api/v2/api_logs_options

update logging options

Documentation

Update logging options.

Applicable api modes

session token key oauth

Api tags for this endpoint

logs.logs.put_options

Parameters
Status Codes

Parameter	Type	Required?	Format
enabled	boolean	false
modes[]	array of choices	false	["key"]
request_length	integer	false
response_length	integer	false
keep_days	integer	false
per_key	integer	false

Status Code	Description
204	Returned if everything is OK

Show/hide List Operations Expand Operations

Mass actions

POST /api/v2/mass_actions/article_comments

create new mass action for real-time apply

Applicable api modes

session token key oauth

Api tags for this endpoint

mass_actions.article_comment_mass_actions.mass

Status Codes

Status Code	Description
200	Your request was successful
400	Malformed request, refer to manual

POST /api/v2/mass_actions/articles

create new mass action for real-time apply

Applicable api modes

session token key oauth

Api tags for this endpoint

mass_actions.article_mass_actions.mass

Status Codes

Status Code	Description
200	Your request was successful
400	Malformed request, refer to manual

POST /api/v2/mass_actions/community_topic_comments

create new mass action for real-time apply

Applicable api modes

session token key oauth

Api tags for this endpoint

mass_actions.community_topic_comment_mass_actions.mass

Status Codes

Status Code	Description
200	Your request was successful
400	Malformed request, refer to manual

POST /api/v2/mass_actions/community_topics

create new mass action for real-time apply

Applicable api modes

session token key oauth

Api tags for this endpoint

mass_actions.community_topic_mass_actions.mass

Status Codes

Status Code	Description
200	Your request was successful
400	Malformed request, refer to manual

POST /api/v2/mass_actions/download_comments

create new mass action for real-time apply

Applicable api modes

session token key oauth

Api tags for this endpoint

mass_actions.download_comment_mass_actions.mass

Status Codes

Status Code	Description
200	Your request was successful
400	Malformed request, refer to manual

POST /api/v2/mass_actions/guide_topic_comments

create new mass action for real-time apply

Applicable api modes

session token key oauth

Api tags for this endpoint

mass_actions.guide_topic_comment_mass_actions.mass

Status Codes

Status Code	Description
200	Your request was successful
400	Malformed request, refer to manual

POST /api/v2/mass_actions/news_comments

create new mass action for real-time apply

Applicable api modes

session token key oauth

Api tags for this endpoint

mass_actions.news_comment_mass_actions.mass

Status Codes

Status Code	Description
200	Your request was successful
400	Malformed request, refer to manual

POST /api/v2/mass_actions/organizations

create new mass action for real-time apply

Applicable api modes

session token key oauth

Api tags for this endpoint

mass_actions.organization_mass_actions.mass

Status Codes

Status Code	Description
200	Your request was successful
400	Malformed request, refer to manual

POST /api/v2/mass_actions/pending_articles

create new mass action for real-time apply

Applicable api modes

session token key oauth

Api tags for this endpoint

mass_actions.pending_article_mass_actions.mass

Status Codes

Status Code	Description
200	Your request was successful
400	Malformed request, refer to manual

POST /api/v2/mass_actions/people

create new mass action for real-time apply

Applicable api modes

session token key oauth

Api tags for this endpoint

mass_actions.people_mass_actions.mass

Status Codes

Status Code	Description
200	Your request was successful
400	Malformed request, refer to manual

POST /api/v2/mass_actions/tickets

create new mass action for real-time apply

Applicable api modes

session token key oauth

Api tags for this endpoint

mass_actions.ticket_mass_actions.mass

Status Codes

Status Code	Description
200	Your request was successful
400	Malformed request, refer to manual

Show/hide List Operations Expand Operations

News

POST /api/v2/news/{news}/icon

set Icon

Documentation

Set icon for download.

Applicable api modes

session token key oauth

Api tags for this endpoint

content.news.set_icon

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
news	\d+	integer	the id of news

Parameter	Type	Required?
urn	string	true
style	string	true
color	string	true

Status Code	Description
200	Returned if everything is OK

POST /api/v2/news/{news}/splash_image

set Splash Image

Documentation

Set splash image for news.

Applicable api modes

session token key oauth

Api tags for this endpoint

content.news.select_splash_image

Requirements
Status Codes

Name	Requirement	Type	Description
news	\d+	integer	the id of news

Status Code	Description
200	Returned if everything is OK

POST /api/v2/news/{news}/splash_image_upload

Create Splash Image For News

Applicable api modes

session token key oauth

Api tags for this endpoint

content.news.upload_splash_image

Requirements
Status Codes

Name	Requirement	Type	Description
news	\d+	integer	the id of news

Status Code	Description
200	Returned if everything is OK

POST /api/v2/news_comments/{comment}/rate

rate news comment

Documentation

Rate news comment.

Applicable api modes

session token key oauth

Api tags for this endpoint

content.comments.news_all_comments.rate_news_content

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
news	\d+	integer	the id of news comment
comment		NewsComment

Parameter	Type	Required?	Format	Description
upvote	choice	true	[0,1]

Status Code	Description
200	Returned if everything is OK

Show/hide List Operations Expand Operations

Notifications and alerts

GET /api/v2/me/notifications CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

agent_alerts.agent_alerts.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (AgentAlert)	*
data[][uuid]	integer	*	Unique identity of alert.
data[][type]	string	*	Alert type. Available values are:. 'notifications.tickets.new_ticket', 'notifications.tickets.updated', 'notifications.tickets.new_message.user_reply', 'notifications.tickets.new_message.agent_note', 'notifications.tickets.new_message.agent_reply'
data[][data]	object (AgentAlertData)	*	Alert data.
data[][data][ticket]	integer	*	Ticket identity.
data[][data][notification]	object (NotifyData)	*	Additional data about notification.
data[][data][notification][title]	string	*	Notification title.
data[][data][notification][summary]	string	*	Notification summary.
data[][data][performer]	integer	*	Who performed this alert. Identity.
data[][date_created]	DateTime	*	When this alert was created.
data[][is_dismissed]	boolean	*	Is it dismissed?

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

GET /api/v2/me/notifications/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

agent_alerts.agent_alerts.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

POST /api/v2/me/notifications/dismiss

Dismiss set of alerts

Documentation

Dismiss alerts with given ids array.

Applicable api modes

session token key oauth

Api tags for this endpoint

agent_alerts.agent_alerts.dismiss

Parameters
Status Codes

Parameter	Type	Required?	Format	Description
	array	true

Status Code	Description
204	Returned if everything is ok

POST /api/v2/me/notifications/dismiss/all

dismiss all alerts for the current user

Documentation

You can dismiss all users alerts for current authenticated user.

Applicable api modes

session token key oauth

Api tags for this endpoint

agent_alerts.agent_alerts.dismiss_all

Status Codes

Status Code	Description
200	Returned if everything is ok

DELETE /api/v2/me/notifications/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

agent_alerts.agent_alerts.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/me/notifications/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

agent_alerts.agent_alerts.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.uuid	integer	*	Unique identity of alert.
data.type	string	*	Alert type. Available values are:. 'notifications.tickets.new_ticket', 'notifications.tickets.updated', 'notifications.tickets.new_message.user_reply', 'notifications.tickets.new_message.agent_note', 'notifications.tickets.new_message.agent_reply'
data.data	object (AgentAlertData)	*	Alert data.
data.data[ticket]	integer	*	Ticket identity.
data.data[notification]	object (NotifyData)	*	Additional data about notification.
data.data[notification][title]	string	*	Notification title.
data.data[notification][summary]	string	*	Notification summary.
data.data[performer]	integer	*	Who performed this alert. Identity.
data.date_created	DateTime	*	When this alert was created.
data.is_dismissed	boolean	*	Is it dismissed?

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

GET /api/v2/notify/setup/action-alerts

You can use this endpoint to gather information about clients you need to obtain notifications and alerts.

Documentation

You can use this endpoint to gather information about clients you need to obtain notifications and alerts.

Applicable api modes

session token key oauth

Api tags for this endpoint

notification.setup_action_alerts

Response
Status Codes

Parameter	Type	Versions	Description
dataclients[]	array of objects (NotificationClient)	*	Clients array.
dataclients[][type]	string	*	Client type.
dataclients[][options]	array	*	Client options.

Status Code	Description
200	Returned if everything is ok

GET /api/v2/notify/setup/action-alerts/clients

This endpoint provide you an ability to get pusher credentials you are using (admin only).

Documentation

This endpoint provide you an ability to get pusher credentials you are using (admin only).

Applicable api modes

session token key oauth

Api tags for this endpoint

notification.get_client_credentials

Parameters
Status Codes

Parameter	Type	Required?	Format	Description
	string	true

Status Code	Description
200	Returned if everything is ok

PUT /api/v2/notify/setup/action-alerts/clients

Save pusher credentials and enable/disable it.

Documentation

Save pusher credentials and enable/disable it.

Applicable api modes

session token key oauth

Api tags for this endpoint

notification.save_clients_credentials

Parameters
Status Codes

Parameter	Type	Required?	Format	Description
	string	false

Status Code	Description
204	Returned if everything is ok

POST /api/v2/pusher/auth

This endpoint provide you an ability to authenticate pusher app.

Documentation

This endpoint provide you an ability to authenticate pusher app.

Applicable api modes

session token key oauth

Api tags for this endpoint

notification.pusher_auth

Parameters
Status Codes

Parameter	Type	Required?	Format	Description
	string	true

Status Code	Description
200	Returned if everything is ok

Show/hide List Operations Expand Operations

Organizations

GET /api/v2/organization_custom_fields CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organization_custom_fields.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (CustomDefOrganization)	*
data[][title]		*
data[][parent]	object (CustomDefOrganization)	*	Field`s parent.
data[][parent][parent]	object (CustomDefOrganization)	*	Field`s parent.
data[][parent][children][]	array of objects (CustomDefOrganization)	*	Field children.
data[][children][]	array of objects (CustomDefOrganization)	*	Field children.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/organization_custom_fields CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organization_custom_fields.post

Parameters
Response
Status Codes

Parameter	Type	Required?	Format	Description
handler_class	choice	true	["Application\\DeskPRO\\CustomFields\\Handler\\Text","Application\\DeskPRO\\CustomFields\\Handler\\Textarea","Application\\DeskPRO\\CustomFields\\Handler\\Choice","Application\\DeskPRO\\CustomFields\\Handler\\Toggle","Application\\DeskPRO\\CustomFields\\Handler\\Date","Application\\DeskPRO\\CustomFields\\Handler\\DateTime","Application\\DeskPRO\\CustomFields\\Handler\\Display","Application\\DeskPRO\\CustomFields\\Handler\\Hidden","Application\\DeskPRO\\CustomFields\\Handler\\Data","Application\\DeskPRO\\CustomFields\\Handler\\DataJson","Application\\DeskPRO\\CustomFields\\Handler\\Javascript","Application\\DeskPRO\\CustomFields\\Handler\\DataList","Application\\DeskPRO\\CustomFields\\Handler\\Url","Application\\DeskPRO\\CustomFields\\Handler\\Number","Application\\DeskPRO\\CustomFields\\Handler\\Currency","Application\\DeskPRO\\CustomFields\\Handler\\File","Application\\DeskPRO\\CustomFields\\Handler\\ExternalUniqueKey"]

Parameter	Type	Versions	Description
data.title		*
data.parent	object (CustomDefOrganization)	*	Field`s parent.
data.parent[parent]	object (CustomDefOrganization)	*	Field`s parent.
data.parent[children][]	array of objects (CustomDefOrganization)	*	Field children.
data.parent[title]		*
data.children[]	array of objects (CustomDefOrganization)	*	Field children.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

DELETE /api/v2/organization_custom_fields/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organization_custom_fields.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/organization_custom_fields/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organization_custom_fields.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.title		*
data.parent	object (CustomDefOrganization)	*	Field`s parent.
data.parent[parent]	object (CustomDefOrganization)	*	Field`s parent.
data.parent[children][]	array of objects (CustomDefOrganization)	*	Field children.
data.parent[title]		*
data.children[]	array of objects (CustomDefOrganization)	*	Field children.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/organization_custom_fields/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organization_custom_fields.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format	Description
handler_class	choice	false	["Application\\DeskPRO\\CustomFields\\Handler\\Text","Application\\DeskPRO\\CustomFields\\Handler\\Textarea","Application\\DeskPRO\\CustomFields\\Handler\\Choice","Application\\DeskPRO\\CustomFields\\Handler\\Toggle","Application\\DeskPRO\\CustomFields\\Handler\\Date","Application\\DeskPRO\\CustomFields\\Handler\\DateTime","Application\\DeskPRO\\CustomFields\\Handler\\Display","Application\\DeskPRO\\CustomFields\\Handler\\Hidden","Application\\DeskPRO\\CustomFields\\Handler\\Data","Application\\DeskPRO\\CustomFields\\Handler\\DataJson","Application\\DeskPRO\\CustomFields\\Handler\\Javascript","Application\\DeskPRO\\CustomFields\\Handler\\DataList","Application\\DeskPRO\\CustomFields\\Handler\\Url","Application\\DeskPRO\\CustomFields\\Handler\\Number","Application\\DeskPRO\\CustomFields\\Handler\\Currency","Application\\DeskPRO\\CustomFields\\Handler\\File","Application\\DeskPRO\\CustomFields\\Handler\\ExternalUniqueKey"]

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/organization_custom_fields/{parentId}/options CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organization_custom_field_options.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (CustomDefOrganization)	*
data[][title]		*
data[][parent]	object (CustomDefOrganization)	*	Field`s parent.
data[][parent][parent]	object (CustomDefOrganization)	*	Field`s parent.
data[][parent][children][]	array of objects (CustomDefOrganization)	*	Field children.
data[][children][]	array of objects (CustomDefOrganization)	*	Field children.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/organization_custom_fields/{parentId}/options CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organization_custom_field_options.post

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Required?	Format	Description
title	string	true
display_order	integer	false

Parameter	Type	Versions	Description
data.title		*
data.parent	object (CustomDefOrganization)	*	Field`s parent.
data.parent[parent]	object (CustomDefOrganization)	*	Field`s parent.
data.parent[children][]	array of objects (CustomDefOrganization)	*	Field children.
data.parent[title]		*
data.children[]	array of objects (CustomDefOrganization)	*	Field children.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/organization_custom_fields/{parentId}/options/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organization_custom_field_options.count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/organization_custom_fields/{parentId}/options/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organization_custom_field_options.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/organization_custom_fields/{parentId}/options/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organization_custom_field_options.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Versions	Description
data.title		*
data.parent	object (CustomDefOrganization)	*	Field`s parent.
data.parent[parent]	object (CustomDefOrganization)	*	Field`s parent.
data.parent[children][]	array of objects (CustomDefOrganization)	*	Field children.
data.parent[title]		*
data.children[]	array of objects (CustomDefOrganization)	*	Field children.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/organization_custom_fields/{parentId}/options/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organization_custom_field_options.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Required?	Format	Description
title	string	false
display_order	integer	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/organizations CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organizations.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

name

Description	name filter
Datatype	string
Pattern	\w+

Description	search filter (on name)
Datatype	string
Pattern	\w+

period_created

Description	period created filter
Datatype	string
Pattern	\w+

user_group

Description	usergroups filter
Datatype	array\|integer\|null
Pattern	[\d+,]+

labels

Description	labels filter option
Datatype	array
Pattern	[\w+,]+

org_field.{id}

Description	\n * Custom organization field filter. To filter by a custom field with ID=1 you need to add\n * ?org_field.1=value to the query string
Datatype	string
Pattern	\d+\|\w

Parameter	Type	Versions	Description
data[]	array of objects (Organization)	*
data[][id]	integer	*	The unique organization ID.
data[][name]	string	*	The organization name.
data[][summary]	string	*	Short organization description.
data[][importance]	integer	*	Organization importance.
data[][fields][]	dynamically declared custom fields (organization)	*	Custom organization fields.
data[][user_groups][]	array of integer ids (Usergroup)	*	Usergroups associated with this organization.
data[][labels][]	array of objects (label)	*	Labels associated with this organization.
data[][contact_data]	array	*	Organization contacts.
data[][emails][]	array of strings	*	Organization emails.
data[][email_domains][]	array of string representations (OrganizationEmailDomain)	*	Organization email domains.
data[][date_created]	DateTime	*	Date when this organization was created.
data[][parent]	integer id (Organization)	*	Organization parent (this is organization too).
data[][chats_count]	integer	*	How many chats organization participating.
data[][tickets_count]	integer	*	How many tickets organization participating.
data[][phone_numbers][]	array of objects (OrganizationPhoneNumber)	*	Phone numbers belong to organization.
data[][phone_numbers][][number]	string	*	The number, stored in E.164 string format, ie. +19021111111.
data[][phone_numbers][][label]	string	*	A human-defined (optional) label to describe what this phone number is.
data[][phone_numbers][][extension]	string	*	An extension for the number - optional.
data[][phone_numbers][][organization]	integer id (Person)	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/organizations CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organizations.post

Parameters
Response
Status Codes

Parameter	Type	Required?	Format
name	string	true
parent	choice	true
picture_blob	string	false
summary	string	false
importance	integer	false
labels[]	array of strings	false
user_groups[]	array of choices	false
emails[]	array of strings	false
email_domains[]	array of strings	false
children[]	array of choices	false
fields[1][mode]	string	false
fields[1][criteria]	string	false
fields[1][data]	choice	true
fields[5][mode]	string	false
fields[5][criteria]	string	false
fields[5][data]	string	true
fields[6][mode]	string	false
fields[6][criteria]	string	false
fields[6][data]	string	true
fields[7][mode]	string	false
fields[7][criteria]	string	false
fields[7][data][]	array of choices	true
fields[11][mode]	string	false
fields[11][criteria]	string	false
fields[11][data]	date	true	yyyy-MM-dd
fields[12][mode]	string	false
fields[12][criteria]	string	false
fields[12][data]	choice	true
fields[19][mode]	string	false
fields[19][criteria]	string	false
fields[19][data][]	array of choices	true
fields[24][mode]	string	false
fields[24][criteria]	string	false
fields[24][data]	choice	true
fields[31][mode]	string	false
fields[31][criteria]	string	false
fields[31][data][]	array of choices	true
fields[36][mode]	string	false
fields[36][criteria]	string	false
fields[36][data]	choice	true
fields[45][mode]	string	false
fields[45][criteria]	string	false
fields[45][data]	datetime	true	yyyy-MM-dd'T'HH:mm:ss
contact_data[website][][comment]	string	false
contact_data[website][][url]	string	true
contact_data[instant_message][][comment]	string	false
contact_data[instant_message][][service]	choice	true	["aim","msn","icq","skype","gtalk","whatsapp","other"]
contact_data[instant_message][][username]	string	true
contact_data[twitter][][comment]	string	false
contact_data[twitter][][username]	string	true
contact_data[twitter][][display_feed]	boolean	true
contact_data[linked_in][][comment]	string	false
contact_data[linked_in][][url]	string	true
contact_data[facebook][][comment]	string	false
contact_data[facebook][][url]	string	true
contact_data[address][][comment]	string	false
contact_data[address][][address]	string	true
contact_data[address][][city]	string	true
contact_data[address][][state]	string	true
contact_data[address][][zip]	string	true
contact_data[address][][country]	string	true
contact_data[apple][][comment]	string	false
contact_data[apple][][username]	string	true
contact_data[trust_pilot][][comment]	string	false
contact_data[trust_pilot][][username]	string	true
contact_data[instagram][][comment]	string	false
contact_data[instagram][][username]	string	true
contact_data[instagram][][instagram_id]	string	true
contact_data[facebook_page][][comment]	string	false
contact_data[facebook_page][][url]	string	true
members[][person]	choice	true
members[][position]	string	false
members[][manager]	boolean	false
phone_numbers[][number]	string	true
phone_numbers[][extension]	string	false
phone_numbers[][label]	string	false

Parameter	Type	Versions	Description
data.id	integer	*	The unique organization ID.
data.name	string	*	The organization name.
data.summary	string	*	Short organization description.
data.importance	integer	*	Organization importance.
data.fields[]	dynamically declared custom fields (organization)	*	Custom organization fields.
data.user_groups[]	array of integer ids (Usergroup)	*	Usergroups associated with this organization.
data.labels[]	array of objects (label)	*	Labels associated with this organization.
data.contact_data	array	*	Organization contacts.
data.emails[]	array of strings	*	Organization emails.
data.email_domains[]	array of string representations (OrganizationEmailDomain)	*	Organization email domains.
data.date_created	DateTime	*	Date when this organization was created.
data.parent	integer id (Organization)	*	Organization parent (this is organization too).
data.chats_count	integer	*	How many chats organization participating.
data.tickets_count	integer	*	How many tickets organization participating.
data.phone_numbers[]	array of objects (OrganizationPhoneNumber)	*	Phone numbers belong to organization.
data.phone_numbers[][number]	string	*	The number, stored in E.164 string format, ie. +19021111111.
data.phone_numbers[][label]	string	*	A human-defined (optional) label to describe what this phone number is.
data.phone_numbers[][extension]	string	*	An extension for the number - optional.
data.phone_numbers[][organization]	integer id (Person)	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/organizations/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organizations.count

Filters
Response
Status Codes

Name

Information

name

Description	name filter
Datatype	string
Pattern	\w+

Description	search filter (on name)
Datatype	string
Pattern	\w+

period_created

Description	period created filter
Datatype	string
Pattern	\w+

user_group

Description	usergroups filter
Datatype	array\|integer\|null
Pattern	[\d+,]+

labels

Description	labels filter option
Datatype	array
Pattern	[\w+,]+

org_field.{id}

Description	\n * Custom organization field filter. To filter by a custom field with ID=1 you need to add\n * ?org_field.1=value to the query string
Datatype	string
Pattern	\d+\|\w

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/organizations/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organizations.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/organizations/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organizations.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.id	integer	*	The unique organization ID.
data.name	string	*	The organization name.
data.summary	string	*	Short organization description.
data.importance	integer	*	Organization importance.
data.fields[]	dynamically declared custom fields (organization)	*	Custom organization fields.
data.user_groups[]	array of integer ids (Usergroup)	*	Usergroups associated with this organization.
data.labels[]	array of objects (label)	*	Labels associated with this organization.
data.contact_data[]	array	*	Organization contacts.
data.emails[]	array of strings	*	Organization emails.
data.email_domains[]	array of string representations (OrganizationEmailDomain)	*	Organization email domains.
data.date_created	DateTime	*	Date when this organization was created.
data.parent	integer id (Organization)	*	Organization parent (this is organization too).
data.chats_count	integer	*	How many chats organization participating.
data.tickets_count	integer	*	How many tickets organization participating.
data.phone_numbers[]	array of objects (OrganizationPhoneNumber)	*	Phone numbers belong to organization.
data.phone_numbers[][number]	string	*	The number, stored in E.164 string format, ie. +19021111111.
data.phone_numbers[][label]	string	*	A human-defined (optional) label to describe what this phone number is.
data.phone_numbers[][extension]	string	*	An extension for the number - optional.
data.phone_numbers[][organization]	integer id (Person)	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/organizations/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organizations.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format
name	string	false
parent	choice	false
picture_blob	string	false
summary	string	false
importance	integer	false
labels[]	array of strings	false
user_groups[]	array of choices	false
emails[]	array of strings	false
email_domains[]	array of strings	false
children[]	array of choices	false
fields[1][mode]	string	false
fields[1][criteria]	string	false
fields[1][data]	choice	false
fields[5][mode]	string	false
fields[5][criteria]	string	false
fields[5][data]	string	false
fields[6][mode]	string	false
fields[6][criteria]	string	false
fields[6][data]	string	false
fields[7][mode]	string	false
fields[7][criteria]	string	false
fields[7][data][]	array of choices	false
fields[11][mode]	string	false
fields[11][criteria]	string	false
fields[11][data]	date	false	yyyy-MM-dd
fields[12][mode]	string	false
fields[12][criteria]	string	false
fields[12][data]	choice	false
fields[19][mode]	string	false
fields[19][criteria]	string	false
fields[19][data][]	array of choices	false
fields[24][mode]	string	false
fields[24][criteria]	string	false
fields[24][data]	choice	false
fields[31][mode]	string	false
fields[31][criteria]	string	false
fields[31][data][]	array of choices	false
fields[36][mode]	string	false
fields[36][criteria]	string	false
fields[36][data]	choice	false
fields[45][mode]	string	false
fields[45][criteria]	string	false
fields[45][data]	datetime	false	yyyy-MM-dd'T'HH:mm:ss
contact_data[website][][comment]	string	false
contact_data[website][][url]	string	false
contact_data[instant_message][][comment]	string	false
contact_data[instant_message][][service]	choice	false	["aim","msn","icq","skype","gtalk","whatsapp","other"]
contact_data[instant_message][][username]	string	false
contact_data[twitter][][comment]	string	false
contact_data[twitter][][username]	string	false
contact_data[twitter][][display_feed]	boolean	false
contact_data[linked_in][][comment]	string	false
contact_data[linked_in][][url]	string	false
contact_data[facebook][][comment]	string	false
contact_data[facebook][][url]	string	false
contact_data[address][][comment]	string	false
contact_data[address][][address]	string	false
contact_data[address][][city]	string	false
contact_data[address][][state]	string	false
contact_data[address][][zip]	string	false
contact_data[address][][country]	string	false
contact_data[apple][][comment]	string	false
contact_data[apple][][username]	string	false
contact_data[trust_pilot][][comment]	string	false
contact_data[trust_pilot][][username]	string	false
contact_data[instagram][][comment]	string	false
contact_data[instagram][][username]	string	false
contact_data[instagram][][instagram_id]	string	false
contact_data[facebook_page][][comment]	string	false
contact_data[facebook_page][][url]	string	false
members[][person]	choice	false
members[][position]	string	false
members[][manager]	boolean	false
phone_numbers[][number]	string	false
phone_numbers[][extension]	string	false
phone_numbers[][label]	string	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/organizations/{id}/tickets

Get tickets of the given organization

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organizations.get_tickets

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id		int

Parameter	Type	Versions	Description
data[]	array of objects (Ticket)	*
data[][id]	integer	*	The unique ID.
data[][ref]	string	*	String reference.
data[][auth]	string	*	Auth string.
data[][parent]	integer id (Ticket)	*	Parent of this ticket.
data[][language]	integer id (Language)	*	Language associated with this ticket.
data[][brand]	integer id (Brand)	*	Ticket brand.
data[][department]	integer id (Department)	*	Ticket where this department is processing.
data[][category]	integer id (TicketCategory)	*	Category of this ticket.
data[][priority]	integer id (TicketPriority)	*	Priority of this ticket.
data[][workflow]	integer id (TicketWorkflow)	*	Workflow entity.
data[][product]	integer id (Product)	*	Product about which this ticket.
data[][person]	integer id (Person)	*	Person created this ticket.
data[][person_email]	string representation (PersonEmail)	*	Person's email.
data[][agent]	integer id (Person)	*	Agent assigned.
data[][agent_team]	integer id (AgentTeam)	*	Agent team where this ticket is processing.
data[][organization]	integer id (Organization)	*	Organization team where this ticket is processing.
data[][linked_chat]	integer id (ChatConversation)	*	ChatConversation where this ticket is discussed.
data[][sent_to_address]	array	*	Addresses where ticket was send.
data[][email_account]	integer id (EmailAccount)	*	Email account used to gather the ticket.
data[][email_account_address]	string	*	Email account address used to gather the ticket.
data[][creation_system]	string	*	How this ticket appears.
data[][creation_system_option]	string	*	Option used by creation system.
data[][ticket_hash]	string	*	Unique hash.
data[][status]	string	<=20170400	Legacy ticket status.
data[][hidden_status]	string	<=20170400	Legacy ticket hidden status.
data[][ticket_status]	string	*	Ticket status.
data[][is_hold]	boolean	*	Is this on hold?
data[][labels][]	array of strings	*	String array of labels.
data[][urgency]	integer	*	How urgent this ticket?
data[][feedback_rating]	integer	*	Its rating based on feedback votes.
data[][date_feedback_rating]	DateTime	*	When the rating was calculated.
data[][date_created]	DateTime	*	When the ticket was created.
data[][date_resolved]	DateTime	*	When the ticket was resolved.
data[][date_archived]	DateTime	*	And archived at last.
data[][date_first_agent_assign]	DateTime	*	When it was assigned to agent at the very first time.
data[][date_first_agent_reply]	DateTime	*	When it was first time replied.
data[][date_last_agent_reply]	DateTime	*	And when it was replied the last time.
data[][date_last_user_reply]	DateTime	*	And the date user replied here last time.
data[][date_agent_waiting]	DateTime	*	Time when agent started to wait user.
data[][date_user_waiting]	DateTime	*	And the time when user started to wait agent.
data[][date_status]	DateTime	*	When status was changed.
data[][total_user_waiting]	integer	*	How much user was waited?
data[][total_to_first_reply]	integer	*	Total waiting before first reply.
data[][total_user_waiting_wh]	integer	*	Total user waiting in working hours.
data[][total_to_first_reply_wh]	integer	*	Total waiting before first reply in working hour.
data[][locked_by_agent]	integer id (Person)	*	An agent who locked the ticket.
data[][date_locked]	DateTime	*	Date time when ticket was locked.
data[][date_on_hold]	DateTime	*	Datetime when ticket was set on hold.
data[][has_attachments]	boolean	*	Does this ticket has attachments?
data[][subject]	string	*	Ticket subject.
data[][original_subject]	string	*	Original subject given by creator.
data[][properties]	array	*	Array of properties.
data[][problems][]	array of integer ids (Problem)	*	An array of associated problems.
data[][count_agent_replies]	integer	*	Count of all replies made by agents.
data[][count_user_replies]	integer	*	Count of all replies made by user.
data[][worst_sla_status]	string	*	Well, this is worst SLA status.
data[][waiting_times]	array	*	An array of waiting times.
data[][ticket_slas][]	array of integer ids (TicketSla)	*	All ticket SLAS.
data[][fields][]	dynamically declared custom fields (ticket)	*	Custom ticket fields.
data[][contextual_fields]	custom handler result for (custom_per_data)	*	Contextual ticket fields (per user/org fields).
data[][children][]	array of integer ids (Ticket)	*	Ticket children.
data[][siblings][]	array of integer ids (Ticket)	*	Ticket siblings.
data[][cc][]	array of integer ids (Person)	*	User should be acknowledged about this ticket.
data[][star]	string	*	Person star color.
data[][ticket_layout]	custom handler result for (raw)	*
data[][ticket_excerpt]	custom handler result for (raw)	*
data[][ticket_agent_errors]	custom handler result for (raw)	*
data[][ticket_user_errors]	custom handler result for (raw)	*
data[][ticket_permissions]	custom handler result for (raw)	*
data[][access_code]	string	*	Access code.
data[][followers]	string	*	Followers of that ticket as a comma-separated list of names.

Status Code	Description
200	Everything is OK
400	Malformed request

GET /api/v2/organizations/{parentId}/contact_data CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organization_contact_data.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (AbstractContactData)	*
data[][id]	integer	*	The unique ID.
data[][contact_type]	string	*	Contact type.
data[][comment]	string	*	Comment attached to contact.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

GET /api/v2/organizations/{parentId}/contact_data/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organization_contact_data.count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

GET /api/v2/organizations/{parentId}/contact_data/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organization_contact_data.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.contact_type	string	*	Contact type.
data.comment	string	*	Comment attached to contact.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

GET /api/v2/organizations/{parentId}/members CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organization_members.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (Person)	*
data[][id]	integer	*	The unique ID of person.
data[][primary_email]	string representation (PersonEmail)	*	Emails belong to user.
data[][first_name]	string	*	The users name (best guess from other sources etc).
data[][last_name]	string	*	The users name (best guess from other sources etc).
data[][title_prefix]	string	*	The users title.
data[][name]	string	*	The users name (best guess from other sources etc).
data[][display_name]	string	*	Person name.
data[][is_agent]	boolean	*	True if person is agent.
data[][avatar]	object (Avatar)	*	Person`s avatar.
data[][avatar][default_url_pattern]	string	*	Default pattern used if there is no custom one.
data[][avatar][url_pattern]	string	*	Url pattern for avatar gathering.
data[][avatar][base_gravatar_url]	string	*	Url to gravatar.
data[][online]	boolean	*	Is user online?
data[][online_for_chat]	boolean	*	Is user online for chat?
data[][last_seen]	DateTime	*	Date when user was last seen online.
data[][agent_data]	object (AgentData)	*	Agent data.
data[][agent_data][extension_number]	integer	*
data[][agent_data][available_status]	string	*
data[][agent_data][agent_calls_enabled]	boolean	*
data[][agent_data][agent_chat_enabled]	boolean	*
data[][agent_data][agent_can_use_forwarding]	boolean	*
data[][agent_data][forwarding_number]	string	*
data[][agent_data][forwarding_ring_timeout]	integer	*
data[][agent_data][forwarding_number_type]	string	*
data[][agent_data][forwarding_logged_out]	boolean	*
data[][agent_data][work_status_enabled]	boolean	*
data[][agent_data][work_status_managed_after]	DateTime	*
data[][agent_data][login_status]	string	*
data[][was_agent]	boolean	*	Was this person an agent?
data[][can_agent]	boolean	*	Is person allowed to use agent interface.
data[][can_admin]	boolean	*	Is person allowed to use admin interface.
data[][can_billing]	boolean	*	Is person allowed to use billing interface.
data[][can_reports]	boolean	*	Is person allowed to use reports interface.
data[][picture_blob]	integer id (Blob)	*	The user`s profile picture.
data[][disable_picture]	boolean	*	True if user`s picture disabled.
data[][gravatar_url]	string	*	The URL to the users gravatar if any.
data[][is_contact]	boolean	*	Is this person a contact?
data[][disable_autoresponses]	boolean	*	Are autoresponses disabled?
data[][disable_autoresponses_log]	string	*	Disabled autoresponses log.
data[][is_confirmed]	boolean	*	Has person confirmed their email?
data[][is_deleted]	boolean	*	Is the user deleted?
data[][is_disabled]	boolean	*	Is the user disabled?
data[][creation_system]	string	*	The way person was created.
data[][override_display_name]	string	*	Overrides the display name of an person in the user interface (agents only).
data[][display_contact]	string	*	Person name and email address.
data[][summary]	string	*	The summary field as filled in by agents.
data[][language]	integer id (Language)	*	Default person`s language.
data[][organization]	integer id (Organization)	*	The person`s organization.
data[][organization_members][]	array of integer ids (OrganizationMember)	*	Organizations the person is member of.
data[][organization_position]	string	*	The persons position at the organization.
data[][organization_manager]	boolean	*	True if the person is a manager of their organization.
data[][timezone]	string	*	The timezone associated with this user.
data[][date_created]	DateTime	*	The date the user was inserted into the system.
data[][date_last_login]	DateTime	*	The date the user was logged in last time.
data[][browser]	string	*	The browser person was used last time.
data[][all_user_groups][]	array of integer ids (Usergroup)	*	Usergroups the user belongs to including through connections like org groups.
data[][user_groups][]	array of integer ids (Usergroup)	*	Usergroups the user belongs to.
data[][agent_groups][]	array of integer ids (Usergroup)	*	Usergroups the user belongs to.
data[][labels][]	array of objects (label)	*	Labels associated with this user.
data[][emails][]	array of string representations (PersonEmail)	*	Emails belong to user.
data[][phone_numbers][]	array of objects (PersonPhoneNumber)	*	Phone numbers belong to user.
data[][phone_numbers][][number]	string	*	The number, stored in E.164 string format, ie. +19021111111.
data[][phone_numbers][][label]	string	*	A human-defined (optional) label to describe what this phone number is.
data[][phone_numbers][][extension]	string	*	An extension for the number - optional.
data[][phone_numbers][][person]	integer id (Person)	*
data[][tickets_count]	integer	*	Overall tickets count assigned to user.
data[][chats_count]	integer	*	Overall count of chats user participating.
data[][fields][]	dynamically declared custom fields (person)	*	Custom persons data.
data[][contextual_options]	custom handler result for (contextual_options)	*	Contextual person options.
data[][contact_data]	array	*	Contacts for this user.
data[][teams][]	array of integer ids (AgentTeam)	*	Agent teams.
data[][primary_team]	integer id (AgentTeam)	*	Primary agent team.
data[][brands][]	array of integer ids (Brand)	*	Brands.
data[][preferences]	array	*	Prefs.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/organizations/{parentId}/members CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organization_members.post

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Required?
person	choice	true
position	string	false
manager	boolean	false

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID of person.
data.primary_email	string representation (PersonEmail)	*	Emails belong to user.
data.first_name	string	*	The users name (best guess from other sources etc).
data.last_name	string	*	The users name (best guess from other sources etc).
data.title_prefix	string	*	The users title.
data.name	string	*	The users name (best guess from other sources etc).
data.display_name	string	*	Person name.
data.is_agent	boolean	*	True if person is agent.
data.avatar	object (Avatar)	*	Person`s avatar.
data.avatar[default_url_pattern]	string	*	Default pattern used if there is no custom one.
data.avatar[url_pattern]	string	*	Url pattern for avatar gathering.
data.avatar[base_gravatar_url]	string	*	Url to gravatar.
data.online	boolean	*	Is user online?
data.online_for_chat	boolean	*	Is user online for chat?
data.last_seen	DateTime	*	Date when user was last seen online.
data.agent_data	object (AgentData)	*	Agent data.
data.agent_data[extension_number]	integer	*
data.agent_data[available_status]	string	*
data.agent_data[agent_calls_enabled]	boolean	*
data.agent_data[agent_chat_enabled]	boolean	*
data.agent_data[agent_can_use_forwarding]	boolean	*
data.agent_data[forwarding_number]	string	*
data.agent_data[forwarding_ring_timeout]	integer	*
data.agent_data[forwarding_number_type]	string	*
data.agent_data[forwarding_logged_out]	boolean	*
data.agent_data[work_status_enabled]	boolean	*
data.agent_data[work_status_managed_after]	DateTime	*
data.agent_data[login_status]	string	*
data.agent_data[extensionNumber]		*
data.agent_data[voicemailAsset]		*
data.agent_data[availableStatus]		*
data.agent_data[forwardingNumber]		*
data.agent_data[loginStatus]		*
data.was_agent	boolean	*	Was this person an agent?
data.can_agent	boolean	*	Is person allowed to use agent interface.
data.can_admin	boolean	*	Is person allowed to use admin interface.
data.can_billing	boolean	*	Is person allowed to use billing interface.
data.can_reports	boolean	*	Is person allowed to use reports interface.
data.picture_blob	integer id (Blob)	*	The user`s profile picture.
data.disable_picture	boolean	*	True if user`s picture disabled.
data.gravatar_url	string	*	The URL to the users gravatar if any.
data.is_contact	boolean	*	Is this person a contact?
data.disable_autoresponses	boolean	*	Are autoresponses disabled?
data.disable_autoresponses_log	string	*	Disabled autoresponses log.
data.is_confirmed	boolean	*	Has person confirmed their email?
data.is_deleted	boolean	*	Is the user deleted?
data.is_disabled	boolean	*	Is the user disabled?
data.creation_system	string	*	The way person was created.
data.override_display_name	string	*	Overrides the display name of an person in the user interface (agents only).
data.display_contact	string	*	Person name and email address.
data.summary	string	*	The summary field as filled in by agents.
data.language	integer id (Language)	*	Default person`s language.
data.organization	integer id (Organization)	*	The person`s organization.
data.organization_members[]	array of integer ids (OrganizationMember)	*	Organizations the person is member of.
data.organization_position	string	*	The persons position at the organization.
data.organization_manager	boolean	*	True if the person is a manager of their organization.
data.timezone	string	*	The timezone associated with this user.
data.date_created	DateTime	*	The date the user was inserted into the system.
data.date_last_login	DateTime	*	The date the user was logged in last time.
data.browser	string	*	The browser person was used last time.
data.all_user_groups[]	array of integer ids (Usergroup)	*	Usergroups the user belongs to including through connections like org groups.
data.user_groups[]	array of integer ids (Usergroup)	*	Usergroups the user belongs to.
data.agent_groups[]	array of integer ids (Usergroup)	*	Usergroups the user belongs to.
data.labels[]	array of objects (label)	*	Labels associated with this user.
data.emails[]	array of string representations (PersonEmail)	*	Emails belong to user.
data.phone_numbers[]	array of objects (PersonPhoneNumber)	*	Phone numbers belong to user.
data.phone_numbers[][number]	string	*	The number, stored in E.164 string format, ie. +19021111111.
data.phone_numbers[][label]	string	*	A human-defined (optional) label to describe what this phone number is.
data.phone_numbers[][extension]	string	*	An extension for the number - optional.
data.phone_numbers[][person]	integer id (Person)	*
data.tickets_count	integer	*	Overall tickets count assigned to user.
data.chats_count	integer	*	Overall count of chats user participating.
data.fields[]	dynamically declared custom fields (person)	*	Custom persons data.
data.contextual_options	custom handler result for (contextual_options)	*	Contextual person options.
data.contact_data	array	*	Contacts for this user.
data.teams[]	array of integer ids (AgentTeam)	*	Agent teams.
data.primary_team	integer id (AgentTeam)	*	Primary agent team.
data.brands[]	array of integer ids (Brand)	*	Brands.
data.preferences	array	*	Prefs.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/organizations/{parentId}/members/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organization_members.count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/organizations/{parentId}/members/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organization_members.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/organizations/{parentId}/members/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organization_members.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID of person.
data.primary_email	string representation (PersonEmail)	*	Emails belong to user.
data.first_name	string	*	The users name (best guess from other sources etc).
data.last_name	string	*	The users name (best guess from other sources etc).
data.title_prefix	string	*	The users title.
data.name	string	*	The users name (best guess from other sources etc).
data.display_name	string	*	Person name.
data.is_agent	boolean	*	True if person is agent.
data.avatar	object (Avatar)	*	Person`s avatar.
data.avatar[default_url_pattern]	string	*	Default pattern used if there is no custom one.
data.avatar[url_pattern]	string	*	Url pattern for avatar gathering.
data.avatar[base_gravatar_url]	string	*	Url to gravatar.
data.online	boolean	*	Is user online?
data.online_for_chat	boolean	*	Is user online for chat?
data.last_seen	DateTime	*	Date when user was last seen online.
data.agent_data	object (AgentData)	*	Agent data.
data.agent_data[extension_number]	integer	*
data.agent_data[available_status]	string	*
data.agent_data[agent_calls_enabled]	boolean	*
data.agent_data[agent_chat_enabled]	boolean	*
data.agent_data[agent_can_use_forwarding]	boolean	*
data.agent_data[forwarding_number]	string	*
data.agent_data[forwarding_ring_timeout]	integer	*
data.agent_data[forwarding_number_type]	string	*
data.agent_data[forwarding_logged_out]	boolean	*
data.agent_data[work_status_enabled]	boolean	*
data.agent_data[work_status_managed_after]	DateTime	*
data.agent_data[login_status]	string	*
data.agent_data[extensionNumber]		*
data.agent_data[voicemailAsset]		*
data.agent_data[availableStatus]		*
data.agent_data[forwardingNumber]		*
data.agent_data[loginStatus]		*
data.was_agent	boolean	*	Was this person an agent?
data.can_agent	boolean	*	Is person allowed to use agent interface.
data.can_admin	boolean	*	Is person allowed to use admin interface.
data.can_billing	boolean	*	Is person allowed to use billing interface.
data.can_reports	boolean	*	Is person allowed to use reports interface.
data.picture_blob	integer id (Blob)	*	The user`s profile picture.
data.disable_picture	boolean	*	True if user`s picture disabled.
data.gravatar_url	string	*	The URL to the users gravatar if any.
data.is_contact	boolean	*	Is this person a contact?
data.disable_autoresponses	boolean	*	Are autoresponses disabled?
data.disable_autoresponses_log	string	*	Disabled autoresponses log.
data.is_confirmed	boolean	*	Has person confirmed their email?
data.is_deleted	boolean	*	Is the user deleted?
data.is_disabled	boolean	*	Is the user disabled?
data.creation_system	string	*	The way person was created.
data.override_display_name	string	*	Overrides the display name of an person in the user interface (agents only).
data.display_contact	string	*	Person name and email address.
data.summary	string	*	The summary field as filled in by agents.
data.language	integer id (Language)	*	Default person`s language.
data.organization	integer id (Organization)	*	The person`s organization.
data.organization_members[]	array of integer ids (OrganizationMember)	*	Organizations the person is member of.
data.organization_position	string	*	The persons position at the organization.
data.organization_manager	boolean	*	True if the person is a manager of their organization.
data.timezone	string	*	The timezone associated with this user.
data.date_created	DateTime	*	The date the user was inserted into the system.
data.date_last_login	DateTime	*	The date the user was logged in last time.
data.browser	string	*	The browser person was used last time.
data.all_user_groups[]	array of integer ids (Usergroup)	*	Usergroups the user belongs to including through connections like org groups.
data.user_groups[]	array of integer ids (Usergroup)	*	Usergroups the user belongs to.
data.agent_groups[]	array of integer ids (Usergroup)	*	Usergroups the user belongs to.
data.labels[]	array of objects (label)	*	Labels associated with this user.
data.emails[]	array of string representations (PersonEmail)	*	Emails belong to user.
data.phone_numbers[]	array of objects (PersonPhoneNumber)	*	Phone numbers belong to user.
data.phone_numbers[][number]	string	*	The number, stored in E.164 string format, ie. +19021111111.
data.phone_numbers[][label]	string	*	A human-defined (optional) label to describe what this phone number is.
data.phone_numbers[][extension]	string	*	An extension for the number - optional.
data.phone_numbers[][person]	integer id (Person)	*
data.tickets_count	integer	*	Overall tickets count assigned to user.
data.chats_count	integer	*	Overall count of chats user participating.
data.fields[]	dynamically declared custom fields (person)	*	Custom persons data.
data.contextual_options	custom handler result for (contextual_options)	*	Contextual person options.
data.contact_data	array	*	Contacts for this user.
data.teams[]	array of integer ids (AgentTeam)	*	Agent teams.
data.primary_team	integer id (AgentTeam)	*	Primary agent team.
data.brands[]	array of integer ids (Brand)	*	Brands.
data.preferences	array	*	Prefs.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/organizations/{parentId}/members/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organization_members.put

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/organizations/{parentId}/notes CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organization_notes.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (OrganizationNote)	*
data[][organization]	integer id (Organization)	*	The org the note is attached to.
data[][agent]	integer id (Person)	*	The agent that added the note.
data[][note]	string	*	The note contents.
data[][id]	integer	*	The unique note id.
data[][date_created]	DateTime	*	The date note was created.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/organizations/{parentId}/notes CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organization_notes.post

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Required?	Format	Description
note	string	true

Parameter	Type	Versions	Description
data.organization	integer id (Organization)	*	The org the note is attached to.
data.agent	integer id (Person)	*	The agent that added the note.
data.note	string	*	The note contents.
data.id	integer	*	The unique note id.
data.date_created	DateTime	*	The date note was created.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/organizations/{parentId}/notes/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organization_notes.count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/organizations/{parentId}/notes/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organization_notes.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/organizations/{parentId}/notes/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organization_notes.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Versions	Description
data.organization	integer id (Organization)	*	The org the note is attached to.
data.agent	integer id (Person)	*	The agent that added the note.
data.note	string	*	The note contents.
data.id	integer	*	The unique note id.
data.date_created	DateTime	*	The date note was created.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/organizations/{parentId}/notes/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

organizations.organization_notes.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Required?	Format	Description
note	string	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

Show/hide List Operations Expand Operations

People

GET /api/v2/people CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

people.people.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

order_by

Description	people list sort
Pattern	id\|date_created\|date_last_login\|name\|first_name\|last_name\|primary_email\|timezone\|organization
Datatype	string

order_dir

Description	list sort order
Datatype	string
Pattern	asc\|desc

primary_email

Description	primary email filter
Datatype	\w+

organization

Description	Comma separated list of IDs
Datatype	[\d+,]+

is_agent

Description	agents filter
Datatype	boolean

is_deleted

Pattern	(1\|0\|-1)
Description	deleted filter, defaults to 0
Datatype	integer

online

Pattern	(1\|0\|-1)
Description	is online filter, defaults to 0
Datatype	integer

online_for_chat

Pattern	(1\|0\|-1)
Description	is agent and online for chat filter, defaults to 0
Datatype	integer

not_me

Description	exclude yourself filter
Datatype	boolean

agent_team

Description	agent teams filter
Datatype	array\|integer\|null
Pattern	[\d+,]+

user_group

Description	usergroups filter
Datatype	array\|integer\|null
Pattern	[\d+,]+

label

Description	labels filter option
Datatype	array
Pattern	[\w+,]+

Description	search filter (on name)
Datatype	string
Pattern	\w+

person_field.{id}

Description	\n * Custom person field filter. To filter by a custom field with ID=1 you need to add\n * ?person_field.1=value to the query string
Datatype	string
Pattern	\d+\|\w

Parameter	Type	Versions	Description
data[]	array of objects (Person)	*
data[][id]	integer	*	The unique ID of person.
data[][primary_email]	string representation (PersonEmail)	*	Emails belong to user.
data[][first_name]	string	*	The users name (best guess from other sources etc).
data[][last_name]	string	*	The users name (best guess from other sources etc).
data[][title_prefix]	string	*	The users title.
data[][name]	string	*	The users name (best guess from other sources etc).
data[][display_name]	string	*	Person name.
data[][is_agent]	boolean	*	True if person is agent.
data[][avatar]	object (Avatar)	*	Person`s avatar.
data[][avatar][default_url_pattern]	string	*	Default pattern used if there is no custom one.
data[][avatar][url_pattern]	string	*	Url pattern for avatar gathering.
data[][avatar][base_gravatar_url]	string	*	Url to gravatar.
data[][online]	boolean	*	Is user online?
data[][online_for_chat]	boolean	*	Is user online for chat?
data[][last_seen]	DateTime	*	Date when user was last seen online.
data[][agent_data]	object (AgentData)	*	Agent data.
data[][agent_data][extension_number]	integer	*
data[][agent_data][available_status]	string	*
data[][agent_data][agent_calls_enabled]	boolean	*
data[][agent_data][agent_chat_enabled]	boolean	*
data[][agent_data][agent_can_use_forwarding]	boolean	*
data[][agent_data][forwarding_number]	string	*
data[][agent_data][forwarding_ring_timeout]	integer	*
data[][agent_data][forwarding_number_type]	string	*
data[][agent_data][forwarding_logged_out]	boolean	*
data[][agent_data][work_status_enabled]	boolean	*
data[][agent_data][work_status_managed_after]	DateTime	*
data[][agent_data][login_status]	string	*
data[][was_agent]	boolean	*	Was this person an agent?
data[][can_agent]	boolean	*	Is person allowed to use agent interface.
data[][can_admin]	boolean	*	Is person allowed to use admin interface.
data[][can_billing]	boolean	*	Is person allowed to use billing interface.
data[][can_reports]	boolean	*	Is person allowed to use reports interface.
data[][picture_blob]	integer id (Blob)	*	The user`s profile picture.
data[][disable_picture]	boolean	*	True if user`s picture disabled.
data[][gravatar_url]	string	*	The URL to the users gravatar if any.
data[][is_contact]	boolean	*	Is this person a contact?
data[][disable_autoresponses]	boolean	*	Are autoresponses disabled?
data[][disable_autoresponses_log]	string	*	Disabled autoresponses log.
data[][is_confirmed]	boolean	*	Has person confirmed their email?
data[][is_deleted]	boolean	*	Is the user deleted?
data[][is_disabled]	boolean	*	Is the user disabled?
data[][creation_system]	string	*	The way person was created.
data[][override_display_name]	string	*	Overrides the display name of an person in the user interface (agents only).
data[][display_contact]	string	*	Person name and email address.
data[][summary]	string	*	The summary field as filled in by agents.
data[][language]	integer id (Language)	*	Default person`s language.
data[][organization]	integer id (Organization)	*	The person`s organization.
data[][organization_members][]	array of integer ids (OrganizationMember)	*	Organizations the person is member of.
data[][organization_position]	string	*	The persons position at the organization.
data[][organization_manager]	boolean	*	True if the person is a manager of their organization.
data[][timezone]	string	*	The timezone associated with this user.
data[][date_created]	DateTime	*	The date the user was inserted into the system.
data[][date_last_login]	DateTime	*	The date the user was logged in last time.
data[][browser]	string	*	The browser person was used last time.
data[][all_user_groups][]	array of integer ids (Usergroup)	*	Usergroups the user belongs to including through connections like org groups.
data[][user_groups][]	array of integer ids (Usergroup)	*	Usergroups the user belongs to.
data[][agent_groups][]	array of integer ids (Usergroup)	*	Usergroups the user belongs to.
data[][labels][]	array of objects (label)	*	Labels associated with this user.
data[][emails][]	array of string representations (PersonEmail)	*	Emails belong to user.
data[][phone_numbers][]	array of objects (PersonPhoneNumber)	*	Phone numbers belong to user.
data[][phone_numbers][][number]	string	*	The number, stored in E.164 string format, ie. +19021111111.
data[][phone_numbers][][label]	string	*	A human-defined (optional) label to describe what this phone number is.
data[][phone_numbers][][extension]	string	*	An extension for the number - optional.
data[][phone_numbers][][person]	integer id (Person)	*
data[][tickets_count]	integer	*	Overall tickets count assigned to user.
data[][chats_count]	integer	*	Overall count of chats user participating.
data[][fields][]	dynamically declared custom fields (person)	*	Custom persons data.
data[][contextual_options]	custom handler result for (contextual_options)	*	Contextual person options.
data[][contact_data]	array	*	Contacts for this user.
data[][teams][]	array of integer ids (AgentTeam)	*	Agent teams.
data[][primary_team]	integer id (AgentTeam)	*	Primary agent team.
data[][brands][]	array of integer ids (Brand)	*	Brands.
data[][preferences]	array	*	Prefs.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

GET /api/v2/people/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

people.people.count

Filters
Response
Status Codes

Name

Information

order_by

Description	people list sort
Pattern	id\|date_created\|date_last_login\|name\|first_name\|last_name\|primary_email\|timezone\|organization
Datatype	string

order_dir

Description	list sort order
Datatype	string
Pattern	asc\|desc

primary_email

Description	primary email filter
Datatype	\w+

organization

Description	Comma separated list of IDs
Datatype	[\d+,]+

is_agent

Description	agents filter
Datatype	boolean

is_deleted

Pattern	(1\|0\|-1)
Description	deleted filter, defaults to 0
Datatype	integer

online

Pattern	(1\|0\|-1)
Description	is online filter, defaults to 0
Datatype	integer

online_for_chat

Pattern	(1\|0\|-1)
Description	is agent and online for chat filter, defaults to 0
Datatype	integer

not_me

Description	exclude yourself filter
Datatype	boolean

agent_team

Description	agent teams filter
Datatype	array\|integer\|null
Pattern	[\d+,]+

user_group

Description	usergroups filter
Datatype	array\|integer\|null
Pattern	[\d+,]+

label

Description	labels filter option
Datatype	array
Pattern	[\w+,]+

Description	search filter (on name)
Datatype	string
Pattern	\w+

person_field.{id}

Description	\n * Custom person field filter. To filter by a custom field with ID=1 you need to add\n * ?person_field.1=value to the query string
Datatype	string
Pattern	\d+\|\w

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

POST /api/v2/people/onboarding CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.people_onboarding.post

Parameters
Response
Status Codes

Parameter	Type	Required?	Format
status	integer	true
date_completion	datetime	false	yyyy-MM-dd'T'HH:mm:ss
current_step	integer	false

Parameter	Type	Versions	Description
data.person		*
data.status	integer	*	Message status (0 - new, 1 - in progress, 2 - completed).
data.id	integer	*	The unique log id.
data.current_step	integer	*
data.onboarding_class	string	*
data.application	string	*
data.date_completion	DateTime	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/people/onboarding/new

Get current user available onboardings

Applicable api modes

session token key oauth

Api tags for this endpoint

people.people_onboarding.get_new

Response
Status Codes

Parameter	Type	Versions	Description
data[]	array of objects (PersonOnboarding)	*
data[][person]		*
data[][status]	integer	*	Message status (0 - new, 1 - in progress, 2 - completed).
data[][id]	integer	*	The unique log id.
data[][current_step]	integer	*
data[][onboarding_class]	string	*
data[][application]	string	*
data[][date_completion]	DateTime	*

Status Code	Description
200	Success
404	Not Found error will returned in case there is no available onboardings

GET /api/v2/people/onboarding/pending

Get current user pending onboardings

Applicable api modes

session token key oauth

Api tags for this endpoint

people.people_onboarding.get_pending

Response
Status Codes

Parameter	Type	Versions	Description
data[]	array of objects (PersonOnboarding)	*
data[][person]		*
data[][status]	integer	*	Message status (0 - new, 1 - in progress, 2 - completed).
data[][id]	integer	*	The unique log id.
data[][current_step]	integer	*
data[][onboarding_class]	string	*
data[][application]	string	*
data[][date_completion]	DateTime	*

Status Code	Description
200	Success
404	Not Found error will returned in case there is no available onboardings

PUT /api/v2/people/onboarding/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.people_onboarding.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format
status	integer	false
date_completion	datetime	false	yyyy-MM-dd'T'HH:mm:ss
current_step	integer	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/people/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.people.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID of person.
data.primary_email	string representation (PersonEmail)	*	Emails belong to user.
data.first_name	string	*	The users name (best guess from other sources etc).
data.last_name	string	*	The users name (best guess from other sources etc).
data.title_prefix	string	*	The users title.
data.name	string	*	The users name (best guess from other sources etc).
data.display_name	string	*	Person name.
data.is_agent	boolean	*	True if person is agent.
data.avatar	object (Avatar)	*	Person`s avatar.
data.avatar[default_url_pattern]	string	*	Default pattern used if there is no custom one.
data.avatar[url_pattern]	string	*	Url pattern for avatar gathering.
data.avatar[base_gravatar_url]	string	*	Url to gravatar.
data.online	boolean	*	Is user online?
data.online_for_chat	boolean	*	Is user online for chat?
data.last_seen	DateTime	*	Date when user was last seen online.
data.agent_data	object (AgentData)	*	Agent data.
data.agent_data[extension_number]	integer	*
data.agent_data[available_status]	string	*
data.agent_data[agent_calls_enabled]	boolean	*
data.agent_data[agent_chat_enabled]	boolean	*
data.agent_data[agent_can_use_forwarding]	boolean	*
data.agent_data[forwarding_number]	string	*
data.agent_data[forwarding_ring_timeout]	integer	*
data.agent_data[forwarding_number_type]	string	*
data.agent_data[forwarding_logged_out]	boolean	*
data.agent_data[work_status_enabled]	boolean	*
data.agent_data[work_status_managed_after]	DateTime	*
data.agent_data[login_status]	string	*
data.agent_data[extensionNumber]		*
data.agent_data[voicemailAsset]		*
data.agent_data[availableStatus]		*
data.agent_data[forwardingNumber]		*
data.agent_data[loginStatus]		*
data.was_agent	boolean	*	Was this person an agent?
data.can_agent	boolean	*	Is person allowed to use agent interface.
data.can_admin	boolean	*	Is person allowed to use admin interface.
data.can_billing	boolean	*	Is person allowed to use billing interface.
data.can_reports	boolean	*	Is person allowed to use reports interface.
data.picture_blob	integer id (Blob)	*	The user`s profile picture.
data.disable_picture	boolean	*	True if user`s picture disabled.
data.gravatar_url	string	*	The URL to the users gravatar if any.
data.is_contact	boolean	*	Is this person a contact?
data.disable_autoresponses	boolean	*	Are autoresponses disabled?
data.disable_autoresponses_log	string	*	Disabled autoresponses log.
data.is_confirmed	boolean	*	Has person confirmed their email?
data.is_deleted	boolean	*	Is the user deleted?
data.is_disabled	boolean	*	Is the user disabled?
data.creation_system	string	*	The way person was created.
data.override_display_name	string	*	Overrides the display name of an person in the user interface (agents only).
data.display_contact	string	*	Person name and email address.
data.summary	string	*	The summary field as filled in by agents.
data.language	integer id (Language)	*	Default person`s language.
data.organization	integer id (Organization)	*	The person`s organization.
data.organization_members[]	array of integer ids (OrganizationMember)	*	Organizations the person is member of.
data.organization_position	string	*	The persons position at the organization.
data.organization_manager	boolean	*	True if the person is a manager of their organization.
data.timezone	string	*	The timezone associated with this user.
data.date_created	DateTime	*	The date the user was inserted into the system.
data.date_last_login	DateTime	*	The date the user was logged in last time.
data.browser	string	*	The browser person was used last time.
data.all_user_groups[]	array of integer ids (Usergroup)	*	Usergroups the user belongs to including through connections like org groups.
data.user_groups[]	array of integer ids (Usergroup)	*	Usergroups the user belongs to.
data.agent_groups[]	array of integer ids (Usergroup)	*	Usergroups the user belongs to.
data.labels[]	array of objects (label)	*	Labels associated with this user.
data.emails[]	array of string representations (PersonEmail)	*	Emails belong to user.
data.phone_numbers[]	array of objects (PersonPhoneNumber)	*	Phone numbers belong to user.
data.phone_numbers[][number]	string	*	The number, stored in E.164 string format, ie. +19021111111.
data.phone_numbers[][label]	string	*	A human-defined (optional) label to describe what this phone number is.
data.phone_numbers[][extension]	string	*	An extension for the number - optional.
data.phone_numbers[][person]	integer id (Person)	*
data.tickets_count	integer	*	Overall tickets count assigned to user.
data.chats_count	integer	*	Overall count of chats user participating.
data.fields[]	dynamically declared custom fields (person)	*	Custom persons data.
data.contextual_options	custom handler result for (contextual_options)	*	Contextual person options.
data.contact_data	array	*	Contacts for this user.
data.teams[]	array of integer ids (AgentTeam)	*	Agent teams.
data.primary_team	integer id (AgentTeam)	*	Primary agent team.
data.brands[]	array of integer ids (Brand)	*	Brands.
data.preferences	array	*	Prefs.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/people/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.people.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format
title_prefix	string	false
first_name	string	false
last_name	string	false
override_display_name	string	false
summary	string	false
timezone	string	false
organization	choice	false
organization_position	string	false
organization_manager	boolean	false
organization_members[][organization]	choice	false
organization_members[][position]	string	false
organization_members[][manager]	boolean	false
language	choice	false
labels[]	array of strings	false
is_agent	boolean	false
is_user	boolean	false
user_groups[]	array of choices	false
agent_groups[]	array of choices	false
fields[1][mode]	string	false
fields[1][criteria]	string	false
fields[1][data]	choice	false
fields[5][mode]	string	false
fields[5][criteria]	string	false
fields[5][data][]	array of choices	false
fields[9][mode]	string	false
fields[9][criteria]	string	false
fields[9][data]	date	false	yyyy-MM-dd
fields[10][mode]	string	false
fields[10][criteria]	string	false
fields[10][data]	datetime	false	yyyy-MM-dd'T'HH:mm:ss
fields[11][mode]	string	false
fields[11][criteria]	string	false
fields[11][data]	string	false
fields[12][mode]	string	false
fields[12][criteria]	string	false
fields[12][data]	boolean	false
fields[13][mode]	string	false
fields[13][criteria]	string	false
fields[13][data]	string	false
contextual_fields	string	false
contact_data[website][][comment]	string	false
contact_data[website][][url]	string	false
contact_data[instant_message][][comment]	string	false
contact_data[instant_message][][service]	choice	false	["aim","msn","icq","skype","gtalk","whatsapp","other"]
contact_data[instant_message][][username]	string	false
contact_data[twitter][][comment]	string	false
contact_data[twitter][][username]	string	false
contact_data[twitter][][display_feed]	boolean	false
contact_data[linked_in][][comment]	string	false
contact_data[linked_in][][url]	string	false
contact_data[facebook][][comment]	string	false
contact_data[facebook][][url]	string	false
contact_data[address][][comment]	string	false
contact_data[address][][address]	string	false
contact_data[address][][city]	string	false
contact_data[address][][state]	string	false
contact_data[address][][zip]	string	false
contact_data[address][][country]	string	false
contact_data[apple][][comment]	string	false
contact_data[apple][][username]	string	false
contact_data[trust_pilot][][comment]	string	false
contact_data[trust_pilot][][username]	string	false
contact_data[instagram][][comment]	string	false
contact_data[instagram][][username]	string	false
contact_data[instagram][][instagram_id]	string	false
contact_data[facebook_page][][comment]	string	false
contact_data[facebook_page][][url]	string	false
teams[]	array of choices	false
primary_team	choice	false
agent_data[extension_number]	float	false
agent_data[voicemail_asset]	string	false
agent_data[available_status]	choice	false	["idle","offline"]
agent_data[agent_calls_enabled]	boolean	false
agent_data[agent_chat_enabled]	boolean	false
agent_data[agent_can_use_forwarding]	boolean	false
agent_data[forwarding_number]	string	false
agent_data[forwarding_logged_out]	boolean	false
phone_numbers[][number]	string	false
phone_numbers[][extension]	string	false
phone_numbers[][label]	string	false
brands[]	array of choices	false
is_disabled	boolean	false
disable_picture	boolean	false
disable_override_picture	boolean	false
disable_autoresponses	boolean	false
gravatar_url	string	false
picture_blob	string	false
override_picture_blob	string	false
importance	integer	false
preferences	string	false
refer_friend_secret	string	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

PUT /api/v2/people/{id}/permissions

adds permissions (for now only accepts {agent: true} to add agent permissions)

Applicable api modes

session token key oauth

Api tags for this endpoint

people.people.update_permissions

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id

Parameter	Type	Required?	Format	Description
	boolean	false		set as agent

Status Code	Description
200	OK

POST /api/v2/people/{id}/sessions/clear

Clear all session data

Applicable api modes

session token key oauth

Api tags for this endpoint

people.people.clear_session

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
204	OK

GET /api/v2/people/{id}/tickets

Get tickets of the given person

Applicable api modes

session token key oauth

Api tags for this endpoint

people.people.get_tickets

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id		int	Person ID

Parameter	Type	Versions	Description
data[]	array of objects (Ticket)	*
data[][id]	integer	*	The unique ID.
data[][ref]	string	*	String reference.
data[][auth]	string	*	Auth string.
data[][parent]	integer id (Ticket)	*	Parent of this ticket.
data[][language]	integer id (Language)	*	Language associated with this ticket.
data[][brand]	integer id (Brand)	*	Ticket brand.
data[][department]	integer id (Department)	*	Ticket where this department is processing.
data[][category]	integer id (TicketCategory)	*	Category of this ticket.
data[][priority]	integer id (TicketPriority)	*	Priority of this ticket.
data[][workflow]	integer id (TicketWorkflow)	*	Workflow entity.
data[][product]	integer id (Product)	*	Product about which this ticket.
data[][person]	integer id (Person)	*	Person created this ticket.
data[][person_email]	string representation (PersonEmail)	*	Person's email.
data[][agent]	integer id (Person)	*	Agent assigned.
data[][agent_team]	integer id (AgentTeam)	*	Agent team where this ticket is processing.
data[][organization]	integer id (Organization)	*	Organization team where this ticket is processing.
data[][linked_chat]	integer id (ChatConversation)	*	ChatConversation where this ticket is discussed.
data[][sent_to_address]	array	*	Addresses where ticket was send.
data[][email_account]	integer id (EmailAccount)	*	Email account used to gather the ticket.
data[][email_account_address]	string	*	Email account address used to gather the ticket.
data[][creation_system]	string	*	How this ticket appears.
data[][creation_system_option]	string	*	Option used by creation system.
data[][ticket_hash]	string	*	Unique hash.
data[][status]	string	<=20170400	Legacy ticket status.
data[][hidden_status]	string	<=20170400	Legacy ticket hidden status.
data[][ticket_status]	string	*	Ticket status.
data[][is_hold]	boolean	*	Is this on hold?
data[][labels][]	array of strings	*	String array of labels.
data[][urgency]	integer	*	How urgent this ticket?
data[][feedback_rating]	integer	*	Its rating based on feedback votes.
data[][date_feedback_rating]	DateTime	*	When the rating was calculated.
data[][date_created]	DateTime	*	When the ticket was created.
data[][date_resolved]	DateTime	*	When the ticket was resolved.
data[][date_archived]	DateTime	*	And archived at last.
data[][date_first_agent_assign]	DateTime	*	When it was assigned to agent at the very first time.
data[][date_first_agent_reply]	DateTime	*	When it was first time replied.
data[][date_last_agent_reply]	DateTime	*	And when it was replied the last time.
data[][date_last_user_reply]	DateTime	*	And the date user replied here last time.
data[][date_agent_waiting]	DateTime	*	Time when agent started to wait user.
data[][date_user_waiting]	DateTime	*	And the time when user started to wait agent.
data[][date_status]	DateTime	*	When status was changed.
data[][total_user_waiting]	integer	*	How much user was waited?
data[][total_to_first_reply]	integer	*	Total waiting before first reply.
data[][total_user_waiting_wh]	integer	*	Total user waiting in working hours.
data[][total_to_first_reply_wh]	integer	*	Total waiting before first reply in working hour.
data[][locked_by_agent]	integer id (Person)	*	An agent who locked the ticket.
data[][date_locked]	DateTime	*	Date time when ticket was locked.
data[][date_on_hold]	DateTime	*	Datetime when ticket was set on hold.
data[][has_attachments]	boolean	*	Does this ticket has attachments?
data[][subject]	string	*	Ticket subject.
data[][original_subject]	string	*	Original subject given by creator.
data[][properties]	array	*	Array of properties.
data[][problems][]	array of integer ids (Problem)	*	An array of associated problems.
data[][count_agent_replies]	integer	*	Count of all replies made by agents.
data[][count_user_replies]	integer	*	Count of all replies made by user.
data[][worst_sla_status]	string	*	Well, this is worst SLA status.
data[][waiting_times]	array	*	An array of waiting times.
data[][ticket_slas][]	array of integer ids (TicketSla)	*	All ticket SLAS.
data[][fields][]	dynamically declared custom fields (ticket)	*	Custom ticket fields.
data[][contextual_fields]	custom handler result for (custom_per_data)	*	Contextual ticket fields (per user/org fields).
data[][children][]	array of integer ids (Ticket)	*	Ticket children.
data[][siblings][]	array of integer ids (Ticket)	*	Ticket siblings.
data[][cc][]	array of integer ids (Person)	*	User should be acknowledged about this ticket.
data[][star]	string	*	Person star color.
data[][ticket_layout]	custom handler result for (raw)	*
data[][ticket_excerpt]	custom handler result for (raw)	*
data[][ticket_agent_errors]	custom handler result for (raw)	*
data[][ticket_user_errors]	custom handler result for (raw)	*
data[][ticket_permissions]	custom handler result for (raw)	*
data[][access_code]	string	*	Access code.
data[][followers]	string	*	Followers of that ticket as a comma-separated list of names.

Status Code	Description
200	Success

GET /api/v2/people/{parentId}/contact_data CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_contact_data.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (AbstractContactData)	*
data[][id]	integer	*	The unique ID.
data[][contact_type]	string	*	Contact type.
data[][comment]	string	*	Comment attached to contact.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

GET /api/v2/people/{parentId}/contact_data/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_contact_data.count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

GET /api/v2/people/{parentId}/contact_data/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_contact_data.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.contact_type	string	*	Contact type.
data.comment	string	*	Comment attached to contact.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

GET /api/v2/people/{parentId}/notes CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_notes.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (PersonNote)	*
data[][person]	integer id (Person)	*	The person the note is attached to.
data[][agent]	integer id (Person)	*	The agent that added the note.
data[][note]	string	*	The note contents.
data[][id]	integer	*	The unique ID.
data[][date_created]	DateTime	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/people/{parentId}/notes CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_notes.post

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Required?	Format	Description
note	string	true

Parameter	Type	Versions	Description
data.person	integer id (Person)	*	The person the note is attached to.
data.agent	integer id (Person)	*	The agent that added the note.
data.note	string	*	The note contents.
data.id	integer	*	The unique ID.
data.date_created	DateTime	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/people/{parentId}/notes/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_notes.count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/people/{parentId}/notes/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_notes.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/people/{parentId}/notes/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_notes.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Versions	Description
data.person	integer id (Person)	*	The person the note is attached to.
data.agent	integer id (Person)	*	The agent that added the note.
data.note	string	*	The note contents.
data.id	integer	*	The unique ID.
data.date_created	DateTime	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/people/{parentId}/notes/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_notes.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Required?	Format	Description
note	string	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/people/{parentId}/notes_files CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_notes_files.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (PersonNoteFile)	*
data[][person]	integer id (Person)	*	The person the note is attached to.
data[][agent]	integer id (Person)	*	The agent that added the note.
data[][blob]	object (Blob)	*	Person`s blob.
data[][note]	string	*	The note contents.
data[][id]	integer	*	The unique ID.
data[][date_created]	DateTime	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/people/{parentId}/notes_files CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_notes_files.post

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Required?	Format	Description
blob	object (Blob)	false
note	string	false

Parameter	Type	Versions	Description
data.person	integer id (Person)	*	The person the note is attached to.
data.agent	integer id (Person)	*	The agent that added the note.
data.blob	object (Blob)	*	Person`s blob.
data.note	string	*	The note contents.
data.id	integer	*	The unique ID.
data.date_created	DateTime	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/people/{parentId}/notes_files/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_notes_files.count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/people/{parentId}/notes_files/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_notes_files.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/people/{parentId}/notes-files/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_notes_files.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Versions	Description
data.person	integer id (Person)	*	The person the note is attached to.
data.agent	integer id (Person)	*	The agent that added the note.
data.blob	object (Blob)	*	Person`s blob.
data.note	string	*	The note contents.
data.id	integer	*	The unique ID.
data.date_created	DateTime	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/people/{parentId}/notes_files/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_notes_files.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Required?	Format	Description
blob	object (Blob)	false
note	string	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/people/{parentId}/usersource_assocs CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_usersource_assoc.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (PersonUsersourceAssoc)	*
data[][id]	integer	*	The unique ID.
data[][usersource]	integer id (Usersource)	*	The usersource that this scraper is attached to.
data[][identity]	string	*	The remote users unique ID. This should not change, so it's smart if this is a system ID such as a UserID.
data[][identity_friendly]	string	*	The remote users friendly ID. This is what will be displayed in various interfaces. This should rarely change, like a username. Since we use $identity, we can handle if this changes.
data[][date_updated]	DateTime	*	When the associated person was last "synced" from the remote usersource.
data[][date_created]	DateTime	*	When the record was first created in the system.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

GET /api/v2/people/{parentId}/usersource_assocs/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_usersource_assoc.count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/people/{parentId}/usersource_assocs/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_usersource_assoc.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/people/{parentId}/usersource_assocs/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_usersource_assoc.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.usersource	integer id (Usersource)	*	The usersource that this scraper is attached to.
data.identity	string	*	The remote users unique ID. This should not change, so it's smart if this is a system ID such as a UserID.
data.identity_friendly	string	*	The remote users friendly ID. This is what will be displayed in various interfaces. This should rarely change, like a username. Since we use $identity, we can handle if this changes.
data.date_updated	DateTime	*	When the associated person was last "synced" from the remote usersource.
data.date_created	DateTime	*	When the record was first created in the system.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

GET /api/v2/people/{person_id}/vcard

Get tickets of the given person

Applicable api modes

signed

Api tags for this endpoint

people.people.person_vcard

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
person_id		int

Status Code	Description
200	Success

GET /api/v2/person_contextual_fields CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_contextual_fields.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions
data[]	array of objects (ContextualField)	*
data[][id]	integer	*
data[][title]	string	*
data[][description]	string	*
data[][widget_type]	string	*
data[][allow_user_edit]	boolean	*
data[][is_enabled]	boolean	*
data[][is_user_enabled]	boolean	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/person_contextual_fields CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_contextual_fields.post

Response
Status Codes

Parameter	Type	Versions
data.id	integer	*
data.title	string	*
data.description	string	*
data.widget_type	string	*
data.allow_user_edit	boolean	*
data.is_enabled	boolean	*
data.is_user_enabled	boolean	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/person_contextual_fields/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_contextual_fields.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/person_contextual_fields/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_contextual_fields.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/person_contextual_fields/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_contextual_fields.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions
data.id	integer	*
data.title	string	*
data.description	string	*
data.widget_type	string	*
data.allow_user_edit	boolean	*
data.is_enabled	boolean	*
data.is_user_enabled	boolean	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/person_contextual_fields/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_contextual_fields.put

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/person_custom_fields CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_custom_fields.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (CustomDefPerson)	*
data[][title]		*
data[][parent]	object (CustomDefPerson)	*
data[][parent][parent]	object (CustomDefPerson)	*
data[][parent][children][]	array of objects (CustomDefPerson)	*	Field children.
data[][parent][is_public]	boolean	*	Show on public profile.
data[][children][]	array of objects (CustomDefPerson)	*	Field children.
data[][is_public]	boolean	*	Show on public profile.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/person_custom_fields CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_custom_fields.post

Parameters
Response
Status Codes

Parameter	Type	Required?
title	string	true
description	string	true
handler_class	string	true
parent_id	string	true
default_value	string	true
is_enabled	boolean	true
options	string	true
aliases	string	true
is_user_enabled	boolean	true
is_agent_field	boolean	true
display_order	float	true

Parameter	Type	Versions	Description
data.title		*
data.parent	object (CustomDefPerson)	*
data.parent[parent]	object (CustomDefPerson)	*
data.parent[children][]	array of objects (CustomDefPerson)	*	Field children.
data.parent[is_public]	boolean	*	Show on public profile.
data.parent[title]		*
data.children[]	array of objects (CustomDefPerson)	*	Field children.
data.is_public	boolean	*	Show on public profile.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

DELETE /api/v2/person_custom_fields/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_custom_fields.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/person_custom_fields/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_custom_fields.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.title		*
data.parent	object (CustomDefPerson)	*
data.parent[parent]	object (CustomDefPerson)	*
data.parent[children][]	array of objects (CustomDefPerson)	*	Field children.
data.parent[is_public]	boolean	*	Show on public profile.
data.parent[title]		*
data.children[]	array of objects (CustomDefPerson)	*	Field children.
data.is_public	boolean	*	Show on public profile.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/person_custom_fields/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_custom_fields.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?
title	string	false
description	string	false
handler_class	string	false
parent_id	string	false
default_value	string	false
is_enabled	boolean	false
options	string	false
aliases	string	false
is_user_enabled	boolean	false
is_agent_field	boolean	false
display_order	float	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/person_custom_fields/{parentId}/options CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_custom_field_options.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (CustomDefPerson)	*
data[][title]		*
data[][parent]	object (CustomDefPerson)	*
data[][parent][parent]	object (CustomDefPerson)	*
data[][parent][children][]	array of objects (CustomDefPerson)	*	Field children.
data[][parent][is_public]	boolean	*	Show on public profile.
data[][children][]	array of objects (CustomDefPerson)	*	Field children.
data[][is_public]	boolean	*	Show on public profile.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/person_custom_fields/{parentId}/options CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_custom_field_options.post

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Required?	Format	Description
title	string	true
display_order	integer	false

Parameter	Type	Versions	Description
data.title		*
data.parent	object (CustomDefPerson)	*
data.parent[parent]	object (CustomDefPerson)	*
data.parent[children][]	array of objects (CustomDefPerson)	*	Field children.
data.parent[is_public]	boolean	*	Show on public profile.
data.parent[title]		*
data.children[]	array of objects (CustomDefPerson)	*	Field children.
data.is_public	boolean	*	Show on public profile.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/person_custom_fields/{parentId}/options/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_custom_field_options.count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/person_custom_fields/{parentId}/options/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_custom_field_options.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/person_custom_fields/{parentId}/options/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_custom_field_options.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Versions	Description
data.title		*
data.parent	object (CustomDefPerson)	*
data.parent[parent]	object (CustomDefPerson)	*
data.parent[children][]	array of objects (CustomDefPerson)	*	Field children.
data.parent[is_public]	boolean	*	Show on public profile.
data.parent[title]		*
data.children[]	array of objects (CustomDefPerson)	*	Field children.
data.is_public	boolean	*	Show on public profile.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/person_custom_fields/{parentId}/options/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

people.person_custom_field_options.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Required?	Format	Description
title	string	false
display_order	integer	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

Show/hide List Operations Expand Operations

Person settings

GET /api/v2/person_setting

get person settings

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.person_setting.list

Response
Status Codes

Parameter	Type	Versions	Description
data[]	array of objects (PersonSetting)	*
data[][person]		*
data[][name]	string	*	Setting name.
data[][value]	array	*	Setting value.

Status Code	Description
200	Success

POST /api/v2/person_setting

create a new person setting

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.person_setting.post

Parameters
Response
Status Codes

Parameter	Type	Required?	Format	Description
	string	true	string	setting value

Parameter	Type	Versions	Description
data.person		*
data.name	string	*	Setting name.
data.value	array	*	Setting value.

Status Code	Description
201	Created
400	Bad Request

PUT /api/v2/person_setting

update person setting

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.person_setting.put

Parameters
Response
Status Codes

Parameter	Type	Required?	Format	Description
	string	true	string	setting value

Parameter	Type	Versions	Description
data.person		*
data.name	string	*	Setting name.
data.value	array	*	Setting value.

Status Code	Description
204	Updated
400	Bad Request
404	Not Found

GET /api/v2/person_setting/{name}

get a person setting

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.person_setting.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
name	\w+	string	the name of the setting

Parameter	Type	Versions	Description
data.person		*
data.name	string	*	Setting name.
data.value	array	*	Setting value.

Status Code	Description
200	Success
404	We can't find setting with given name

Show/hide List Operations Expand Operations

Portal New Settings

GET /api/v2/settings/brands/new/portal/general

Get portal general settings

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.portal.general_settings.get_new

Status Codes

Status Code	Description
200	Success
404	Not Found error will returned in case we can't find the specified brand

Show/hide List Operations Expand Operations

Portal Settings

GET /api/v2/settings/brands/{brand}/portal/community

Get portal general settings

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.portal.community_settings.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
brand		Brand

Parameter	Type	Versions
data.enabled	boolean	*
data.tab_enabled	boolean	*
data.homepage_enabled	boolean	*
data.subscriptions	boolean	*

Status Code	Description
200	Success
404	Not Found error will returned in case we can't find the specified brand

POST /api/v2/settings/brands/{brand}/portal/community

Save portal general settings

Documentation

Save general settings.

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.portal.community_settings.post

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
brand		Brand

Parameter	Type	Required?
enabled	boolean	false
tab_enabled	boolean	false
homepage_enabled	boolean	false
subscriptions	boolean	false

Status Code	Description
200	Returned if request was successful
400	In case your request was malformed

GET /api/v2/settings/brands/{brand}/portal/downloads

Get portal general settings

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.portal.downloads_settings.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
brand		Brand

Parameter	Type	Versions
data.enabled	boolean	*
data.tab_enabled	boolean	*
data.homepage_enabled	boolean	*
data.subscriptions	boolean	*
data.attachment_require_auth	boolean	*

Status Code	Description
200	Success
404	Not Found error will returned in case we can't find the specified brand

POST /api/v2/settings/brands/{brand}/portal/downloads

Save portal general settings

Documentation

Save general settings.

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.portal.downloads_settings.post

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
brand		Brand

Parameter	Type	Required?
enabled	boolean	false
tab_enabled	boolean	false
homepage_enabled	boolean	false
subscriptions	boolean	false
attachment_require_auth	boolean	false

Status Code	Description
200	Returned if request was successful
400	In case your request was malformed

GET /api/v2/settings/brands/{brand}/portal/general

Get portal general settings

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.portal.general_settings.get

Requirements
Status Codes

Name	Requirement	Type	Description
brand		Brand

Status Code	Description
200	Success
404	Not Found error will returned in case we can't find the specified brand

POST /api/v2/settings/brands/{brand}/portal/general

Save portal general settings

Documentation

Save general settings.

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.portal.general_settings.post

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
brand		Brand

Parameter	Type	Required?
site_name	string	true
brand_name	string	true
site_url	string	true
deskpro_name	string	true
deskpro_url	string	true
brand_slug	string	true
orig_deskpro_url	string	false
apps_community	boolean	true
apps_kb	boolean	true
apps_news	boolean	true
apps_downloads	boolean	true
apps_guides	boolean	true
iface_portal	boolean	true
iface_widget	boolean	true
show_ratings	boolean	true
show_ratings_min_votes	integer	true
publish_comments	boolean	true
limit_email_domains	boolean	true
limit_email_domains_patterns	string	true

Status Code	Description
204	Returned if request was successful
400	In case your request was malformed

GET /api/v2/settings/brands/{brand}/portal/guides

Get portal general settings

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.portal.guides_settings.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
brand		Brand

Parameter	Type	Versions
data.enabled	boolean	*
data.tab_enabled	boolean	*
data.homepage_enabled	boolean	*
data.subscriptions	boolean	*

Status Code	Description
200	Success
404	Not Found error will returned in case we can't find the specified brand

POST /api/v2/settings/brands/{brand}/portal/guides

Save portal general settings

Documentation

Save general settings.

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.portal.guides_settings.post

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
brand		Brand

Parameter	Type	Required?
enabled	boolean	false
tab_enabled	boolean	false
homepage_enabled	boolean	false
subscriptions	boolean	false

Status Code	Description
200	Returned if request was successful
400	In case your request was malformed

GET /api/v2/settings/brands/{brand}/portal/kb

Get portal general settings

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.portal.kb_settings.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
brand		Brand

Parameter	Type	Versions
data.minReviewDateInterval		*
data.maxReviewDateInterval		*
data.defaultReviewDateInterval		*
data.autoUnpublishReviewInterval		*
data.enabled	boolean	*
data.tab_enabled	boolean	*
data.homepage_enabled	boolean	*
data.subscriptions	boolean	*
data.knowledgebase_deep_tree	boolean	*
data.require_review_date	boolean	*
data.min_review_date	boolean	*
data.min_review_date_interval	integer	*
data.min_review_date_unit	string	*
data.max_review_date	boolean	*
data.max_review_date_interval	integer	*
data.max_review_date_unit	string	*
data.default_review_date	boolean	*
data.default_review_date_interval	integer	*
data.default_review_date_unit	string	*
data.auto_unpublish_review	boolean	*
data.auto_unpublish_review_interval	integer	*
data.auto_unpublish_review_unit	string	*

Status Code	Description
200	Success
404	Not Found error will returned in case we can't find the specified brand

POST /api/v2/settings/brands/{brand}/portal/kb

Save portal general settings

Documentation

Save general settings.

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.portal.kb_settings.post

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
brand		Brand

Parameter	Type	Required?	Format
enabled	boolean	false
tab_enabled	boolean	false
homepage_enabled	boolean	false
subscriptions	boolean	false
knowledgebase_deep_tree	boolean	true
require_review_date	boolean	true
min_review_date	boolean	true
min_review_date_interval	integer	true
min_review_date_unit	choice	true	["days","months","years"]
max_review_date	boolean	true
max_review_date_interval	integer	true
max_review_date_unit	choice	true	["days","months","years"]
default_review_date	boolean	true
default_review_date_interval	integer	true
default_review_date_unit	choice	true	["days","months","years"]
auto_unpublish_review	boolean	true
auto_unpublish_review_interval	integer	true
auto_unpublish_review_unit	choice	true	["days","months","years"]

Status Code	Description
200	Returned if request was successful
400	In case your request was malformed

GET /api/v2/settings/brands/{brand}/portal/news

Get portal general settings

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.portal.news_settings.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
brand		Brand

Parameter	Type	Versions
data.enabled	boolean	*
data.tab_enabled	boolean	*
data.homepage_enabled	boolean	*
data.subscriptions	boolean	*

Status Code	Description
200	Success
404	Not Found error will returned in case we can't find the specified brand

POST /api/v2/settings/brands/{brand}/portal/news

Save portal general settings

Documentation

Save general settings.

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.portal.news_settings.post

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
brand		Brand

Parameter	Type	Required?
enabled	boolean	false
tab_enabled	boolean	false
homepage_enabled	boolean	false
subscriptions	boolean	false

Status Code	Description
200	Returned if request was successful
400	In case your request was malformed

Show/hide List Operations Expand Operations

SLAs

GET /api/v2/slas CRUD

get SLAs collection

Applicable api modes

session token key oauth

Api tags for this endpoint

slas.list

Response
Status Codes

Parameter	Type	Versions	Description
data[]	array of objects (Sla)	*
data[][id]	integer	*	The unique ID.
data[][title]	string	*	SLA title.
data[][sla_type]	string	*	Type of SLA - first_response, resolution, waiting_time.
data[][active_time]	string	*	Whether active all the time (all) or during work hours only (work_hours) or use the default ticket-wide settings (default).
data[][work_start]	integer	*	When the work day starts. This is stored as the number of seconds after 00:00:00.
data[][work_end]	integer	*	When the work day ends. This is stored as the number of seconds after 00:00:00.
data[][work_days]	array	*	Array of work days, stored with keys corresponding to day numbers. Values are true. 0 = Sunday, 6 = Saturday (same as PHP, easy to convert to MySQL which is 1 = Sunday, 7 = Saturday).
data[][work_timezone]	string	*	Timezone for work hours/days to be considered in.
data[][work_holidays]	array	*	List of work holidays.
data[][apply_type]	string	*	Controls how the SLA is applied to tickets: all, terms, terms_before_triggers, manual.
data[][apply_terms]	object (TriggerTerms)	*	Conditions to apply.
data[][apply_terms][version]	integer	*	Terms version.
data[][apply_terms][terms]	array	*	Terms themselves.
data[][trigger_terms]	object (TriggerTerms)	*	Conditions to consider sla completed.
data[][warn_time]	integer	*	Warn time integer.
data[][warn_time_unit]	string	*	And it's unit (see warn time).
data[][warn_actions]	object (TriggerActions)	*	How to warn about SLA will fail.
data[][warn_actions][version]	integer	*	Actions version.
data[][warn_actions][actions]	array	*	Actions array representation.
data[][fail_time]	integer	*	Fail time integer.
data[][fail_time_unit]	string	*	And it's measuring unit (see fail_time).
data[][fail_actions]	object (TriggerActions)	*	What to do if SLA failed.
data[][exclude_ticket_statuses]	array	*	This SLA will not apply while tickets are in these pending statuses.

Status Code	Description
200	Returned if everything is OK

GET /api/v2/slas/{id} CRUD

get SLA

Applicable api modes

session token key oauth

Api tags for this endpoint

slas.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	the id of SLA

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.title	string	*	SLA title.
data.sla_type	string	*	Type of SLA - first_response, resolution, waiting_time.
data.active_time	string	*	Whether active all the time (all) or during work hours only (work_hours) or use the default ticket-wide settings (default).
data.work_start	integer	*	When the work day starts. This is stored as the number of seconds after 00:00:00.
data.work_end	integer	*	When the work day ends. This is stored as the number of seconds after 00:00:00.
data.work_days	array	*	Array of work days, stored with keys corresponding to day numbers. Values are true. 0 = Sunday, 6 = Saturday (same as PHP, easy to convert to MySQL which is 1 = Sunday, 7 = Saturday).
data.work_timezone	string	*	Timezone for work hours/days to be considered in.
data.work_holidays	array	*	List of work holidays.
data.apply_type	string	*	Controls how the SLA is applied to tickets: all, terms, terms_before_triggers, manual.
data.apply_terms	object (TriggerTerms)	*	Conditions to apply.
data.apply_terms[version]	integer	*	Terms version.
data.apply_terms[terms]	array	*	Terms themselves.
data.trigger_terms	object (TriggerTerms)	*	Conditions to consider sla completed.
data.warn_time	integer	*	Warn time integer.
data.warn_time_unit	string	*	And it's unit (see warn time).
data.warn_actions	object (TriggerActions)	*	How to warn about SLA will fail.
data.warn_actions[version]	integer	*	Actions version.
data.warn_actions[actions]	array	*	Actions array representation.
data.fail_time	integer	*	Fail time integer.
data.fail_time_unit	string	*	And it's measuring unit (see fail_time).
data.fail_actions	object (TriggerActions)	*	What to do if SLA failed.
data.exclude_ticket_statuses	array	*	This SLA will not apply while tickets are in these pending statuses.

Status Code	Description
200	Returned if everything is OK

Show/hide List Operations Expand Operations

Search

GET /api/v2/search

Search through articles, downloads, community topics, news, tickets, chatconversations, people and

Documentation

Search through articles, downloads, community topics, news, tickets, chat_conversations, people and organizations.

Applicable api modes

session token key oauth

Api tags for this endpoint

search.quick_search

Filters
Response
Status Codes

Name

Information

Requirement	.*
Description	search term
Datatype	string

sort

Requirement	.*
Description	how to sort
Datatype	string

types

Requirement	(article\|download\|community\|news\|ticket\|person\|agent\|organization\|chat_conversation)+
Description	comma separated list of types
Datatype	string

Parameter	Type	Versions
datagrouped_results[]	array of objects (QuickSearchContext)	*
datagrouped_results[][type]	string	*
datagrouped_results[][results]	array	*

Status Code	Description
200	Returned if everything is ok

POST /api/v2/search/new_search

New agent search endpoint.

Documentation

New agent search endpoint.

Applicable api modes

session token key oauth

Api tags for this endpoint

search.new_search

Parameters
Status Codes

Parameter	Type	Required?	Format	Description
	array	true		Search payload

Status Code	Description
200	Returned if everything is ok

GET /api/v2/search/people_and_orgs

Search only organizations and people.

Documentation

Search only organizations and people.

Applicable api modes

session token key oauth

Api tags for this endpoint

search.quick_search_people_organizations

Filters
Response
Status Codes

Name

Information

Requirement	.*
Description	search term
Datatype	string

sort

Requirement	.*
Description	how to sort
Datatype	string

Parameter	Type	Versions
datagrouped_results[]	array of objects (QuickSearchContext)	*
datagrouped_results[][type]	string	*
datagrouped_results[][results]	array	*

Status Code	Description
200	Returned if everything is ok

GET /api/v2/search/{type}

Search by entity type.

Documentation

Search by entity type.

Applicable api modes

session token key oauth

Api tags for this endpoint

search.quick_search_by_type

Requirements
Filters
Status Codes

Name	Requirement	Type	Description
type	(article\|download\|community\|news\|ticket\|person\|agent\|organization\|chat_conversation\|topic)	string

Name

Information

Requirement	.*
Description	search term
Datatype	string

sort

Requirement	.*
Description	how to sort
Datatype	string

Status Code	Description
200	Returned if everything is ok

Show/hide List Operations Expand Operations

Settings

GET /api/v2/settings/departments/default unstable

list if default departments grouped by brand

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.department_settings.list

Response
Status Codes

Parameter	Type	Versions
data[]	array of objects (DefaultDepartmentSettings)	*
data[][type]	string	*
data[][brand]	integer id (Brand)	*
data[][department]	integer id (Department)	*

Status Code	Description
200	Here you are

PUT /api/v2/settings/departments/default unstable

list if default departments grouped by brand

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.department_settings.set_settings

Parameters
Status Codes

Parameter	Type	Required?	Format
brand	choice	false
department	choice	false
type	choice	false	["agent","user"]

Status Code	Description
204	Update successful

Show/hide List Operations Expand Operations

Snippets

GET /api/v2/snippets CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

snippets.snippets.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

inline_sideloads

Pattern	true\|false
Description	sideload entities

include

Pattern	\w[,\w]
Description	entities to sideload (ex: snippet_translation)

type

Pattern	\w[,\w]
Description	type to limit result

label

Pattern	[\w,]+
Description	Comma separated list of labels
Datatype	string

language

Pattern	[\w,]+
Description	Comma separated list of locales or language IDs
Datatype	string

Pattern	\w+
Description	Words to find in the snippet title
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (Snippet)	*
data[][id]	integer	*	The unique snippet ID.
data[][title]	string	*	This snippet title.
data[][person]	integer id (Person)	*	Person - owner of this snippet.
data[][types][]	array of strings	*	The types of the snippet.
data[][shortcut_code]	string	*	Shortcut for this snippet.
data[][labels][]	array of objects (label)	*	The labels associated with the snippet.
data[][translations][]	array of integer ids (SnippetTranslation)	*	The content translations.
data[][is_draft]	boolean	*	Is this just a draft?
data[][is_split]	boolean	*	Flag indicates that content is different for different types.
data[][is_ownership_global]	boolean	*	Flag indicates that snippet is accessible to everyone.
data[][is_visible_global]	boolean	*	Flag indicates that snippet is visible with all departments.
data[][ownership_teams][]	array of integer ids (AgentTeam)	*
data[][visible_departments][]	array of integer ids (Department)	*
data[][usage_count]	integer	*
data[][positive_ratings]	integer	*
data[][neutral_ratings]	integer	*
data[][negative_ratings]	integer	*
data[][date_created]	DateTime	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/snippets CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

snippets.snippets.post

Parameters
Response
Status Codes

Parameter	Type	Required?	Format
person[id]	string	false
person[name]	string	false
person[email]	string	false
person[fieldId]	string	false
person[key]	string	false
title	string	true
labels[]	array of strings	false
types[]	array of choices	true	["chat","ticket"]
translations[][language]	choice	true
translations[][content]	string	true
translations[][blobs][]	array of choices	true
translations[][snippet]	choice	true
translations[][type]	choice	true	["chat","ticket"]
translations[][id]	string	false
shortcut_code	string	true
is_draft	boolean	false
is_split	boolean	false
is_ownership_global	boolean	false
is_visible_global	boolean	false
ownership_teams[]	array of choices	true
visible_departments[]	array of choices	true

Parameter	Type	Versions	Description
data.id	integer	*	The unique snippet ID.
data.title	string	*	This snippet title.
data.person	integer id (Person)	*	Person - owner of this snippet.
data.types[]	array of strings	*	The types of the snippet.
data.shortcut_code	string	*	Shortcut for this snippet.
data.labels[]	array of objects (label)	*	The labels associated with the snippet.
data.translations[]	array of integer ids (SnippetTranslation)	*	The content translations.
data.is_draft	boolean	*	Is this just a draft?
data.is_split	boolean	*	Flag indicates that content is different for different types.
data.is_ownership_global	boolean	*	Flag indicates that snippet is accessible to everyone.
data.is_visible_global	boolean	*	Flag indicates that snippet is visible with all departments.
data.ownership_teams[]	array of integer ids (AgentTeam)	*
data.visible_departments[]	array of integer ids (Department)	*
data.usage_count	integer	*
data.positive_ratings	integer	*
data.neutral_ratings	integer	*
data.negative_ratings	integer	*
data.date_created	DateTime	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/snippets/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

snippets.snippets.count

Filters
Response
Status Codes

Name

Information

inline_sideloads

Pattern	true\|false
Description	sideload entities

include

Pattern	\w[,\w]
Description	entities to sideload (ex: snippet_translation)

type

Pattern	\w[,\w]
Description	type to limit result

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

label

Pattern	[\w,]+
Description	Comma separated list of labels
Datatype	string

language

Pattern	[\w,]+
Description	Comma separated list of locales or language IDs
Datatype	string

Pattern	\w+
Description	Words to find in the snippet title
Datatype	string

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

GET /api/v2/snippets/csv CRUD

Get an export of snippets

Applicable api modes

session token key oauth

Api tags for this endpoint

snippets.snippets.csv

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data.file	object (file)	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

GET /api/v2/snippets/labels CRUD

Get collection of snippet labels

Applicable api modes

session token key oauth

Api tags for this endpoint

snippets.snippets.list_labels

Filters
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/snippets/mass_actions CRUD

Apply mass actions function

Applicable api modes

session token key oauth

Api tags for this endpoint

snippets.snippets.post_mass_actions

Parameters
Status Codes

Parameter	Type	Required?	Format
action	choice	true	["labels","visibility","ownership","type","draft"]
selected[]	array of choices	true
value	string	true

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/snippets/render/{id}/{type}/{objectId} CRUD

Render a snippet for an object

Applicable api modes

session token key oauth

Api tags for this endpoint

snippets.snippets.render_snippet

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the object
type	(ticket\|chat)	string	The type of object to render the snippet for
objectId	\d+

Parameter	Type	Versions	Description
data.id	integer	*	The unique snippet ID.
data.title	string	*	This snippet title.
data.person	integer id (Person)	*	Person - owner of this snippet.
data.types[]	array of strings	*	The types of the snippet.
data.shortcut_code	string	*	Shortcut for this snippet.
data.labels[]	array of objects (label)	*	The labels associated with the snippet.
data.translations[]	array of integer ids (SnippetTranslation)	*	The content translations.
data.is_draft	boolean	*	Is this just a draft?
data.is_split	boolean	*	Flag indicates that content is different for different types.
data.is_ownership_global	boolean	*	Flag indicates that snippet is accessible to everyone.
data.is_visible_global	boolean	*	Flag indicates that snippet is visible with all departments.
data.ownership_teams[]	array of integer ids (AgentTeam)	*
data.visible_departments[]	array of integer ids (Department)	*
data.usage_count	integer	*
data.positive_ratings	integer	*
data.neutral_ratings	integer	*
data.negative_ratings	integer	*
data.date_created	DateTime	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

DELETE /api/v2/snippets/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

snippets.snippets.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/snippets/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

snippets.snippets.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.id	integer	*	The unique snippet ID.
data.title	string	*	This snippet title.
data.person	integer id (Person)	*	Person - owner of this snippet.
data.types[]	array of strings	*	The types of the snippet.
data.shortcut_code	string	*	Shortcut for this snippet.
data.labels[]	array of objects (label)	*	The labels associated with the snippet.
data.translations[]	array of integer ids (SnippetTranslation)	*	The content translations.
data.is_draft	boolean	*	Is this just a draft?
data.is_split	boolean	*	Flag indicates that content is different for different types.
data.is_ownership_global	boolean	*	Flag indicates that snippet is accessible to everyone.
data.is_visible_global	boolean	*	Flag indicates that snippet is visible with all departments.
data.ownership_teams[]	array of integer ids (AgentTeam)	*
data.visible_departments[]	array of integer ids (Department)	*
data.usage_count	integer	*
data.positive_ratings	integer	*
data.neutral_ratings	integer	*
data.negative_ratings	integer	*
data.date_created	DateTime	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/snippets/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

snippets.snippets.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format
person[id]	string	false
person[name]	string	false
person[email]	string	false
person[fieldId]	string	false
person[key]	string	false
title	string	false
labels[]	array of strings	false
types[]	array of choices	false	["chat","ticket"]
translations[][language]	choice	false
translations[][content]	string	false
translations[][blobs][]	array of choices	false
translations[][snippet]	choice	false
translations[][type]	choice	false	["chat","ticket"]
translations[][id]	string	false
shortcut_code	string	false
is_draft	boolean	false
is_split	boolean	false
is_ownership_global	boolean	false
is_visible_global	boolean	false
ownership_teams[]	array of choices	false
visible_departments[]	array of choices	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/snippets_change_logs CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

snippets.snippet_change_log.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

inline_sideloads

Pattern	true\|false
Description	sideload entities

include

Pattern	\w[,\w]
Description	entities to sideload (ex: ticket_message)

snippet_id

Pattern	\w[,\w]
Description	Snippet Id

language_id

Pattern	\w[,\w]
Description	Language Id

type

Pattern	\w[,\w]
Description	Type

Parameter	Type	Versions	Description
data[]	array of objects (SnippetChangeLog)	*
data[][dateCreated]		*
data[][id]	integer	*
data[][date_created]	DateTime	*	When action was done.
data[][person]	integer id (Person)	*	Person that sent this message.
data[][snippet]	integer id (Snippet)	*
data[][language]	integer id (Language)	*
data[][content]	string	*	Snippet content.
data[][type]	string	*
data[][blobs][]	array of integer ids (Blob)	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

GET /api/v2/snippets_use CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

snippets.snippets_usage.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

inline_sideloads

Pattern	true\|false
Description	sideload entities

include

Pattern	\w[,\w]
Description	entities to sideload (ex: ticket_message)

snippet_id

Pattern	\w[,\w]
Description	Snippet Id

Parameter	Type	Versions	Description
data[]	array of objects (SnippetUseLog)	*
data[][snippet]	integer id (Snippet)	*	Snippet used.
data[][language]	integer id (Language)	*	Snippet translated.
data[][person]	integer id (Person)	*
data[][id]	integer	*	The unique ID.
data[][date_created]	DateTime	*
data[][ticket_message]	integer id (TicketMessage)	*	Ticket Message where the snippet was used.
data[][chat_message]	integer id (ChatMessage)	*	Chat Message where the snippet was used.
data[][rating]	integer	*
data[][type]	string	*
data[][message]	string	*	Property manually set to contain snippet message.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

Show/hide List Operations Expand Operations

System

GET /api/v2/system/events/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

system.alerts.event.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions
data.id	integer	*
data.date_created	DateTime	*
data.processed	boolean	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

DELETE /api/v2/system/incidents

delete all incidents

GET /api/v2/system/incidents CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

system.alerts.incident.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions
data[]	array of objects (StatefulIncident)	*
data[][id]	integer	*
data[][date_created]	DateTime	*
data[][raised]	boolean	*
data[][dismissed]	boolean	*
data[][title]	string	*
data[][resolved]	boolean	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

PUT /api/v2/system/incidents

change dismissed status for all incidents

Applicable api modes

session token key oauth

Api tags for this endpoint

system.alerts.incident.dismiss_all

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
dimissed	1\|0		An integer representing bool

Parameter	Type	Required?	Format	Description
dismissed	boolean	false

Status Code	Description
200	Returned if success

GET /api/v2/system/incidents/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

system.alerts.incident.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/system/incidents/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

system.alerts.incident.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/system/incidents/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

system.alerts.incident.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions
data.id	integer	*
data.date_created	DateTime	*
data.raised	boolean	*
data.dismissed	boolean	*
data.title	string	*
data.resolved	boolean	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/system/incidents/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

system.alerts.incident.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format	Description
dismissed	boolean	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

Show/hide List Operations Expand Operations

Tasks

GET /api/v2/tasks CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

tasks.tasks.list

Filters
Parameters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Required?	Format
title	string	true
person	choice	true
date_due	datetime	false	yyyy-MM-dd'T'HH:mm:ss
visibility	choice	false	[0,1]
assigned_agent	choice	false
assigned_agent_team	choice	false
assigned_department	choice	false
ticket	float	false
tickets[]	array of choices	false
labels[]	array of strings	false

Parameter	Type	Versions	Description
data[]	array of objects (Task)	*
data[][tickets][]	array of integer ids (Ticket)	*
data[][id]	integer	*	The unique ID.
data[][is_completed]	boolean	*	Whether this task is completed.
data[][title]	string	*	The task's title.
data[][visibility]	integer	*	The task's visibility. On of: self::PRIVATE_VISIBILITY(0) or self::PUBLIC_VISIBILITY(1).
data[][date_due]	DateTime	*	The task's optional due date.
data[][date_created]	DateTime	*	The date the task was inserted into the system.
data[][date_completed]	DateTime	*	The date the task was completed.
data[][person]	object (Person)	*	The person created this task.
data[][assigned_agent]	object (Person)	*	The person assigned to complete this task.
data[][assigned_department]	object (Department)	*	The department assigned to complete this task.
data[][assigned_department][id]	integer	*
data[][assigned_department][parent]	object (Department)	*
data[][assigned_department][children][]	array of objects (Department)	*
data[][assigned_department][title]	string	*
data[][assigned_department][user_title]	string	*
data[][assigned_department][is_tickets_enabled]	boolean	*
data[][assigned_department][is_chat_enabled]	boolean	*
data[][assigned_department][display_order]	integer	*
data[][assigned_department][avatar]	object (Blob)	*
data[][assigned_department][avatar][sys_name]	string	*	A unique system name for the blob.
data[][assigned_department][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][assigned_department][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][assigned_department][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][assigned_department][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][assigned_department][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data[][assigned_department][avatar][file_url]	string	*	The HTTP link to download the file.
data[][assigned_department][avatar][authcode]	string	*
data[][assigned_department][avatar][blob_hash]	string	*
data[][assigned_department][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][assigned_department][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][assigned_department][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][assigned_department][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][assigned_department][avatar][date_created]	DateTime	*
data[][assigned_department][avatar][is_temp]	boolean	*
data[][assigned_department][avatar][source_ref]	string	*
data[][assigned_department][avatar][labels][]	array of objects (LabelBlob)	*
data[][assigned_department][avatar][labels][][blob]	object (Blob)	*
data[][assigned_department][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][assigned_department][brands][]	array of objects (Brand)	*
data[][assigned_department][brands][][id]	integer	*	The unique ID.
data[][assigned_department][brands][][name]	string	*	The brand name.
data[][assigned_department][brands][][slug]	string	*
data[][assigned_department][brands][][url]	string	*	The brand url.
data[][assigned_department][brands][][theme_set]	object (ThemeSet)	*
data[][assigned_department][brands][][theme_set][id]	integer	*
data[][assigned_department][brands][][theme_set][theme_id]	string	*
data[][assigned_department][brands][][theme_set][title]	string	*
data[][assigned_department][brands][][edit_theme_set]	object (ThemeSet)	*
data[][assigned_department][brands][][departments][]	array of objects (Department)	*
data[][assigned_department][brands][][theme_sets][]	array of objects (ThemeSet)	*
data[][assigned_department][permissions][]	array of objects (DepartmentPermission)	*
data[][assigned_department][permissions][][department]	integer id (Department)	*
data[][assigned_department][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][assigned_department][permissions][][name]	string	*	The name of the permission.
data[][assigned_department][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][assigned_department][permissions][][is_active]	boolean	*
data[][assigned_department][chat_queue]	object (UserChatQueue)	*
data[][assigned_department][chat_queue][id]	integer	*	The unique ID.
data[][assigned_department][chat_queue][name]	string	*
data[][assigned_department][chat_queue][routing_model]	string	*
data[][assigned_department][chat_queue][answer_timeout]	integer	*
data[][assigned_department][chat_queue][is_all_agents]	boolean	*
data[][assigned_department][chat_queue][departments][]	array of objects (Department)	*
data[][assigned_department][chat_queue][max_queue_size]	integer	*
data[][assigned_agent_team]	object (AgentTeam)	*	The agent team assigned to complete this task.
data[][assigned_agent_team][id]	integer	*	The unique ID.
data[][assigned_agent_team][name]	string	*	The name of agent team.
data[][assigned_agent_team][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][labels][]	array of objects (LabelTask)	*	Labels associated with this task.
data[][labels][][task]	object (Task)	*
data[][labels][][task][tickets][]	array of integer ids (Ticket)	*
data[][labels][][task][id]	integer	*	The unique ID.
data[][labels][][task][is_completed]	boolean	*	Whether this task is completed.
data[][labels][][task][title]	string	*	The task's title.
data[][labels][][task][visibility]	integer	*	The task's visibility. On of: self::PRIVATE_VISIBILITY(0) or self::PUBLIC_VISIBILITY(1).
data[][labels][][task][date_due]	DateTime	*	The task's optional due date.
data[][labels][][task][date_created]	DateTime	*	The date the task was inserted into the system.
data[][labels][][task][date_completed]	DateTime	*	The date the task was completed.
data[][labels][][task][person]	object (Person)	*	The person created this task.
data[][labels][][task][assigned_agent]	object (Person)	*	The person assigned to complete this task.
data[][labels][][task][assigned_department]	object (Department)	*	The department assigned to complete this task.
data[][labels][][task][assigned_agent_team]	object (AgentTeam)	*	The agent team assigned to complete this task.
data[][labels][][task][labels][]	array of objects (LabelTask)	*	Labels associated with this task.
data[][labels][][task][comments][]	array of objects (TaskComment)	*
data[][labels][][task][comments][][id]	integer	*	The unique ID.
data[][labels][][task][comments][][content]	string	*	The comment's content.
data[][labels][][task][comments][][task]	integer id (Task)	*	Task containing comment.
data[][labels][][task][comments][][person]	integer id (Person)	*	Person created this comment.
data[][labels][][task][comments][][date_created]	DateTime	*	The date the comment was inserted into the system.
data[][comments][]	array of objects (TaskComment)	*
data[][comments][][id]	integer	*	The unique ID.
data[][comments][][content]	string	*	The comment's content.
data[][comments][][task]	integer id (Task)	*	Task containing comment.
data[][comments][][person]	integer id (Person)	*	Person created this comment.
data[][comments][][date_created]	DateTime	*	The date the comment was inserted into the system.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/tasks CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tasks.tasks.post

Parameters
Response
Status Codes

Parameter	Type	Required?	Format
title	string	true
person	choice	true
date_due	datetime	false	yyyy-MM-dd'T'HH:mm:ss
visibility	choice	false	[0,1]
assigned_agent	choice	false
assigned_agent_team	choice	false
assigned_department	choice	false
date_completed	datetime	false	yyyy-MM-dd'T'HH:mm:ss
is_completed	boolean	false
ticket	float	false
tickets[]	array of choices	false
labels[]	array of strings	false

Parameter	Type	Versions	Description
data.tickets[]	array of integer ids (Ticket)	*
data.id	integer	*	The unique ID.
data.is_completed	boolean	*	Whether this task is completed.
data.title	string	*	The task's title.
data.visibility	integer	*	The task's visibility. On of: self::PRIVATE_VISIBILITY(0) or self::PUBLIC_VISIBILITY(1).
data.date_due	DateTime	*	The task's optional due date.
data.date_created	DateTime	*	The date the task was inserted into the system.
data.date_completed	DateTime	*	The date the task was completed.
data.person	object (Person)	*	The person created this task.
data.person[emails]		*
data.person[labels]		*
data.person[teams]		*
data.person[primary_team]		*
data.person[agentData]		*
data.person[publicUsergroups]		*
data.person[publicAgentgroups]		*
data.assigned_agent	object (Person)	*	The person assigned to complete this task.
data.assigned_department	object (Department)	*	The department assigned to complete this task.
data.assigned_department[id]	integer	*
data.assigned_department[parent]	object (Department)	*
data.assigned_department[children][]	array of objects (Department)	*
data.assigned_department[title]	string	*
data.assigned_department[user_title]	string	*
data.assigned_department[is_tickets_enabled]	boolean	*
data.assigned_department[is_chat_enabled]	boolean	*
data.assigned_department[display_order]	integer	*
data.assigned_department[avatar]	object (Blob)	*
data.assigned_department[avatar][sys_name]	string	*	A unique system name for the blob.
data.assigned_department[avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.assigned_department[avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.assigned_department[avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.assigned_department[avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.assigned_department[avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.assigned_department[avatar][file_url]	string	*	The HTTP link to download the file.
data.assigned_department[avatar][authcode]	string	*
data.assigned_department[avatar][blob_hash]	string	*
data.assigned_department[avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.assigned_department[avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.assigned_department[avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.assigned_department[avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.assigned_department[avatar][date_created]	DateTime	*
data.assigned_department[avatar][is_temp]	boolean	*
data.assigned_department[avatar][source_ref]	string	*
data.assigned_department[avatar][labels][]	array of objects (LabelBlob)	*
data.assigned_department[avatar][labels][][blob]	object (Blob)	*
data.assigned_department[avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.assigned_department[brands][]	array of objects (Brand)	*
data.assigned_department[brands][][id]	integer	*	The unique ID.
data.assigned_department[brands][][name]	string	*	The brand name.
data.assigned_department[brands][][slug]	string	*
data.assigned_department[brands][][url]	string	*	The brand url.
data.assigned_department[brands][][theme_set]	object (ThemeSet)	*
data.assigned_department[brands][][theme_set][id]	integer	*
data.assigned_department[brands][][theme_set][theme_id]	string	*
data.assigned_department[brands][][theme_set][title]	string	*
data.assigned_department[brands][][theme_set][options]		*
data.assigned_department[brands][][edit_theme_set]	object (ThemeSet)	*
data.assigned_department[brands][][departments][]	array of objects (Department)	*
data.assigned_department[brands][][theme_sets][]	array of objects (ThemeSet)	*
data.assigned_department[permissions][]	array of objects (DepartmentPermission)	*
data.assigned_department[permissions][][department]	integer id (Department)	*
data.assigned_department[permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.assigned_department[permissions][][name]	string	*	The name of the permission.
data.assigned_department[permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.assigned_department[permissions][][is_active]	boolean	*
data.assigned_department[chat_queue]	object (UserChatQueue)	*
data.assigned_department[chat_queue][id]	integer	*	The unique ID.
data.assigned_department[chat_queue][name]	string	*
data.assigned_department[chat_queue][routing_model]	string	*
data.assigned_department[chat_queue][answer_timeout]	integer	*
data.assigned_department[chat_queue][is_all_agents]	boolean	*
data.assigned_department[chat_queue][departments][]	array of objects (Department)	*
data.assigned_department[chat_queue][max_queue_size]	integer	*
data.assigned_department[chat_queue][routingModel]		*
data.assigned_agent_team	object (AgentTeam)	*	The agent team assigned to complete this task.
data.assigned_agent_team[id]	integer	*	The unique ID.
data.assigned_agent_team[name]	string	*	The name of agent team.
data.assigned_agent_team[avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.assigned_agent_team[members]		*
data.labels[]	array of objects (LabelTask)	*	Labels associated with this task.
data.labels[][task]	object (Task)	*
data.labels[][task][tickets][]	array of integer ids (Ticket)	*
data.labels[][task][id]	integer	*	The unique ID.
data.labels[][task][is_completed]	boolean	*	Whether this task is completed.
data.labels[][task][title]	string	*	The task's title.
data.labels[][task][visibility]	integer	*	The task's visibility. On of: self::PRIVATE_VISIBILITY(0) or self::PUBLIC_VISIBILITY(1).
data.labels[][task][date_due]	DateTime	*	The task's optional due date.
data.labels[][task][date_created]	DateTime	*	The date the task was inserted into the system.
data.labels[][task][date_completed]	DateTime	*	The date the task was completed.
data.labels[][task][person]	object (Person)	*	The person created this task.
data.labels[][task][assigned_agent]	object (Person)	*	The person assigned to complete this task.
data.labels[][task][assigned_department]	object (Department)	*	The department assigned to complete this task.
data.labels[][task][assigned_agent_team]	object (AgentTeam)	*	The agent team assigned to complete this task.
data.labels[][task][labels][]	array of objects (LabelTask)	*	Labels associated with this task.
data.labels[][task][comments][]	array of objects (TaskComment)	*
data.labels[][task][comments][][id]	integer	*	The unique ID.
data.labels[][task][comments][][content]	string	*	The comment's content.
data.labels[][task][comments][][task]	integer id (Task)	*	Task containing comment.
data.labels[][task][comments][][person]	integer id (Person)	*	Person created this comment.
data.labels[][task][comments][][date_created]	DateTime	*	The date the comment was inserted into the system.
data.labels[][label]		*
data.comments[]	array of objects (TaskComment)	*
data.comments[][id]	integer	*	The unique ID.
data.comments[][content]	string	*	The comment's content.
data.comments[][task]	integer id (Task)	*	Task containing comment.
data.comments[][person]	integer id (Person)	*	Person created this comment.
data.comments[][date_created]	DateTime	*	The date the comment was inserted into the system.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/tasks/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

tasks.tasks.count

Parameters
Response
Status Codes

Parameter	Type	Required?	Format
title	string	true
person	choice	true
date_due	datetime	false	yyyy-MM-dd'T'HH:mm:ss
visibility	choice	false	[0,1]
assigned_agent	choice	false
assigned_agent_team	choice	false
assigned_department	choice	false
ticket	float	false
tickets[]	array of choices	false
labels[]	array of strings	false

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/tasks/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tasks.tasks.delete

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format
title	string	true
person	choice	true
date_due	datetime	false	yyyy-MM-dd'T'HH:mm:ss
visibility	choice	false	[0,1]
assigned_agent	choice	false
assigned_agent_team	choice	false
assigned_department	choice	false
ticket	float	false
tickets[]	array of choices	false
labels[]	array of strings	false

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/tasks/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tasks.tasks.get

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format
title	string	true
person	choice	true
date_due	datetime	false	yyyy-MM-dd'T'HH:mm:ss
visibility	choice	false	[0,1]
assigned_agent	choice	false
assigned_agent_team	choice	false
assigned_department	choice	false
ticket	float	false
tickets[]	array of choices	false
labels[]	array of strings	false

Parameter	Type	Versions	Description
data.tickets[]	array of integer ids (Ticket)	*
data.id	integer	*	The unique ID.
data.is_completed	boolean	*	Whether this task is completed.
data.title	string	*	The task's title.
data.visibility	integer	*	The task's visibility. On of: self::PRIVATE_VISIBILITY(0) or self::PUBLIC_VISIBILITY(1).
data.date_due	DateTime	*	The task's optional due date.
data.date_created	DateTime	*	The date the task was inserted into the system.
data.date_completed	DateTime	*	The date the task was completed.
data.person	object (Person)	*	The person created this task.
data.person[emails]		*
data.person[labels]		*
data.person[teams]		*
data.person[primary_team]		*
data.person[agentData]		*
data.person[publicUsergroups]		*
data.person[publicAgentgroups]		*
data.assigned_agent	object (Person)	*	The person assigned to complete this task.
data.assigned_department	object (Department)	*	The department assigned to complete this task.
data.assigned_department[id]	integer	*
data.assigned_department[parent]	object (Department)	*
data.assigned_department[children][]	array of objects (Department)	*
data.assigned_department[title]	string	*
data.assigned_department[user_title]	string	*
data.assigned_department[is_tickets_enabled]	boolean	*
data.assigned_department[is_chat_enabled]	boolean	*
data.assigned_department[display_order]	integer	*
data.assigned_department[avatar]	object (Blob)	*
data.assigned_department[avatar][sys_name]	string	*	A unique system name for the blob.
data.assigned_department[avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.assigned_department[avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.assigned_department[avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.assigned_department[avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.assigned_department[avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.assigned_department[avatar][file_url]	string	*	The HTTP link to download the file.
data.assigned_department[avatar][authcode]	string	*
data.assigned_department[avatar][blob_hash]	string	*
data.assigned_department[avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.assigned_department[avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.assigned_department[avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.assigned_department[avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.assigned_department[avatar][date_created]	DateTime	*
data.assigned_department[avatar][is_temp]	boolean	*
data.assigned_department[avatar][source_ref]	string	*
data.assigned_department[avatar][labels][]	array of objects (LabelBlob)	*
data.assigned_department[avatar][labels][][blob]	object (Blob)	*
data.assigned_department[avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.assigned_department[brands][]	array of objects (Brand)	*
data.assigned_department[brands][][id]	integer	*	The unique ID.
data.assigned_department[brands][][name]	string	*	The brand name.
data.assigned_department[brands][][slug]	string	*
data.assigned_department[brands][][url]	string	*	The brand url.
data.assigned_department[brands][][theme_set]	object (ThemeSet)	*
data.assigned_department[brands][][theme_set][id]	integer	*
data.assigned_department[brands][][theme_set][theme_id]	string	*
data.assigned_department[brands][][theme_set][title]	string	*
data.assigned_department[brands][][theme_set][options]		*
data.assigned_department[brands][][edit_theme_set]	object (ThemeSet)	*
data.assigned_department[brands][][departments][]	array of objects (Department)	*
data.assigned_department[brands][][theme_sets][]	array of objects (ThemeSet)	*
data.assigned_department[permissions][]	array of objects (DepartmentPermission)	*
data.assigned_department[permissions][][department]	integer id (Department)	*
data.assigned_department[permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.assigned_department[permissions][][name]	string	*	The name of the permission.
data.assigned_department[permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.assigned_department[permissions][][is_active]	boolean	*
data.assigned_department[chat_queue]	object (UserChatQueue)	*
data.assigned_department[chat_queue][id]	integer	*	The unique ID.
data.assigned_department[chat_queue][name]	string	*
data.assigned_department[chat_queue][routing_model]	string	*
data.assigned_department[chat_queue][answer_timeout]	integer	*
data.assigned_department[chat_queue][is_all_agents]	boolean	*
data.assigned_department[chat_queue][departments][]	array of objects (Department)	*
data.assigned_department[chat_queue][max_queue_size]	integer	*
data.assigned_department[chat_queue][routingModel]		*
data.assigned_agent_team	object (AgentTeam)	*	The agent team assigned to complete this task.
data.assigned_agent_team[id]	integer	*	The unique ID.
data.assigned_agent_team[name]	string	*	The name of agent team.
data.assigned_agent_team[avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.assigned_agent_team[members]		*
data.labels[]	array of objects (LabelTask)	*	Labels associated with this task.
data.labels[][task]	object (Task)	*
data.labels[][task][tickets][]	array of integer ids (Ticket)	*
data.labels[][task][id]	integer	*	The unique ID.
data.labels[][task][is_completed]	boolean	*	Whether this task is completed.
data.labels[][task][title]	string	*	The task's title.
data.labels[][task][visibility]	integer	*	The task's visibility. On of: self::PRIVATE_VISIBILITY(0) or self::PUBLIC_VISIBILITY(1).
data.labels[][task][date_due]	DateTime	*	The task's optional due date.
data.labels[][task][date_created]	DateTime	*	The date the task was inserted into the system.
data.labels[][task][date_completed]	DateTime	*	The date the task was completed.
data.labels[][task][person]	object (Person)	*	The person created this task.
data.labels[][task][assigned_agent]	object (Person)	*	The person assigned to complete this task.
data.labels[][task][assigned_department]	object (Department)	*	The department assigned to complete this task.
data.labels[][task][assigned_agent_team]	object (AgentTeam)	*	The agent team assigned to complete this task.
data.labels[][task][labels][]	array of objects (LabelTask)	*	Labels associated with this task.
data.labels[][task][comments][]	array of objects (TaskComment)	*
data.labels[][task][comments][][id]	integer	*	The unique ID.
data.labels[][task][comments][][content]	string	*	The comment's content.
data.labels[][task][comments][][task]	integer id (Task)	*	Task containing comment.
data.labels[][task][comments][][person]	integer id (Person)	*	Person created this comment.
data.labels[][task][comments][][date_created]	DateTime	*	The date the comment was inserted into the system.
data.labels[][label]		*
data.comments[]	array of objects (TaskComment)	*
data.comments[][id]	integer	*	The unique ID.
data.comments[][content]	string	*	The comment's content.
data.comments[][task]	integer id (Task)	*	Task containing comment.
data.comments[][person]	integer id (Person)	*	Person created this comment.
data.comments[][date_created]	DateTime	*	The date the comment was inserted into the system.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/tasks/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tasks.tasks.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format
title	string	false
person	choice	false
date_due	datetime	false	yyyy-MM-dd'T'HH:mm:ss
visibility	choice	false	[0,1]
assigned_agent	choice	false
assigned_agent_team	choice	false
assigned_department	choice	false
date_completed	datetime	false	yyyy-MM-dd'T'HH:mm:ss
is_completed	boolean	false
ticket	float	false
tickets[]	array of choices	false
labels[]	array of strings	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/tasks/{parentId}/comments CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

tasks.tasks_comments.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (TaskComment)	*
data[][id]	integer	*	The unique ID.
data[][content]	string	*	The comment's content.
data[][task]	integer id (Task)	*	Task containing comment.
data[][person]	integer id (Person)	*	Person created this comment.
data[][date_created]	DateTime	*	The date the comment was inserted into the system.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/tasks/{parentId}/comments CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tasks.tasks_comments.post

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Required?	Format	Description
content	string	true

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.content	string	*	The comment's content.
data.task	integer id (Task)	*	Task containing comment.
data.person	integer id (Person)	*	Person created this comment.
data.date_created	DateTime	*	The date the comment was inserted into the system.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/tasks/{parentId}/comments/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

tasks.tasks_comments.count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/tasks/{parentId}/comments/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tasks.tasks_comments.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/tasks/{parentId}/comments/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tasks.tasks_comments.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.content	string	*	The comment's content.
data.task	integer id (Task)	*	Task containing comment.
data.person	integer id (Person)	*	Person created this comment.
data.date_created	DateTime	*	The date the comment was inserted into the system.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/tasks/{parentId}/comments/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tasks.tasks_comments.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Required?	Format	Description
content	string	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/webhooks/{parentId}/triggers CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

webhooks.webhook_triggers.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (TaskComment)	*
data[][id]	integer	*	The unique ID.
data[][content]	string	*	The comment's content.
data[][task]	integer id (Task)	*	Task containing comment.
data[][person]	integer id (Person)	*	Person created this comment.
data[][date_created]	DateTime	*	The date the comment was inserted into the system.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/webhooks/{parentId}/triggers CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

webhooks.webhook_triggers.post

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Required?	Format	Description
content	string	true

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.content	string	*	The comment's content.
data.task	integer id (Task)	*	Task containing comment.
data.person	integer id (Person)	*	Person created this comment.
data.date_created	DateTime	*	The date the comment was inserted into the system.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/webhooks/{parentId}/triggers/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

webhooks.webhook_triggers.count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/webhooks/{parentId}/triggers/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

webhooks.webhook_triggers.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/webhooks/{parentId}/triggers/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

webhooks.webhook_triggers.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.content	string	*	The comment's content.
data.task	integer id (Task)	*	Task containing comment.
data.person	integer id (Person)	*	Person created this comment.
data.date_created	DateTime	*	The date the comment was inserted into the system.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/webhooks/{parentId}/triggers/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

webhooks.webhook_triggers.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Required?	Format	Description
content	string	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

Show/hide List Operations Expand Operations

Text snippets

GET /api/v2/{context}_snippet_categories CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

text_snippets.text_snippet_categories.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
context	(ticket\|chat)

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (TextSnippetCategory)	*
data[][id]	integer	*	The unique snippet category ID.
data[][title]	string	*	Snippet category title (it's localized).
data[][person]	integer id (Person)	*	Person - owner of this snippet category.
data[][is_global]	boolean	*	Is this snippet category global?

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/{context}_snippet_categories CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

text_snippets.text_snippet_categories.post

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
context	(ticket\|chat)

Parameter	Type	Required?
title[][language]	choice	true
title[][value]	string	true
is_global	boolean	false

Parameter	Type	Versions	Description
data.id	integer	*	The unique snippet category ID.
data.title	string	*	Snippet category title (it's localized).
data.person	integer id (Person)	*	Person - owner of this snippet category.
data.is_global	boolean	*	Is this snippet category global?

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/{context}_snippet_categories/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

text_snippets.text_snippet_categories.count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
context	(ticket\|chat)

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/{context}_snippet_categories/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

text_snippets.text_snippet_categories.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
context	(ticket\|chat)

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/{context}_snippet_categories/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

text_snippets.text_snippet_categories.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
context	(ticket\|chat)

Parameter	Type	Versions	Description
data.id	integer	*	The unique snippet category ID.
data.title	string	*	Snippet category title (it's localized).
data.person	integer id (Person)	*	Person - owner of this snippet category.
data.is_global	boolean	*	Is this snippet category global?

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/{context}_snippet_categories/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

text_snippets.text_snippet_categories.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
context	(ticket\|chat)

Parameter	Type	Required?
title[][language]	choice	false
title[][value]	string	false
is_global	boolean	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/{context}_snippet_categories/{id}/snippets

get the snippets within a category

Applicable api modes

session token key oauth

Api tags for this endpoint

text_snippets.text_snippet_categories.get_snippets

Requirements
Response
Status Codes

Name	Requirement	Type	Description
snippet	ticket\|chat	string	the context of the category
id	\d+	integer	the id of the category
context	(ticket\|chat)

Parameter	Type	Versions	Description
data[]	array of objects (TextSnippet)	*
data[][id]	integer	*	The unique snippet ID.
data[][title]	string	*	Snippet title (it's localized).
data[][person]	integer id (Person)	*	Person - owner of this snippet.
data[][category]	integer id (TextSnippetCategory)	*	Category this snippet belongs to.
data[][shortcut_code]	string	*	Shortcut for this snippet.
data[][is_draft]	boolean	*	Is this just a draft?
data[][text_snippet_content]	custom handler result for (raw)	*

Status Code	Description
200	Success
404	We can't find such snippet category or context is wrong

GET /api/v2/{context}_snippets CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

text_snippets.text_snippets.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
context	(ticket\|chat)

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (TextSnippet)	*
data[][id]	integer	*	The unique snippet ID.
data[][title]	string	*	Snippet title (it's localized).
data[][person]	integer id (Person)	*	Person - owner of this snippet.
data[][category]	integer id (TextSnippetCategory)	*	Category this snippet belongs to.
data[][shortcut_code]	string	*	Shortcut for this snippet.
data[][is_draft]	boolean	*	Is this just a draft?
data[][text_snippet_content]	custom handler result for (raw)	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/{context}_snippets CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

text_snippets.text_snippets.post

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
context	(ticket\|chat)

Parameter	Type	Required?
title[][language]	choice	true
title[][value]	string	true
snippet[][language]	choice	true
snippet[][value]	string	true
category	choice	true
shortcut_code	string	true
is_draft	boolean	false
is_global	boolean	false

Parameter	Type	Versions	Description
data.id	integer	*	The unique snippet ID.
data.title	string	*	Snippet title (it's localized).
data.person	integer id (Person)	*	Person - owner of this snippet.
data.category	integer id (TextSnippetCategory)	*	Category this snippet belongs to.
data.shortcut_code	string	*	Shortcut for this snippet.
data.is_draft	boolean	*	Is this just a draft?
data.text_snippet_content	custom handler result for (raw)	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/{context}_snippets/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

text_snippets.text_snippets.count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
context	(ticket\|chat)

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/{context}_snippets/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

text_snippets.text_snippets.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
context	(ticket\|chat)

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/{context}_snippets/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

text_snippets.text_snippets.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
context	(ticket\|chat)

Parameter	Type	Versions	Description
data.id	integer	*	The unique snippet ID.
data.title	string	*	Snippet title (it's localized).
data.person	integer id (Person)	*	Person - owner of this snippet.
data.category	integer id (TextSnippetCategory)	*	Category this snippet belongs to.
data.shortcut_code	string	*	Shortcut for this snippet.
data.is_draft	boolean	*	Is this just a draft?
data.text_snippet_content	custom handler result for (raw)	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/{context}_snippets/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

text_snippets.text_snippets.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
context	(ticket\|chat)

Parameter	Type	Required?
title[][language]	choice	false
title[][value]	string	false
snippet[][language]	choice	false
snippet[][value]	string	false
category	choice	false
shortcut_code	string	false
is_draft	boolean	false
is_global	boolean	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/{context}_snippets/{id}/content

get the snippets content

Applicable api modes

session token key oauth

Api tags for this endpoint

text_snippets.text_snippets.get_content

Requirements
Response
Status Codes

Name	Requirement	Type	Description
snippet	ticket\|chat	string	the context of the category
id	\d+	integer	the id of the snippet
context	(ticket\|chat)	string

Parameter	Type	Versions	Description
data[]	array of objects (Application\DeskPRO\Entity\TextSnippetContent)	*

Status Code	Description
200	Success
404	We can't find such snippet or context is wrong

Show/hide List Operations Expand Operations

Ticket Form Widget

GET /api/v2/ticket-form-widget/code

Get ticket form widget JS code

Show/hide List Operations Expand Operations

Ticket filters (legacy)

GET /api/v2/ticket_filter_sets

get filter sets

Documentation

Get the list of ticket filter sets available.

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.legacy_filters.ticket_filter_sets.list

Response
Status Codes

Parameter	Type	Versions	Description
data[]	array of objects (LegacyTicketFilterSet)	*
data[][id]	integer	*	The unique ID of filter set.
data[][title]	string	*	Title for current filter set.
data[][display_order]	integer	*	It's display order.
data[][filters][]	array of integer ids (LegacyTicketFilter)	*	Filters that belons this filter set.
data[][is_default]	boolean	*	True if this filter set is default one.
data[][private_agent]	integer id (Person)	*	Person id if this stuff belongs to somebody privately.
data[][shared_agents][]	array of integer ids (Person)	*	Ids of agent shares this filter set.

Status Code	Description
200	Returned with the list if filters

GET /api/v2/ticket_filter_sets/all/counts

Get all filter set counts

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.legacy_filters.ticket_counts.get_all_ticket_filter_set_counts

Requirements
Response
Status Codes

Name	Requirement	Type	Description
group_by		array	[Ticket filter ID => group_by] map

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Success
404	Not Found

GET /api/v2/ticket_filter_sets/{id}

get a filter set

Documentation

Get a filter set with given id.

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.legacy_filters.ticket_filter_sets.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	the id of the filter set

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID of filter set.
data.title	string	*	Title for current filter set.
data.display_order	integer	*	It's display order.
data.filters[]	array of integer ids (LegacyTicketFilter)	*	Filters that belons this filter set.
data.is_default	boolean	*	True if this filter set is default one.
data.private_agent	integer id (Person)	*	Person id if this stuff belongs to somebody privately.
data.shared_agents[]	array of integer ids (Person)	*	Ids of agent shares this filter set.

Status Code	Description
200	Everything is OK, we found your filter set
404	Filter set with provide ID wasn't found

GET /api/v2/ticket_filter_sets/{id}/count

Get a filter set count

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.legacy_filters.ticket_counts.get_ticket_filter_set_count

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	the id of the filter

Name

Information

group_by

Description	[Ticket filter ID => group_by] map
Datatype	array
Pattern	\w+

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Success
404	Not Found

GET /api/v2/ticket_filter_sets/{id}/filters

get filters belong to filter set

Documentation

Get the filters within a filter set.

note: that could be done with sideloading

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.legacy_filters.ticket_filter_sets.get_set_filters

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	the id of the filter set

Parameter	Type	Versions	Description
data[]	array of objects (Application\DeskPRO\Entity\TicketFilter)	*

Status Code	Description
200	Everything is OK, here is your filters
404	Filter set with provide ID wasn't found

GET /api/v2/ticket_filters/{id}/count

Get a filter's count

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.legacy_filters.ticket_counts.get_ticket_filter_count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	the id of the filter
group_by	.+	string	the grouping order you want

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Success
404	Not Found

GET /api/v2/ticket_filters_counts

Get all filters counts

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.legacy_filters.ticket_counts.get_all_ticket_filter_counts

Requirements
Response
Status Codes

Name	Requirement	Type	Description
group_by	.+	string	[Ticket filter ID => group_by] map

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Success
404	Not Found

Show/hide List Operations Expand Operations

Ticket filters (legacy) stub. Really works with new filters

GET /api/v2/ticket_filters CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.legacy_filters.ticket_filters.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (TicketFilter)	*
data[][title]	string	*	The filter`s title.
data[][query]	string	*	FQL query.
data[][id]	integer	*	The unique filter ID.
data[][is_enabled]	boolean	*
data[][is_global]	boolean	*
data[][shared_teams][]	array of integer ids (AgentTeam)	*	Specific teams to share this with.
data[][shared_agents][]	array of integer ids (Person)	*	Specific agents to share this with.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/ticket_filters CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.legacy_filters.ticket_filters.post

Response
Status Codes

Parameter	Type	Versions	Description
data.title	string	*	The filter`s title.
data.query	string	*	FQL query.
data.id	integer	*	The unique filter ID.
data.is_enabled	boolean	*
data.is_global	boolean	*
data.shared_teams[]	array of integer ids (AgentTeam)	*	Specific teams to share this with.
data.shared_agents[]	array of integer ids (Person)	*	Specific agents to share this with.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

DELETE /api/v2/ticket_filters/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.legacy_filters.ticket_filters.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/ticket_filters/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.legacy_filters.ticket_filters.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.title	string	*	The filter`s title.
data.query	string	*	FQL query.
data.id	integer	*	The unique filter ID.
data.is_enabled	boolean	*
data.is_global	boolean	*
data.shared_teams[]	array of integer ids (AgentTeam)	*	Specific teams to share this with.
data.shared_agents[]	array of integer ids (Person)	*	Specific agents to share this with.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/ticket_filters/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.legacy_filters.ticket_filters.put

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/ticket_filters/{ticketFilter}/count

Get filter's count

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.legacy_filters.ticket_filters.get_filter_count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
group_by	.+	string	the grouping you want
ticketFilter		TicketFilter

Parameter	Type	Versions	Description
data[]	array of objects (Ticket)	*
data[][id]	integer	*	The unique ID.
data[][ref]	string	*	String reference.
data[][auth]	string	*	Auth string.
data[][parent]	integer id (Ticket)	*	Parent of this ticket.
data[][language]	integer id (Language)	*	Language associated with this ticket.
data[][brand]	integer id (Brand)	*	Ticket brand.
data[][department]	integer id (Department)	*	Ticket where this department is processing.
data[][category]	integer id (TicketCategory)	*	Category of this ticket.
data[][priority]	integer id (TicketPriority)	*	Priority of this ticket.
data[][workflow]	integer id (TicketWorkflow)	*	Workflow entity.
data[][product]	integer id (Product)	*	Product about which this ticket.
data[][person]	integer id (Person)	*	Person created this ticket.
data[][person_email]	string representation (PersonEmail)	*	Person's email.
data[][agent]	integer id (Person)	*	Agent assigned.
data[][agent_team]	integer id (AgentTeam)	*	Agent team where this ticket is processing.
data[][organization]	integer id (Organization)	*	Organization team where this ticket is processing.
data[][linked_chat]	integer id (ChatConversation)	*	ChatConversation where this ticket is discussed.
data[][sent_to_address]	array	*	Addresses where ticket was send.
data[][email_account]	integer id (EmailAccount)	*	Email account used to gather the ticket.
data[][email_account_address]	string	*	Email account address used to gather the ticket.
data[][creation_system]	string	*	How this ticket appears.
data[][creation_system_option]	string	*	Option used by creation system.
data[][ticket_hash]	string	*	Unique hash.
data[][status]	string	<=20170400	Legacy ticket status.
data[][hidden_status]	string	<=20170400	Legacy ticket hidden status.
data[][ticket_status]	string	*	Ticket status.
data[][is_hold]	boolean	*	Is this on hold?
data[][labels][]	array of strings	*	String array of labels.
data[][urgency]	integer	*	How urgent this ticket?
data[][feedback_rating]	integer	*	Its rating based on feedback votes.
data[][date_feedback_rating]	DateTime	*	When the rating was calculated.
data[][date_created]	DateTime	*	When the ticket was created.
data[][date_resolved]	DateTime	*	When the ticket was resolved.
data[][date_archived]	DateTime	*	And archived at last.
data[][date_first_agent_assign]	DateTime	*	When it was assigned to agent at the very first time.
data[][date_first_agent_reply]	DateTime	*	When it was first time replied.
data[][date_last_agent_reply]	DateTime	*	And when it was replied the last time.
data[][date_last_user_reply]	DateTime	*	And the date user replied here last time.
data[][date_agent_waiting]	DateTime	*	Time when agent started to wait user.
data[][date_user_waiting]	DateTime	*	And the time when user started to wait agent.
data[][date_status]	DateTime	*	When status was changed.
data[][total_user_waiting]	integer	*	How much user was waited?
data[][total_to_first_reply]	integer	*	Total waiting before first reply.
data[][total_user_waiting_wh]	integer	*	Total user waiting in working hours.
data[][total_to_first_reply_wh]	integer	*	Total waiting before first reply in working hour.
data[][locked_by_agent]	integer id (Person)	*	An agent who locked the ticket.
data[][date_locked]	DateTime	*	Date time when ticket was locked.
data[][date_on_hold]	DateTime	*	Datetime when ticket was set on hold.
data[][has_attachments]	boolean	*	Does this ticket has attachments?
data[][subject]	string	*	Ticket subject.
data[][original_subject]	string	*	Original subject given by creator.
data[][properties]	array	*	Array of properties.
data[][problems][]	array of integer ids (Problem)	*	An array of associated problems.
data[][count_agent_replies]	integer	*	Count of all replies made by agents.
data[][count_user_replies]	integer	*	Count of all replies made by user.
data[][worst_sla_status]	string	*	Well, this is worst SLA status.
data[][waiting_times]	array	*	An array of waiting times.
data[][ticket_slas][]	array of integer ids (TicketSla)	*	All ticket SLAS.
data[][fields][]	dynamically declared custom fields (ticket)	*	Custom ticket fields.
data[][contextual_fields]	custom handler result for (custom_per_data)	*	Contextual ticket fields (per user/org fields).
data[][children][]	array of integer ids (Ticket)	*	Ticket children.
data[][siblings][]	array of integer ids (Ticket)	*	Ticket siblings.
data[][cc][]	array of integer ids (Person)	*	User should be acknowledged about this ticket.
data[][star]	string	*	Person star color.
data[][ticket_layout]	custom handler result for (raw)	*
data[][ticket_excerpt]	custom handler result for (raw)	*
data[][ticket_agent_errors]	custom handler result for (raw)	*
data[][ticket_user_errors]	custom handler result for (raw)	*
data[][ticket_permissions]	custom handler result for (raw)	*
data[][access_code]	string	*	Access code.
data[][followers]	string	*	Followers of that ticket as a comma-separated list of names.

Status Code	Description
200	Success

GET /api/v2/ticket_filters/{ticketFilter}/tickets

Get filter's tickets. See /tickets endpoint docs for the parameter details.

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.legacy_filters.ticket_filters.get_filter_tickets

Requirements
Response
Status Codes

Name	Requirement	Type	Description
order_by	.+	string	Specify a field to order by, and optionally direction. Example: ticket.date_created:desc
ticketFilter		TicketFilter

Parameter	Type	Versions	Description
data[]	array of objects (Ticket)	*
data[][id]	integer	*	The unique ID.
data[][ref]	string	*	String reference.
data[][auth]	string	*	Auth string.
data[][parent]	integer id (Ticket)	*	Parent of this ticket.
data[][language]	integer id (Language)	*	Language associated with this ticket.
data[][brand]	integer id (Brand)	*	Ticket brand.
data[][department]	integer id (Department)	*	Ticket where this department is processing.
data[][category]	integer id (TicketCategory)	*	Category of this ticket.
data[][priority]	integer id (TicketPriority)	*	Priority of this ticket.
data[][workflow]	integer id (TicketWorkflow)	*	Workflow entity.
data[][product]	integer id (Product)	*	Product about which this ticket.
data[][person]	integer id (Person)	*	Person created this ticket.
data[][person_email]	string representation (PersonEmail)	*	Person's email.
data[][agent]	integer id (Person)	*	Agent assigned.
data[][agent_team]	integer id (AgentTeam)	*	Agent team where this ticket is processing.
data[][organization]	integer id (Organization)	*	Organization team where this ticket is processing.
data[][linked_chat]	integer id (ChatConversation)	*	ChatConversation where this ticket is discussed.
data[][sent_to_address]	array	*	Addresses where ticket was send.
data[][email_account]	integer id (EmailAccount)	*	Email account used to gather the ticket.
data[][email_account_address]	string	*	Email account address used to gather the ticket.
data[][creation_system]	string	*	How this ticket appears.
data[][creation_system_option]	string	*	Option used by creation system.
data[][ticket_hash]	string	*	Unique hash.
data[][status]	string	<=20170400	Legacy ticket status.
data[][hidden_status]	string	<=20170400	Legacy ticket hidden status.
data[][ticket_status]	string	*	Ticket status.
data[][is_hold]	boolean	*	Is this on hold?
data[][labels][]	array of strings	*	String array of labels.
data[][urgency]	integer	*	How urgent this ticket?
data[][feedback_rating]	integer	*	Its rating based on feedback votes.
data[][date_feedback_rating]	DateTime	*	When the rating was calculated.
data[][date_created]	DateTime	*	When the ticket was created.
data[][date_resolved]	DateTime	*	When the ticket was resolved.
data[][date_archived]	DateTime	*	And archived at last.
data[][date_first_agent_assign]	DateTime	*	When it was assigned to agent at the very first time.
data[][date_first_agent_reply]	DateTime	*	When it was first time replied.
data[][date_last_agent_reply]	DateTime	*	And when it was replied the last time.
data[][date_last_user_reply]	DateTime	*	And the date user replied here last time.
data[][date_agent_waiting]	DateTime	*	Time when agent started to wait user.
data[][date_user_waiting]	DateTime	*	And the time when user started to wait agent.
data[][date_status]	DateTime	*	When status was changed.
data[][total_user_waiting]	integer	*	How much user was waited?
data[][total_to_first_reply]	integer	*	Total waiting before first reply.
data[][total_user_waiting_wh]	integer	*	Total user waiting in working hours.
data[][total_to_first_reply_wh]	integer	*	Total waiting before first reply in working hour.
data[][locked_by_agent]	integer id (Person)	*	An agent who locked the ticket.
data[][date_locked]	DateTime	*	Date time when ticket was locked.
data[][date_on_hold]	DateTime	*	Datetime when ticket was set on hold.
data[][has_attachments]	boolean	*	Does this ticket has attachments?
data[][subject]	string	*	Ticket subject.
data[][original_subject]	string	*	Original subject given by creator.
data[][properties]	array	*	Array of properties.
data[][problems][]	array of integer ids (Problem)	*	An array of associated problems.
data[][count_agent_replies]	integer	*	Count of all replies made by agents.
data[][count_user_replies]	integer	*	Count of all replies made by user.
data[][worst_sla_status]	string	*	Well, this is worst SLA status.
data[][waiting_times]	array	*	An array of waiting times.
data[][ticket_slas][]	array of integer ids (TicketSla)	*	All ticket SLAS.
data[][fields][]	dynamically declared custom fields (ticket)	*	Custom ticket fields.
data[][contextual_fields]	custom handler result for (custom_per_data)	*	Contextual ticket fields (per user/org fields).
data[][children][]	array of integer ids (Ticket)	*	Ticket children.
data[][siblings][]	array of integer ids (Ticket)	*	Ticket siblings.
data[][cc][]	array of integer ids (Person)	*	User should be acknowledged about this ticket.
data[][star]	string	*	Person star color.
data[][ticket_layout]	custom handler result for (raw)	*
data[][ticket_excerpt]	custom handler result for (raw)	*
data[][ticket_agent_errors]	custom handler result for (raw)	*
data[][ticket_user_errors]	custom handler result for (raw)	*
data[][ticket_permissions]	custom handler result for (raw)	*
data[][access_code]	string	*	Access code.
data[][followers]	string	*	Followers of that ticket as a comma-separated list of names.

Status Code	Description
200	Success

Show/hide List Operations Expand Operations

Ticket filters (new)

GET /api/v2/ticket_filters2 CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.filters.ticket_filters.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (TicketFilter)	*
data[][title]	string	*	The filter`s title.
data[][query]	string	*	FQL query.
data[][id]	integer	*	The unique filter ID.
data[][is_enabled]	boolean	*
data[][is_global]	boolean	*
data[][shared_teams][]	array of integer ids (AgentTeam)	*	Specific teams to share this with.
data[][shared_agents][]	array of integer ids (Person)	*	Specific agents to share this with.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/ticket_filters2 CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.filters.ticket_filters.post

Response
Status Codes

Parameter	Type	Versions	Description
data.title	string	*	The filter`s title.
data.query	string	*	FQL query.
data.id	integer	*	The unique filter ID.
data.is_enabled	boolean	*
data.is_global	boolean	*
data.shared_teams[]	array of integer ids (AgentTeam)	*	Specific teams to share this with.
data.shared_agents[]	array of integer ids (Person)	*	Specific agents to share this with.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

DELETE /api/v2/ticket_filters2/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.filters.ticket_filters.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/ticket_filters2/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.filters.ticket_filters.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.title	string	*	The filter`s title.
data.query	string	*	FQL query.
data.id	integer	*	The unique filter ID.
data.is_enabled	boolean	*
data.is_global	boolean	*
data.shared_teams[]	array of integer ids (AgentTeam)	*	Specific teams to share this with.
data.shared_agents[]	array of integer ids (Person)	*	Specific agents to share this with.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/ticket_filters2/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.filters.ticket_filters.put

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/ticket_filters2/{ticketFilter}/count

Get filter's count

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.filters.ticket_filters.get_filter_count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
group_by	.+	string	the grouping you want
ticketFilter		TicketFilter

Parameter	Type	Versions	Description
data[]	array of objects (Ticket)	*
data[][id]	integer	*	The unique ID.
data[][ref]	string	*	String reference.
data[][auth]	string	*	Auth string.
data[][parent]	integer id (Ticket)	*	Parent of this ticket.
data[][language]	integer id (Language)	*	Language associated with this ticket.
data[][brand]	integer id (Brand)	*	Ticket brand.
data[][department]	integer id (Department)	*	Ticket where this department is processing.
data[][category]	integer id (TicketCategory)	*	Category of this ticket.
data[][priority]	integer id (TicketPriority)	*	Priority of this ticket.
data[][workflow]	integer id (TicketWorkflow)	*	Workflow entity.
data[][product]	integer id (Product)	*	Product about which this ticket.
data[][person]	integer id (Person)	*	Person created this ticket.
data[][person_email]	string representation (PersonEmail)	*	Person's email.
data[][agent]	integer id (Person)	*	Agent assigned.
data[][agent_team]	integer id (AgentTeam)	*	Agent team where this ticket is processing.
data[][organization]	integer id (Organization)	*	Organization team where this ticket is processing.
data[][linked_chat]	integer id (ChatConversation)	*	ChatConversation where this ticket is discussed.
data[][sent_to_address]	array	*	Addresses where ticket was send.
data[][email_account]	integer id (EmailAccount)	*	Email account used to gather the ticket.
data[][email_account_address]	string	*	Email account address used to gather the ticket.
data[][creation_system]	string	*	How this ticket appears.
data[][creation_system_option]	string	*	Option used by creation system.
data[][ticket_hash]	string	*	Unique hash.
data[][status]	string	<=20170400	Legacy ticket status.
data[][hidden_status]	string	<=20170400	Legacy ticket hidden status.
data[][ticket_status]	string	*	Ticket status.
data[][is_hold]	boolean	*	Is this on hold?
data[][labels][]	array of strings	*	String array of labels.
data[][urgency]	integer	*	How urgent this ticket?
data[][feedback_rating]	integer	*	Its rating based on feedback votes.
data[][date_feedback_rating]	DateTime	*	When the rating was calculated.
data[][date_created]	DateTime	*	When the ticket was created.
data[][date_resolved]	DateTime	*	When the ticket was resolved.
data[][date_archived]	DateTime	*	And archived at last.
data[][date_first_agent_assign]	DateTime	*	When it was assigned to agent at the very first time.
data[][date_first_agent_reply]	DateTime	*	When it was first time replied.
data[][date_last_agent_reply]	DateTime	*	And when it was replied the last time.
data[][date_last_user_reply]	DateTime	*	And the date user replied here last time.
data[][date_agent_waiting]	DateTime	*	Time when agent started to wait user.
data[][date_user_waiting]	DateTime	*	And the time when user started to wait agent.
data[][date_status]	DateTime	*	When status was changed.
data[][total_user_waiting]	integer	*	How much user was waited?
data[][total_to_first_reply]	integer	*	Total waiting before first reply.
data[][total_user_waiting_wh]	integer	*	Total user waiting in working hours.
data[][total_to_first_reply_wh]	integer	*	Total waiting before first reply in working hour.
data[][locked_by_agent]	integer id (Person)	*	An agent who locked the ticket.
data[][date_locked]	DateTime	*	Date time when ticket was locked.
data[][date_on_hold]	DateTime	*	Datetime when ticket was set on hold.
data[][has_attachments]	boolean	*	Does this ticket has attachments?
data[][subject]	string	*	Ticket subject.
data[][original_subject]	string	*	Original subject given by creator.
data[][properties]	array	*	Array of properties.
data[][problems][]	array of integer ids (Problem)	*	An array of associated problems.
data[][count_agent_replies]	integer	*	Count of all replies made by agents.
data[][count_user_replies]	integer	*	Count of all replies made by user.
data[][worst_sla_status]	string	*	Well, this is worst SLA status.
data[][waiting_times]	array	*	An array of waiting times.
data[][ticket_slas][]	array of integer ids (TicketSla)	*	All ticket SLAS.
data[][fields][]	dynamically declared custom fields (ticket)	*	Custom ticket fields.
data[][contextual_fields]	custom handler result for (custom_per_data)	*	Contextual ticket fields (per user/org fields).
data[][children][]	array of integer ids (Ticket)	*	Ticket children.
data[][siblings][]	array of integer ids (Ticket)	*	Ticket siblings.
data[][cc][]	array of integer ids (Person)	*	User should be acknowledged about this ticket.
data[][star]	string	*	Person star color.
data[][ticket_layout]	custom handler result for (raw)	*
data[][ticket_excerpt]	custom handler result for (raw)	*
data[][ticket_agent_errors]	custom handler result for (raw)	*
data[][ticket_user_errors]	custom handler result for (raw)	*
data[][ticket_permissions]	custom handler result for (raw)	*
data[][access_code]	string	*	Access code.
data[][followers]	string	*	Followers of that ticket as a comma-separated list of names.

Status Code	Description
200	Success

GET /api/v2/ticket_filters2/{ticketFilter}/tickets

Get filter's tickets. See /tickets endpoint docs for the parameter details.

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.filters.ticket_filters.get_filter_tickets

Requirements
Response
Status Codes

Name	Requirement	Type	Description
order_by	.+	string	Specify a field to order by, and optionally direction. Example: ticket.date_created:desc
ticketFilter		TicketFilter

Parameter	Type	Versions	Description
data[]	array of objects (Ticket)	*
data[][id]	integer	*	The unique ID.
data[][ref]	string	*	String reference.
data[][auth]	string	*	Auth string.
data[][parent]	integer id (Ticket)	*	Parent of this ticket.
data[][language]	integer id (Language)	*	Language associated with this ticket.
data[][brand]	integer id (Brand)	*	Ticket brand.
data[][department]	integer id (Department)	*	Ticket where this department is processing.
data[][category]	integer id (TicketCategory)	*	Category of this ticket.
data[][priority]	integer id (TicketPriority)	*	Priority of this ticket.
data[][workflow]	integer id (TicketWorkflow)	*	Workflow entity.
data[][product]	integer id (Product)	*	Product about which this ticket.
data[][person]	integer id (Person)	*	Person created this ticket.
data[][person_email]	string representation (PersonEmail)	*	Person's email.
data[][agent]	integer id (Person)	*	Agent assigned.
data[][agent_team]	integer id (AgentTeam)	*	Agent team where this ticket is processing.
data[][organization]	integer id (Organization)	*	Organization team where this ticket is processing.
data[][linked_chat]	integer id (ChatConversation)	*	ChatConversation where this ticket is discussed.
data[][sent_to_address]	array	*	Addresses where ticket was send.
data[][email_account]	integer id (EmailAccount)	*	Email account used to gather the ticket.
data[][email_account_address]	string	*	Email account address used to gather the ticket.
data[][creation_system]	string	*	How this ticket appears.
data[][creation_system_option]	string	*	Option used by creation system.
data[][ticket_hash]	string	*	Unique hash.
data[][status]	string	<=20170400	Legacy ticket status.
data[][hidden_status]	string	<=20170400	Legacy ticket hidden status.
data[][ticket_status]	string	*	Ticket status.
data[][is_hold]	boolean	*	Is this on hold?
data[][labels][]	array of strings	*	String array of labels.
data[][urgency]	integer	*	How urgent this ticket?
data[][feedback_rating]	integer	*	Its rating based on feedback votes.
data[][date_feedback_rating]	DateTime	*	When the rating was calculated.
data[][date_created]	DateTime	*	When the ticket was created.
data[][date_resolved]	DateTime	*	When the ticket was resolved.
data[][date_archived]	DateTime	*	And archived at last.
data[][date_first_agent_assign]	DateTime	*	When it was assigned to agent at the very first time.
data[][date_first_agent_reply]	DateTime	*	When it was first time replied.
data[][date_last_agent_reply]	DateTime	*	And when it was replied the last time.
data[][date_last_user_reply]	DateTime	*	And the date user replied here last time.
data[][date_agent_waiting]	DateTime	*	Time when agent started to wait user.
data[][date_user_waiting]	DateTime	*	And the time when user started to wait agent.
data[][date_status]	DateTime	*	When status was changed.
data[][total_user_waiting]	integer	*	How much user was waited?
data[][total_to_first_reply]	integer	*	Total waiting before first reply.
data[][total_user_waiting_wh]	integer	*	Total user waiting in working hours.
data[][total_to_first_reply_wh]	integer	*	Total waiting before first reply in working hour.
data[][locked_by_agent]	integer id (Person)	*	An agent who locked the ticket.
data[][date_locked]	DateTime	*	Date time when ticket was locked.
data[][date_on_hold]	DateTime	*	Datetime when ticket was set on hold.
data[][has_attachments]	boolean	*	Does this ticket has attachments?
data[][subject]	string	*	Ticket subject.
data[][original_subject]	string	*	Original subject given by creator.
data[][properties]	array	*	Array of properties.
data[][problems][]	array of integer ids (Problem)	*	An array of associated problems.
data[][count_agent_replies]	integer	*	Count of all replies made by agents.
data[][count_user_replies]	integer	*	Count of all replies made by user.
data[][worst_sla_status]	string	*	Well, this is worst SLA status.
data[][waiting_times]	array	*	An array of waiting times.
data[][ticket_slas][]	array of integer ids (TicketSla)	*	All ticket SLAS.
data[][fields][]	dynamically declared custom fields (ticket)	*	Custom ticket fields.
data[][contextual_fields]	custom handler result for (custom_per_data)	*	Contextual ticket fields (per user/org fields).
data[][children][]	array of integer ids (Ticket)	*	Ticket children.
data[][siblings][]	array of integer ids (Ticket)	*	Ticket siblings.
data[][cc][]	array of integer ids (Person)	*	User should be acknowledged about this ticket.
data[][star]	string	*	Person star color.
data[][ticket_layout]	custom handler result for (raw)	*
data[][ticket_excerpt]	custom handler result for (raw)	*
data[][ticket_agent_errors]	custom handler result for (raw)	*
data[][ticket_user_errors]	custom handler result for (raw)	*
data[][ticket_permissions]	custom handler result for (raw)	*
data[][access_code]	string	*	Access code.
data[][followers]	string	*	Followers of that ticket as a comma-separated list of names.

Status Code	Description
200	Success

GET /api/v2/ticket_filters2_sets CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.filters.ticket_filter_sets.list

Filters
Response
Status Codes

Name

Information

mine

Pattern	1\|0
Description	Only get filter sets you are added to. This only applies to admins; regular agents will only ever see their own anyway due to permissions.
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (TicketFilterSet)	*
data[][title]	string	*	The title of set.
data[][filters][]	array of integer ids (TicketFilter)	*
data[][id]	integer	*	The unique set id.
data[][display_order]	integer	*	Display order for set.
data[][is_global]	boolean	*
data[][shared_teams][]	array of integer ids (AgentTeam)	*	Specific teams to share this with.
data[][shared_agents][]	array of integer ids (Person)	*	Specific agents to share this with.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/ticket_filters2_sets CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.filters.ticket_filter_sets.post

Parameters
Response
Status Codes

Parameter	Type	Required?
title	string	true
display_order	integer	true
is_global	boolean	false
shared_teams[]	array of choices	false
shared_agents[]	array of choices	false

Parameter	Type	Versions	Description
data.title	string	*	The title of set.
data.filters[]	array of integer ids (TicketFilter)	*
data.id	integer	*	The unique set id.
data.display_order	integer	*	Display order for set.
data.is_global	boolean	*
data.shared_teams[]	array of integer ids (AgentTeam)	*	Specific teams to share this with.
data.shared_agents[]	array of integer ids (Person)	*	Specific agents to share this with.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

DELETE /api/v2/ticket_filters2_sets/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.filters.ticket_filter_sets.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/ticket_filters2_sets/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.filters.ticket_filter_sets.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.title	string	*	The title of set.
data.filters[]	array of integer ids (TicketFilter)	*
data.id	integer	*	The unique set id.
data.display_order	integer	*	Display order for set.
data.is_global	boolean	*
data.shared_teams[]	array of integer ids (AgentTeam)	*	Specific teams to share this with.
data.shared_agents[]	array of integer ids (Person)	*	Specific agents to share this with.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/ticket_filters2_sets/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.filters.ticket_filter_sets.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?
title	string	false
display_order	integer	false
is_global	boolean	false
shared_teams[]	array of choices	false
shared_agents[]	array of choices	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

Show/hide List Operations Expand Operations

Tickets

GET /api/v2/20170401/ticket_layouts/{context}

Get ticket layouts

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_layouts_20170401.list

Requirements
Response
Status Codes

Name	Requirement	Type	Description
context	agent\|user	string	context for layout

Parameter	Type	Versions	Description
data[]	array of objects (TicketLayout)	*
data[][department]	integer id (Department)	*	Department uses this layout.
data[][fields][]	array of objects (LayoutField)	*	An array of fields describing layout.
data[][fields][][field_type]	string	*
data[][fields][][field_id]	string	*
data[][fields][][options]	object (LayoutFieldOptions)	*
data[][fields][][options][on_newticket]	boolean	*
data[][fields][][options][on_viewticket]	boolean	*
data[][fields][][options][on_viewticket_mode]	string	*
data[][fields][][options][on_editticket]	boolean	*
data[][fields][][options][criteria]	object (LayoutFieldCriteria)	*
data[][fields][][options][criteria][mode]	string	*
data[][fields][][options][criteria][terms][]	array of objects (LayoutFieldCriteriaTerm)	*
data[][fields][][options][criteria][terms][][type]	string	*
data[][fields][][options][criteria][terms][][op]	string	*
data[][fields][][options][criteria][terms][][options]	array	*
data[][fields][][required]	boolean	*
data[][context]	string	*	Agent or user context.

Status Code	Description
200	Returned with list of layouts

GET /api/v2/20170401/ticket_layouts/{context}.js

Get ticket layouts JS with compiled fields criteria

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_layouts_20170401.list_js

Requirements
Status Codes

Name	Requirement	Type	Description
context	agent\|user	string	context for layout

Status Code	Description
200	Returned with list of layouts

GET /api/v2/20170401/ticket_layouts/{context}/{department}

Get ticket department layout for given context

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_layouts_20170401.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
department	\d+\|default	integer\|string	department id for which you want to get layout
context	agent\|user	string	context of layout

Parameter	Type	Versions	Description
data.department	integer id (Department)	*	Department uses this layout.
data.fields[]	array of objects (LayoutField)	*	An array of fields describing layout.
data.fields[][field_type]	string	*
data.fields[][field_id]	string	*
data.fields[][options]	object (LayoutFieldOptions)	*
data.fields[][options][on_newticket]	boolean	*
data.fields[][options][on_viewticket]	boolean	*
data.fields[][options][on_viewticket_mode]	string	*
data.fields[][options][on_editticket]	boolean	*
data.fields[][options][criteria]	object (LayoutFieldCriteria)	*
data.fields[][options][criteria][mode]	string	*
data.fields[][options][criteria][terms][]	array of objects (LayoutFieldCriteriaTerm)	*
data.fields[][options][criteria][terms][][type]	string	*
data.fields[][options][criteria][terms][][op]	string	*
data.fields[][options][criteria][terms][][options]	array	*
data.fields[][required]	boolean	*
data.context	string	*	Agent or user context.

Status Code	Description
200	Returned if everything is ok
400	Returned if department wasn't found

GET /api/v2/20170401/ticket_layouts/{context}/{department}.js

Get ticket department layout JS with compiled fields criteria for given context

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_layouts_20170401.get_js

Requirements
Status Codes

Name	Requirement	Type	Description
department	\d+\|default	integer\|string	department id for which you want to get layout
context	agent\|user	string	context of layout

Status Code	Description
200	Returned if everything is ok
400	Returned if department wasn't found

GET /api/v2/20190110/ticket_statuses

Get all available statuses for tickets, sorted alphabetically

Documentation

Fetch available ticket statuses.

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_statuses_20190110.list

Response
Status Codes

Parameter	Type	Versions	Description
data[]	array of strings	*

Status Code	Description
200	Will be returned if everything is ok

GET /api/v2/20190110/ticket_statuses/{status}/tickets

Get tickets with the given status

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_statuses_20190110.get_tickets_for_status

Requirements
Response
Status Codes

Name	Requirement	Type	Description
status	\w	string	provide a status to filter

Parameter	Type	Versions	Description
data[]	array of objects (Ticket)	*
data[][id]	integer	*	The unique ID.
data[][ref]	string	*	String reference.
data[][auth]	string	*	Auth string.
data[][parent]	integer id (Ticket)	*	Parent of this ticket.
data[][language]	integer id (Language)	*	Language associated with this ticket.
data[][brand]	integer id (Brand)	*	Ticket brand.
data[][department]	integer id (Department)	*	Ticket where this department is processing.
data[][category]	integer id (TicketCategory)	*	Category of this ticket.
data[][priority]	integer id (TicketPriority)	*	Priority of this ticket.
data[][workflow]	integer id (TicketWorkflow)	*	Workflow entity.
data[][product]	integer id (Product)	*	Product about which this ticket.
data[][person]	integer id (Person)	*	Person created this ticket.
data[][person_email]	string representation (PersonEmail)	*	Person's email.
data[][agent]	integer id (Person)	*	Agent assigned.
data[][agent_team]	integer id (AgentTeam)	*	Agent team where this ticket is processing.
data[][organization]	integer id (Organization)	*	Organization team where this ticket is processing.
data[][linked_chat]	integer id (ChatConversation)	*	ChatConversation where this ticket is discussed.
data[][sent_to_address]	array	*	Addresses where ticket was send.
data[][email_account]	integer id (EmailAccount)	*	Email account used to gather the ticket.
data[][email_account_address]	string	*	Email account address used to gather the ticket.
data[][creation_system]	string	*	How this ticket appears.
data[][creation_system_option]	string	*	Option used by creation system.
data[][ticket_hash]	string	*	Unique hash.
data[][status]	string	<=20170400	Legacy ticket status.
data[][hidden_status]	string	<=20170400	Legacy ticket hidden status.
data[][ticket_status]	string	*	Ticket status.
data[][is_hold]	boolean	*	Is this on hold?
data[][labels][]	array of strings	*	String array of labels.
data[][urgency]	integer	*	How urgent this ticket?
data[][feedback_rating]	integer	*	Its rating based on feedback votes.
data[][date_feedback_rating]	DateTime	*	When the rating was calculated.
data[][date_created]	DateTime	*	When the ticket was created.
data[][date_resolved]	DateTime	*	When the ticket was resolved.
data[][date_archived]	DateTime	*	And archived at last.
data[][date_first_agent_assign]	DateTime	*	When it was assigned to agent at the very first time.
data[][date_first_agent_reply]	DateTime	*	When it was first time replied.
data[][date_last_agent_reply]	DateTime	*	And when it was replied the last time.
data[][date_last_user_reply]	DateTime	*	And the date user replied here last time.
data[][date_agent_waiting]	DateTime	*	Time when agent started to wait user.
data[][date_user_waiting]	DateTime	*	And the time when user started to wait agent.
data[][date_status]	DateTime	*	When status was changed.
data[][total_user_waiting]	integer	*	How much user was waited?
data[][total_to_first_reply]	integer	*	Total waiting before first reply.
data[][total_user_waiting_wh]	integer	*	Total user waiting in working hours.
data[][total_to_first_reply_wh]	integer	*	Total waiting before first reply in working hour.
data[][locked_by_agent]	integer id (Person)	*	An agent who locked the ticket.
data[][date_locked]	DateTime	*	Date time when ticket was locked.
data[][date_on_hold]	DateTime	*	Datetime when ticket was set on hold.
data[][has_attachments]	boolean	*	Does this ticket has attachments?
data[][subject]	string	*	Ticket subject.
data[][original_subject]	string	*	Original subject given by creator.
data[][properties]	array	*	Array of properties.
data[][problems][]	array of integer ids (Problem)	*	An array of associated problems.
data[][count_agent_replies]	integer	*	Count of all replies made by agents.
data[][count_user_replies]	integer	*	Count of all replies made by user.
data[][worst_sla_status]	string	*	Well, this is worst SLA status.
data[][waiting_times]	array	*	An array of waiting times.
data[][ticket_slas][]	array of integer ids (TicketSla)	*	All ticket SLAS.
data[][fields][]	dynamically declared custom fields (ticket)	*	Custom ticket fields.
data[][contextual_fields]	custom handler result for (custom_per_data)	*	Contextual ticket fields (per user/org fields).
data[][children][]	array of integer ids (Ticket)	*	Ticket children.
data[][siblings][]	array of integer ids (Ticket)	*	Ticket siblings.
data[][cc][]	array of integer ids (Person)	*	User should be acknowledged about this ticket.
data[][star]	string	*	Person star color.
data[][ticket_layout]	custom handler result for (raw)	*
data[][ticket_excerpt]	custom handler result for (raw)	*
data[][ticket_agent_errors]	custom handler result for (raw)	*
data[][ticket_user_errors]	custom handler result for (raw)	*
data[][ticket_permissions]	custom handler result for (raw)	*
data[][access_code]	string	*	Access code.
data[][followers]	string	*	Followers of that ticket as a comma-separated list of names.

Status Code	Description
200	Returned if request was successful

GET /api/v2/ticket_custom_fields CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_custom_fields.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (CustomDefTicket)	*
data[][title]		*
data[][parent]	object (CustomDefTicket)	*
data[][parent][parent]	object (CustomDefTicket)	*
data[][parent][children][]	array of objects (CustomDefTicket)	*	Field children.
data[][children][]	array of objects (CustomDefTicket)	*	Field children.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/ticket_custom_fields CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_custom_fields.post

Parameters
Response
Status Codes

Parameter	Type	Required?
title	string	true
description	string	true
handler_class	string	true
parent_id	string	true
default_value	string	true
is_enabled	boolean	true
options	string	true
aliases	string	true
is_user_enabled	boolean	true
is_agent_field	boolean	true
display_order	float	true

Parameter	Type	Versions	Description
data.title		*
data.parent	object (CustomDefTicket)	*
data.parent[parent]	object (CustomDefTicket)	*
data.parent[children][]	array of objects (CustomDefTicket)	*	Field children.
data.parent[title]		*
data.children[]	array of objects (CustomDefTicket)	*	Field children.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

DELETE /api/v2/ticket_custom_fields/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_custom_fields.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/ticket_custom_fields/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_custom_fields.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.title		*
data.parent	object (CustomDefTicket)	*
data.parent[parent]	object (CustomDefTicket)	*
data.parent[children][]	array of objects (CustomDefTicket)	*	Field children.
data.parent[title]		*
data.children[]	array of objects (CustomDefTicket)	*	Field children.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/ticket_custom_fields/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_custom_fields.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?
title	string	false
description	string	false
handler_class	string	false
parent_id	string	false
default_value	string	false
is_enabled	boolean	false
options	string	false
aliases	string	false
is_user_enabled	boolean	false
is_agent_field	boolean	false
display_order	float	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/ticket_custom_fields/{parentId}/options CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_custom_field_options.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (CustomDefTicket)	*
data[][title]		*
data[][parent]	object (CustomDefTicket)	*
data[][parent][parent]	object (CustomDefTicket)	*
data[][parent][children][]	array of objects (CustomDefTicket)	*	Field children.
data[][children][]	array of objects (CustomDefTicket)	*	Field children.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/ticket_custom_fields/{parentId}/options CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_custom_field_options.post

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Required?	Format	Description
title	string	true
display_order	integer	false

Parameter	Type	Versions	Description
data.title		*
data.parent	object (CustomDefTicket)	*
data.parent[parent]	object (CustomDefTicket)	*
data.parent[children][]	array of objects (CustomDefTicket)	*	Field children.
data.parent[title]		*
data.children[]	array of objects (CustomDefTicket)	*	Field children.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/ticket_custom_fields/{parentId}/options/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_custom_field_options.count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/ticket_custom_fields/{parentId}/options/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_custom_field_options.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/ticket_custom_fields/{parentId}/options/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_custom_field_options.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Versions	Description
data.title		*
data.parent	object (CustomDefTicket)	*
data.parent[parent]	object (CustomDefTicket)	*
data.parent[children][]	array of objects (CustomDefTicket)	*	Field children.
data.parent[title]		*
data.children[]	array of objects (CustomDefTicket)	*	Field children.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/ticket_custom_fields/{parentId}/options/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_custom_field_options.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Required?	Format	Description
title	string	false
display_order	integer	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

POST /api/v2/ticket_forms/{context}

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_forms.post_context

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
context	agent\|user	string	Ticket layout context

Parameter	Type	Required?	Format	Description
person[id]	string	false
person[name]	string	false
person[email]	string	false
person[fieldId]	string	false
person[key]	string	false
department	choice	true
subject	string	true
message[message]	string	true		Message
message[format]	choice	true	["html","text"]
message[message_source_type]	string	false
message[message_source]	string	false
attachments[][is_inline]	boolean	false
fields	string	true
brand	choice	false
labels[]	array of strings	true

Parameter	Type	Versions	Description
data.department	object (Department)	*
data.department[id]	integer	*
data.department[parent]	object (Department)	*
data.department[children][]	array of objects (Department)	*
data.department[title]	string	*
data.department[user_title]	string	*
data.department[is_tickets_enabled]	boolean	*
data.department[is_chat_enabled]	boolean	*
data.department[display_order]	integer	*
data.department[avatar]	object (Blob)	*
data.department[avatar][sys_name]	string	*	A unique system name for the blob.
data.department[avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.department[avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.department[avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.department[avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.department[avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.department[avatar][file_url]	string	*	The HTTP link to download the file.
data.department[avatar][authcode]	string	*
data.department[avatar][blob_hash]	string	*
data.department[avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.department[avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.department[avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.department[avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.department[avatar][date_created]	DateTime	*
data.department[avatar][is_temp]	boolean	*
data.department[avatar][source_ref]	string	*
data.department[avatar][labels][]	array of objects (LabelBlob)	*
data.department[avatar][labels][][blob]	object (Blob)	*
data.department[avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.department[brands][]	array of objects (Brand)	*
data.department[brands][][id]	integer	*	The unique ID.
data.department[brands][][name]	string	*	The brand name.
data.department[brands][][slug]	string	*
data.department[brands][][url]	string	*	The brand url.
data.department[brands][][theme_set]	object (ThemeSet)	*
data.department[brands][][theme_set][id]	integer	*
data.department[brands][][theme_set][theme_id]	string	*
data.department[brands][][theme_set][title]	string	*
data.department[brands][][edit_theme_set]	object (ThemeSet)	*
data.department[brands][][departments][]	array of objects (Department)	*
data.department[brands][][theme_sets][]	array of objects (ThemeSet)	*
data.department[permissions][]	array of objects (DepartmentPermission)	*
data.department[permissions][][department]	integer id (Department)	*
data.department[permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.department[permissions][][name]	string	*	The name of the permission.
data.department[permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.department[permissions][][is_active]	boolean	*
data.department[chat_queue]	object (UserChatQueue)	*
data.department[chat_queue][id]	integer	*	The unique ID.
data.department[chat_queue][name]	string	*
data.department[chat_queue][routing_model]	string	*
data.department[chat_queue][answer_timeout]	integer	*
data.department[chat_queue][is_all_agents]	boolean	*
data.department[chat_queue][departments][]	array of objects (Department)	*
data.department[chat_queue][max_queue_size]	integer	*
data.department[chat_queue][routingModel]		*
data.person	object (Person)	*
data.person[emails]		*
data.person[labels]		*
data.person[teams]		*
data.person[primary_team]		*
data.person[agentData]		*
data.person[publicUsergroups]		*
data.person[publicAgentgroups]		*
data.agent	object (Person)	*
data.labels[]	array of objects (LabelTicket)	*
data.labels[][ticket]	object (Ticket)	*
data.labels[][ticket][id]	integer	*
data.labels[][ticket][ref]	string	*
data.labels[][ticket][auth]	string	*
data.labels[][ticket][parent_ticket]	object (Ticket)	*	Parent ticket.
data.labels[][ticket][children_tickets][]	array of objects (Ticket)	*
data.labels[][ticket][language]	object (Language)	*	The language the ticket is in.
data.labels[][ticket][language][id]	integer	*	The unique ID.
data.labels[][ticket][language][sys_name]	string	*	The unique sys name assigned to the language.
data.labels[][ticket][language][title]	string	*	Title of the language.
data.labels[][ticket][language][title_local]	string	*	Title of the language.
data.labels[][ticket][language][base_filepath]	string	*	The base filepath for default phrases for this lang.
data.labels[][ticket][language][locale]	string	*	The locale code.
data.labels[][ticket][language][flag_image]	string	*	String path to image.
data.labels[][ticket][language][is_rtl]	boolean	*	True if this is a right-to-left language.
data.labels[][ticket][language][has_user]	boolean	*	True if has user.
data.labels[][ticket][language][has_agent]	boolean	*	True if has agent.
data.labels[][ticket][language][has_admin]	boolean	*	True if has admin.
data.labels[][ticket][language][plural_categories][]	array of strings	*
data.labels[][ticket][language][plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data.labels[][ticket][language][flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`
data.labels[][ticket][brand]	object (Brand)	*
data.labels[][ticket][brand][id]	integer	*	The unique ID.
data.labels[][ticket][brand][name]	string	*	The brand name.
data.labels[][ticket][brand][slug]	string	*
data.labels[][ticket][brand][url]	string	*	The brand url.
data.labels[][ticket][brand][theme_set]	object (ThemeSet)	*
data.labels[][ticket][brand][theme_set][id]	integer	*
data.labels[][ticket][brand][theme_set][theme_id]	string	*
data.labels[][ticket][brand][theme_set][title]	string	*
data.labels[][ticket][brand][edit_theme_set]	object (ThemeSet)	*
data.labels[][ticket][brand][departments][]	array of objects (Department)	*
data.labels[][ticket][brand][theme_sets][]	array of objects (ThemeSet)	*
data.labels[][ticket][department]	object (Department)	*
data.labels[][ticket][category]	object (TicketCategory)	*
data.labels[][ticket][category][id]	integer	*	The unique ID.
data.labels[][ticket][category][parent]	integer id (TicketCategory)	*	This category parent.
data.labels[][ticket][category][title]	string	*	Category title.
data.labels[][ticket][category][display_order]	integer	*	Obviously it's display order for lists.
data.labels[][ticket][priority]	object (TicketPriority)	*
data.labels[][ticket][priority][id]	integer	*	The unique ID.
data.labels[][ticket][priority][title]	string	*	Priority title.
data.labels[][ticket][priority][priority]	integer	*	The priority itself.
data.labels[][ticket][workflow]	object (TicketWorkflow)	*
data.labels[][ticket][workflow][id]	integer	*	The unique ID.
data.labels[][ticket][workflow][title]	string	*	Workflow title.
data.labels[][ticket][workflow][display_order]	integer	*	Workflow display order.
data.labels[][ticket][product]	object (Product)	*
data.labels[][ticket][product][parent]	integer id (Product)	*	Parent of the product.
data.labels[][ticket][person]	object (Person)	*
data.labels[][ticket][person_email]	object (PersonEmail)	*
data.labels[][ticket][person_email][id]	integer	*	The unique ID.
data.labels[][ticket][person_email][person]	integer id (Person)	*	Person owner of email.
data.labels[][ticket][person_email][email]	string	*	The email address.
data.labels[][ticket][person_email][email_domain]	string	*	The email address domain.
data.labels[][ticket][person_email][is_validated]	boolean	*	True if validation passed.
data.labels[][ticket][person_email][date_created]	DateTime	*	The original time the email was created.
data.labels[][ticket][agent]	object (Person)	*
data.labels[][ticket][agent_team]	object (AgentTeam)	*
data.labels[][ticket][agent_team][id]	integer	*	The unique ID.
data.labels[][ticket][agent_team][name]	string	*	The name of agent team.
data.labels[][ticket][agent_team][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.labels[][ticket][organization]	object (Organization)	*
data.labels[][ticket][organization][id]	integer	*	The unique ID.
data.labels[][ticket][organization][picture_blob]	object (Blob)	*	The org picture.
data.labels[][ticket][organization][picture_blob][sys_name]	string	*	A unique system name for the blob.
data.labels[][ticket][organization][picture_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][ticket][organization][picture_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][ticket][organization][picture_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][ticket][organization][picture_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][ticket][organization][picture_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][ticket][organization][picture_blob][file_url]	string	*	The HTTP link to download the file.
data.labels[][ticket][organization][picture_blob][authcode]	string	*
data.labels[][ticket][organization][picture_blob][blob_hash]	string	*
data.labels[][ticket][organization][picture_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][ticket][organization][picture_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][ticket][organization][picture_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][ticket][organization][picture_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][ticket][organization][picture_blob][date_created]	DateTime	*
data.labels[][ticket][organization][picture_blob][is_temp]	boolean	*
data.labels[][ticket][organization][picture_blob][source_ref]	string	*
data.labels[][ticket][organization][picture_blob][labels][]	array of objects (LabelBlob)	*
data.labels[][ticket][organization][picture_blob][labels][][blob]	object (Blob)	*
data.labels[][ticket][organization][icon_property]	object (IconProperty)	*
data.labels[][ticket][organization][icon_property][urn]	string	*
data.labels[][ticket][organization][icon_property][options]	array	*
data.labels[][ticket][organization][name]	string	*	The organization name.
data.labels[][ticket][organization][summary]	string	*	The summary field as filled in by agents.
data.labels[][ticket][organization][importance]	integer	*	The org importance.
data.labels[][ticket][organization][custom_data][]	array of objects (CustomDataOrganization)	*
data.labels[][ticket][organization][custom_data][][organization]	object (Organization)	*
data.labels[][ticket][organization][custom_data][][field]	object (CustomDefOrganization)	*
data.labels[][ticket][organization][custom_data][][field][parent]	object (CustomDefOrganization)	*	Field`s parent.
data.labels[][ticket][organization][custom_data][][field][children][]	array of objects (CustomDefOrganization)	*	Field children.
data.labels[][ticket][organization][custom_data][][root_field]	object (CustomDefOrganization)	*
data.labels[][ticket][organization][usergroups][]	array of objects (Usergroup)	*	Usergroups the user belongs to.
data.labels[][ticket][organization][usergroups][][id]	integer	*	The unique ID, DB-generated.
data.labels[][ticket][organization][usergroups][][title]	string	*	Title of the usergroup.
data.labels[][ticket][organization][usergroups][][note]	string	*	A note or description about the usergroup.
data.labels[][ticket][organization][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.labels[][ticket][organization][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.labels[][ticket][organization][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.labels[][ticket][organization][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.labels[][ticket][organization][usergroups][][permissions][][id]	integer	*	The unique ID.
data.labels[][ticket][organization][usergroups][][permissions][][name]	string	*	The name of the permission.
data.labels[][ticket][organization][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.labels[][ticket][organization][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.labels[][ticket][organization][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.labels[][ticket][organization][usergroups][][department_permissions][][department]	integer id (Department)	*
data.labels[][ticket][organization][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.labels[][ticket][organization][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.labels[][ticket][organization][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.labels[][ticket][organization][usergroups][][department_permissions][][is_active]	boolean	*
data.labels[][ticket][organization][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.labels[][ticket][organization][auto_cc_people][]	array of objects (Person)	*	Users who are set to automatically be added to tickets and other org things.
data.labels[][ticket][organization][labels][]	array of objects (LabelOrganization)	*
data.labels[][ticket][organization][labels][][organization]	object (Organization)	*
data.labels[][ticket][organization][contact_data][]	array of objects (OrganizationContactData)	*
data.labels[][ticket][organization][emails][]	array of objects (OrganizationEmail)	*
data.labels[][ticket][organization][emails][][id]	integer	*	The unique log id.
data.labels[][ticket][organization][emails][][organization]	object (Organization)	*
data.labels[][ticket][organization][emails][][email]	string	*
data.labels[][ticket][organization][emails][][date_created]	DateTime	*
data.labels[][ticket][organization][email_domains][]	array of objects (OrganizationEmailDomain)	*
data.labels[][ticket][organization][email_domains][][domain]	string	*	The email domain.
data.labels[][ticket][organization][email_domains][][organization]	object (Organization)	*	The users organization.
data.labels[][ticket][organization][date_created]	DateTime	*	The date the org was inserted into the system.
data.labels[][ticket][organization][members][]	array of objects (Person)	*
data.labels[][ticket][organization][parent]	object (Organization)	*
data.labels[][ticket][organization][children][]	array of objects (Organization)	*
data.labels[][ticket][organization][tickets][]	array of objects (Ticket)	*
data.labels[][ticket][organization][organization_members][]	array of objects (OrganizationMember)	*
data.labels[][ticket][organization][organization_members][][id]	integer	*
data.labels[][ticket][organization][organization_members][][person]	integer id (Person)	*
data.labels[][ticket][organization][organization_members][][organization]	integer id (Organization)	*
data.labels[][ticket][organization][organization_members][][is_manager]	boolean	*
data.labels[][ticket][organization][organization_members][][position]	string	*
data.labels[][ticket][organization][organization_members][][created_at]	DateTime	*
data.labels[][ticket][organization][organization_members][][updated_at]	DateTime	*
data.labels[][ticket][linked_chat]	object (ChatConversation)	*
data.labels[][ticket][linked_chat][id]	integer	*	The unique id of chat conversation.
data.labels[][ticket][linked_chat][department]	object (Department)	*	Department which chat was assigned.
data.labels[][ticket][linked_chat][brand]	object (Brand)	*	Department which chat was assigned.
data.labels[][ticket][linked_chat][task_id]	integer	*
data.labels[][ticket][linked_chat][ticket]	object (Ticket)	*
data.labels[][ticket][linked_chat][labels][]	array of objects (LabelChatConversation)	*
data.labels[][ticket][linked_chat][labels][][chat]	object (ChatConversation)	*
data.labels[][ticket][linked_chat][subject]	string	*	Subject of the chat conversation.
data.labels[][ticket][linked_chat][status]	string	*	Status of the chat conversation.
data.labels[][ticket][linked_chat][agent]	object (Person)	*	If this is a user conversation, this is the agent assigned.
data.labels[][ticket][linked_chat][agent_team]	object (AgentTeam)	*	If this is a team chat, the team it is.
data.labels[][ticket][linked_chat][person]	object (Person)	*	If this is a user conversation, this is the user who started the chat.
data.labels[][ticket][linked_chat][session]	object (Session)	*	If this is a user convo, this is the users session.
data.labels[][ticket][linked_chat][session][id]	integer	*	The unique ID.
data.labels[][ticket][linked_chat][session][auth]	string	*	The authcode for the session to verify an id.
data.labels[][ticket][linked_chat][session][interface]	string	*	The Interface the session is for.
data.labels[][ticket][linked_chat][session][person]	object (Person)	*
data.labels[][ticket][linked_chat][session][user_agent]	string	*	The users user agent string.
data.labels[][ticket][linked_chat][session][visitor_id]	string	*
data.labels[][ticket][linked_chat][session][ip_address]	string	*	The users IP address.
data.labels[][ticket][linked_chat][session][data]	string	*
data.labels[][ticket][linked_chat][session][is_person]	boolean	*
data.labels[][ticket][linked_chat][session][is_bot]	boolean	*
data.labels[][ticket][linked_chat][session][is_helpdesk]	boolean	*
data.labels[][ticket][linked_chat][session][active_status]	string	*	(Agents) Status (available or away).
data.labels[][ticket][linked_chat][session][is_chat_available]	boolean	*	(Agents) Wehn status is available, if they are available for chat.
data.labels[][ticket][linked_chat][session][date_created]	DateTime	*
data.labels[][ticket][linked_chat][session][date_last]	DateTime	*
data.labels[][ticket][linked_chat][session][date_last_page]	DateTime	*
data.labels[][ticket][linked_chat][visitor_id]	string	*
data.labels[][ticket][linked_chat][person_name]	string	*	User chat: The users name, if they arent a person.
data.labels[][ticket][linked_chat][person_email]	string	*	User chat: The users email, if they aren`t a person.
data.labels[][ticket][linked_chat][participants][]	array of objects (Person)	*
data.labels[][ticket][linked_chat][messages][]	array of objects (ChatMessage)	*
data.labels[][ticket][linked_chat][messages][][id]	integer	*	The unique ID.
data.labels[][ticket][linked_chat][messages][][author_id]	integer	*	Author id (legacy).
data.labels[][ticket][linked_chat][messages][][author_type]	string	*	Author type (legacy).
data.labels[][ticket][linked_chat][messages][][conversation_id]	integer	*	Conversation id (legacy).
data.labels[][ticket][linked_chat][messages][][author]	integer id (Person)	*	Person who created the message.
data.labels[][ticket][linked_chat][messages][][content]	string	*	The message.
data.labels[][ticket][linked_chat][messages][][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.labels[][ticket][linked_chat][messages][][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.labels[][ticket][linked_chat][messages][][is_html]	boolean	*	Is the content an HTML message?
data.labels[][ticket][linked_chat][messages][][metadata]	array	*	Additional data.
data.labels[][ticket][linked_chat][messages][][date_created]	DateTime	*	Date message was created.
data.labels[][ticket][linked_chat][messages][][date_received]	DateTime	*	Date message was received.
data.labels[][ticket][linked_chat][custom_data][]	array of objects (CustomDataChat)	*
data.labels[][ticket][linked_chat][custom_data][][conversation]	object (ChatConversation)	*	The conversation the message belongs to.
data.labels[][ticket][linked_chat][custom_data][][field]	object (CustomDefChat)	*
data.labels[][ticket][linked_chat][custom_data][][field][parent]	object (CustomDefChat)	*
data.labels[][ticket][linked_chat][custom_data][][field][children][]	array of objects (CustomDefChat)	*	Field children.
data.labels[][ticket][linked_chat][custom_data][][root_field]	object (CustomDefChat)	*
data.labels[][ticket][linked_chat][rating_response_time]	integer	*
data.labels[][ticket][linked_chat][rating_overall]	integer	*
data.labels[][ticket][linked_chat][rating_comment]	string	*
data.labels[][ticket][linked_chat][is_agent]	boolean	*	Is this an agent chat.
data.labels[][ticket][linked_chat][is_window]	boolean	*	If the chat is popped out into a window. This is used to make sure the JS widget on pages doesn't load again.
data.labels[][ticket][linked_chat][date_created]	DateTime	*	Date when chat was started.
data.labels[][ticket][linked_chat][date_user_waiting]	DateTime	*	Since when the user has started waiting (i.e., time the assignment was 0).
data.labels[][ticket][linked_chat][date_assigned]	DateTime	*
data.labels[][ticket][linked_chat][date_agent_typing]	DateTime	*	Date when agent typed last time.
data.labels[][ticket][linked_chat][date_first_agent_message]	DateTime	*
data.labels[][ticket][linked_chat][date_ended]	DateTime	*	Date when chat was ended.
data.labels[][ticket][linked_chat][total_to_ended]	integer	*
data.labels[][ticket][linked_chat][ended_by]	string	*	Who ended the chat.
data.labels[][ticket][linked_chat][should_send_transcript]	boolean	*	True if transcript should be send.
data.labels[][ticket][linked_chat][date_transcript_sent]	DateTime	*	Date when transcript was sent.
data.labels[][ticket][linked_chat][email_validation_code]	string	*
data.labels[][ticket][linked_chat][email_validated]	boolean	*
data.labels[][ticket][linked_chat][access_token]	string	*
data.labels[][ticket][attachments][]	array of objects (TicketAttachment)	*
data.labels[][ticket][attachments][][id]	integer	*	The unique ID.
data.labels[][ticket][attachments][][ticket]	integer id (Ticket)	*	Ticket this attachment belongs to.
data.labels[][ticket][attachments][][person]	integer id (Person)	*	Who created the attachment.
data.labels[][ticket][attachments][][blob]	object (Blob)	*	Actual attachment.
data.labels[][ticket][attachments][][blob][sys_name]	string	*	A unique system name for the blob.
data.labels[][ticket][attachments][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][ticket][attachments][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][ticket][attachments][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][ticket][attachments][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][ticket][attachments][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][ticket][attachments][][blob][file_url]	string	*	The HTTP link to download the file.
data.labels[][ticket][attachments][][blob][authcode]	string	*
data.labels[][ticket][attachments][][blob][blob_hash]	string	*
data.labels[][ticket][attachments][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][ticket][attachments][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][ticket][attachments][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][ticket][attachments][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][ticket][attachments][][blob][date_created]	DateTime	*
data.labels[][ticket][attachments][][blob][is_temp]	boolean	*
data.labels[][ticket][attachments][][blob][source_ref]	string	*
data.labels[][ticket][attachments][][blob][labels][]	array of objects (LabelBlob)	*
data.labels[][ticket][attachments][][blob][labels][][blob]	object (Blob)	*
data.labels[][ticket][attachments][][message]	integer id (TicketMessage)	*	Message - holder of this attachment.
data.labels[][ticket][attachments][][is_agent_note]	boolean	*	True if this attachmen just a note.
data.labels[][ticket][attachments][][is_inline]	boolean	*	Is this attachment is embed in message.
data.labels[][ticket][access_codes][]	array of objects (TicketAccessCode)	*
data.labels[][ticket][access_codes][][id]	integer	*
data.labels[][ticket][access_codes][][ticket]	object (Ticket)	*
data.labels[][ticket][access_codes][][person]	object (Person)	*
data.labels[][ticket][access_codes][][auth]	string	*
data.labels[][ticket][messages][]	array of objects (TicketMessage)	*
data.labels[][ticket][messages][][id]	integer	*	The unique id of message.
data.labels[][ticket][messages][][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data.labels[][ticket][messages][][person]	object (Person)	*	Person this message was sent by.
data.labels[][ticket][messages][][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data.labels[][ticket][messages][][email_source][id]	integer	*
data.labels[][ticket][messages][][email_source][uuid]	string	*
data.labels[][ticket][messages][][email_source][blob]	object (Blob)	*
data.labels[][ticket][messages][][email_source][blob][sys_name]	string	*	A unique system name for the blob.
data.labels[][ticket][messages][][email_source][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][ticket][messages][][email_source][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][ticket][messages][][email_source][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][ticket][messages][][email_source][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][ticket][messages][][email_source][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][ticket][messages][][email_source][blob][file_url]	string	*	The HTTP link to download the file.
data.labels[][ticket][messages][][email_source][blob][authcode]	string	*
data.labels[][ticket][messages][][email_source][blob][blob_hash]	string	*
data.labels[][ticket][messages][][email_source][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][ticket][messages][][email_source][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][ticket][messages][][email_source][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][ticket][messages][][email_source][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][ticket][messages][][email_source][blob][date_created]	DateTime	*
data.labels[][ticket][messages][][email_source][blob][is_temp]	boolean	*
data.labels[][ticket][messages][][email_source][blob][source_ref]	string	*
data.labels[][ticket][messages][][email_source][blob][labels][]	array of objects (LabelBlob)	*
data.labels[][ticket][messages][][email_source][blob][labels][][blob]	object (Blob)	*
data.labels[][ticket][messages][][email_source][object_type]	string	*	The type of object this is attached to (should be the table name of the super type, eg: tickets, people, organizations). This typically is not set until after the email is processed (ie the status is 'processed').
data.labels[][ticket][messages][][email_source][object_id]	integer	*	The ID of the object this is attached to.
data.labels[][ticket][messages][][email_source][from_email]	string	*
data.labels[][ticket][messages][][email_source][status]	string	*	The current status of the message: - inserted: Only inserted - processing: Currently processing - complete: Fully processed - error: Tried to process but there was some kind of error (see error_code).
data.labels[][ticket][messages][][email_source][date_status]	DateTime	*
data.labels[][ticket][messages][][email_source][error_code]	string	*	When status is error, this is the code that describes the error.
data.labels[][ticket][messages][][email_source][date_created]	DateTime	*
data.labels[][ticket][messages][][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.labels[][ticket][messages][][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.labels[][ticket][messages][][snippet_use_logs][][id]	integer	*	The unique ID.
data.labels[][ticket][messages][][snippet_use_logs][][snippet]	object (SnippetV2)	*	Snippet used.
data.labels[][ticket][messages][][snippet_use_logs][][snippet][id]	integer	*
data.labels[][ticket][messages][][snippet_use_logs][][snippet][title]	string	*
data.labels[][ticket][messages][][snippet_use_logs][][snippet][author]	object (Person)	*
data.labels[][ticket][messages][][snippet_use_logs][][snippet][is_private]	boolean	*
data.labels[][ticket][messages][][snippet_use_logs][][snippet][avatar]	object (Blob)	*
data.labels[][ticket][messages][][snippet_use_logs][][snippet][avatar][sys_name]	string	*	A unique system name for the blob.
data.labels[][ticket][messages][][snippet_use_logs][][snippet][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][ticket][messages][][snippet_use_logs][][snippet][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][ticket][messages][][snippet_use_logs][][snippet][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][ticket][messages][][snippet_use_logs][][snippet][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][ticket][messages][][snippet_use_logs][][snippet][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][ticket][messages][][snippet_use_logs][][snippet][avatar][file_url]	string	*	The HTTP link to download the file.
data.labels[][ticket][messages][][snippet_use_logs][][snippet][avatar][authcode]	string	*
data.labels[][ticket][messages][][snippet_use_logs][][snippet][avatar][blob_hash]	string	*
data.labels[][ticket][messages][][snippet_use_logs][][snippet][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][ticket][messages][][snippet_use_logs][][snippet][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][ticket][messages][][snippet_use_logs][][snippet][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][ticket][messages][][snippet_use_logs][][snippet][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][ticket][messages][][snippet_use_logs][][snippet][avatar][date_created]	DateTime	*
data.labels[][ticket][messages][][snippet_use_logs][][snippet][avatar][is_temp]	boolean	*
data.labels[][ticket][messages][][snippet_use_logs][][snippet][avatar][source_ref]	string	*
data.labels[][ticket][messages][][snippet_use_logs][][snippet][avatar][labels][]	array of objects (LabelBlob)	*
data.labels[][ticket][messages][][snippet_use_logs][][snippet][avatar][labels][][blob]	object (Blob)	*
data.labels[][ticket][messages][][snippet_use_logs][][snippet][status]	string	*
data.labels[][ticket][messages][][snippet_use_logs][][snippet][shortcut_codes]	array	*
data.labels[][ticket][messages][][snippet_use_logs][][snippet][inline_translations]	array	*
data.labels[][ticket][messages][][snippet_use_logs][][snippet][translations][]	array of objects (SnippetV2Translation)	*
data.labels[][ticket][messages][][snippet_use_logs][][snippet][translations][][id]	integer	*	The unique ID.
data.labels[][ticket][messages][][snippet_use_logs][][snippet][translations][][snippet]	object (SnippetV2)	*	Snippet translated.
data.labels[][ticket][messages][][snippet_use_logs][][snippet][translations][][language]	object (Language)	*
data.labels[][ticket][messages][][snippet_use_logs][][snippet][translations][][content]	array	*	Snippet content.
data.labels[][ticket][messages][][snippet_use_logs][][snippet][translations][][blobs][]	array of objects (Blob)	*
data.labels[][ticket][messages][][snippet_use_logs][][snippet][categories][]	array of objects (SnippetV2Category)	*
data.labels[][ticket][messages][][snippet_use_logs][][snippet][categories][][id]	integer	*
data.labels[][ticket][messages][][snippet_use_logs][][snippet][categories][][title]	string	*
data.labels[][ticket][messages][][snippet_use_logs][][snippet][categories][][is_global]	boolean	*
data.labels[][ticket][messages][][snippet_use_logs][][snippet][categories][][display_order]	integer	*
data.labels[][ticket][messages][][snippet_use_logs][][snippet][categories][][parent]	object (SnippetV2Category)	*
data.labels[][ticket][messages][][snippet_use_logs][][snippet][categories][][agent_teams][]	array of objects (AgentTeam)	*
data.labels[][ticket][messages][][snippet_use_logs][][snippet][display_order]	integer	*
data.labels[][ticket][messages][][snippet_use_logs][][snippet][date_created]	DateTime	*
data.labels[][ticket][messages][][snippet_use_logs][][ticket_message]	object (TicketMessage)	*	Ticket Message where the snippet was used.
data.labels[][ticket][messages][][snippet_use_logs][][chat_message]	object (ChatMessage)	*	Chat Message where the snippet was used.
data.labels[][ticket][messages][][snippet_use_logs][][chat_message][id]	integer	*	The unique ID.
data.labels[][ticket][messages][][snippet_use_logs][][chat_message][author_id]	integer	*	Author id (legacy).
data.labels[][ticket][messages][][snippet_use_logs][][chat_message][author_type]	string	*	Author type (legacy).
data.labels[][ticket][messages][][snippet_use_logs][][chat_message][conversation_id]	integer	*	Conversation id (legacy).
data.labels[][ticket][messages][][snippet_use_logs][][chat_message][author]	integer id (Person)	*	Person who created the message.
data.labels[][ticket][messages][][snippet_use_logs][][chat_message][content]	string	*	The message.
data.labels[][ticket][messages][][snippet_use_logs][][chat_message][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.labels[][ticket][messages][][snippet_use_logs][][chat_message][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.labels[][ticket][messages][][snippet_use_logs][][chat_message][is_html]	boolean	*	Is the content an HTML message?
data.labels[][ticket][messages][][snippet_use_logs][][chat_message][metadata]	array	*	Additional data.
data.labels[][ticket][messages][][snippet_use_logs][][chat_message][date_created]	DateTime	*	Date message was created.
data.labels[][ticket][messages][][snippet_use_logs][][chat_message][date_received]	DateTime	*	Date message was received.
data.labels[][ticket][messages][][snippet_use_logs][][language]	object (Language)	*	Snippet translated.
data.labels[][ticket][messages][][snippet_use_logs][][person]	object (Person)	*
data.labels[][ticket][messages][][snippet_use_logs][][rating]	integer	*
data.labels[][ticket][messages][][snippet_use_logs][][rating_person]	object (Person)	*
data.labels[][ticket][messages][][snippet_use_logs][][rating_message]	string	*
data.labels[][ticket][messages][][snippet_use_logs][][date_created]	DateTime	*
data.labels[][ticket][messages][][date_created]	DateTime	*	Date when message was created.
data.labels[][ticket][messages][][is_agent_note]	boolean	*	Is this message agent note?
data.labels[][ticket][messages][][is_hidden]	boolean	*	Is this message hidden?
data.labels[][ticket][messages][][creation_system]	string	*	How this message was created.
data.labels[][ticket][messages][][ip_address]	string	*	An ip address from which message was sent.
data.labels[][ticket][messages][][visitor_id]	string	*	Unique ID of visitor left this message.
data.labels[][ticket][messages][][hostname]	string	*	Host from which message was left.
data.labels[][ticket][messages][][geo_country]	string	*	Country message is from (deprecated).
data.labels[][ticket][messages][][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.labels[][ticket][messages][][message_hash]	string	*	An unique hash of message.
data.labels[][ticket][messages][][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.labels[][ticket][messages][][primary_translation][id]	integer	*
data.labels[][ticket][messages][][primary_translation][ticket]	object (Ticket)	*
data.labels[][ticket][messages][][primary_translation][ticket_message]	object (TicketMessage)	*
data.labels[][ticket][messages][][primary_translation][from_lang_code]	string	*
data.labels[][ticket][messages][][primary_translation][lang_code]	string	*
data.labels[][ticket][messages][][primary_translation][message]	string	*
data.labels[][ticket][messages][][primary_translation][date_created]	DateTime	*
data.labels[][ticket][messages][][message]	string	*	The message, will be in HTML!
data.labels[][ticket][messages][][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.labels[][ticket][messages][][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.labels[][ticket][messages][][message_source]	string	*	The message source.
data.labels[][ticket][messages][][message_source_type]	string	*	The message source type.
data.labels[][ticket][messages][][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.labels[][ticket][messages][][lang_code]	string	*	The set/detected lang code.
data.labels[][ticket][messages][][email_message_id][]	array of objects (TicketMessageEmailId)	*
data.labels[][ticket][messages][][email_message_id][][id]	integer	*
data.labels[][ticket][messages][][email_message_id][][message]	object (TicketMessage)	*
data.labels[][ticket][messages][][email_message_id][][email_id]	string	*
data.labels[][ticket][messages][][ticket_feedback][]	array of objects (TicketFeedback)	*
data.labels[][ticket][messages][][ticket_feedback][][id]	integer	*
data.labels[][ticket][messages][][ticket_feedback][][ticket]	object (Ticket)	*
data.labels[][ticket][messages][][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data.labels[][ticket][messages][][ticket_feedback][][person]	object (Person)	*
data.labels[][ticket][messages][][ticket_feedback][][rating]	integer	*
data.labels[][ticket][messages][][ticket_feedback][][message]	string	*
data.labels[][ticket][messages][][ticket_feedback][][date_created]	DateTime	*
data.labels[][ticket][messages][][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data.labels[][ticket][messages][][ticket_message_forwards][][id]	integer	*
data.labels[][ticket][messages][][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data.labels[][ticket][messages][][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data.labels[][ticket][messages][][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data.labels[][ticket][messages][][ticket_message_forwards][][subject]	string	*
data.labels[][ticket][messages][][ticket_message_forwards][][from_email]	string	*
data.labels[][ticket][messages][][ticket_message_forwards][][tos]	array	*
data.labels[][ticket][messages][][ticket_message_forwards][][ccs]	array	*
data.labels[][ticket][messages][][ticket_message_forwards][][bccs]	array	*
data.labels[][ticket][messages][][ticket_message_forwards][][message]	string	*
data.labels[][ticket][messages][][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data.labels[][ticket][messages][][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data.labels[][ticket][messages][][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][ticket][messages][][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][ticket][messages][][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][ticket][messages][][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][ticket][messages][][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][ticket][messages][][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data.labels[][ticket][messages][][ticket_message_forwards][][blobs][][authcode]	string	*
data.labels[][ticket][messages][][ticket_message_forwards][][blobs][][blob_hash]	string	*
data.labels[][ticket][messages][][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][ticket][messages][][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][ticket][messages][][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][ticket][messages][][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][ticket][messages][][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data.labels[][ticket][messages][][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data.labels[][ticket][messages][][ticket_message_forwards][][blobs][][source_ref]	string	*
data.labels[][ticket][messages][][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data.labels[][ticket][messages][][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data.labels[][ticket][messages][][ticket_message_forwards][][date_created]	DateTime	*
data.labels[][ticket][messages][][channel_message]	object (TicketMessageChannelMessage)	*
data.labels[][ticket][messages][][channel_message][id]	integer	*	@var int The unique id of message.
data.labels[][ticket][messages][][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data.labels[][ticket][messages][][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data.labels[][ticket][messages][][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data.labels[][ticket][messages][][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data.labels[][ticket][messages][][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data.labels[][ticket][messages][][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data.labels[][ticket][messages][][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data.labels[][ticket][messages][][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data.labels[][ticket][messages][][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data.labels[][ticket][sms_messages][]	array of objects (TicketSms)	*
data.labels[][ticket][sms_messages][][id]	integer	*
data.labels[][ticket][sms_messages][][ticket]	object (Ticket)	*
data.labels[][ticket][sms_messages][][person]	object (Person)	*
data.labels[][ticket][sms_messages][][sms_account]	object (SmsAccount)	*
data.labels[][ticket][sms_messages][][sms_account][id]	integer	*	The unique ID.
data.labels[][ticket][sms_messages][][sms_account][type]	string	*
data.labels[][ticket][sms_messages][][sms_account][params]	array	*
data.labels[][ticket][sms_messages][][sms_account][identifier]	string	*
data.labels[][ticket][sms_messages][][sms_account][is_enabled]	boolean	*
data.labels[][ticket][sms_messages][][sms_account][is_connected]	boolean	*
data.labels[][ticket][sms_messages][][sms_account][is_tested]	boolean	*
data.labels[][ticket][sms_messages][][sms_account][test_code]	string	*
data.labels[][ticket][sms_messages][][job]	object (Job)	*
data.labels[][ticket][sms_messages][][job][id]	integer	*	The unique job id.
data.labels[][ticket][sms_messages][][job][type]	string	*	The job type, used by the Job Router to find the right Job Processor.
data.labels[][ticket][sms_messages][][job][status]	string	*	The status of the job.
data.labels[][ticket][sms_messages][][job][status_code]	string	*	Any code to further classify the status.
data.labels[][ticket][sms_messages][][job][date_touch]	DateTime	*	Date the last time a process "touched" this ticket.
data.labels[][ticket][sms_messages][][job][date_created]	DateTime	*	Date this job entered the "jobs" table.
data.labels[][ticket][sms_messages][][job][date_last_try]	DateTime	*	Last time we processed this job.
data.labels[][ticket][sms_messages][][job][date_next_try]	DateTime	*	If this DateTime is in the future, it won't be selected for execution.
data.labels[][ticket][sms_messages][][job][num_tries]	integer	*	The number of times this job has been executed Job Processor (usually indicated failures if > 1).
data.labels[][ticket][sms_messages][][job][log_summary]	string	*	A human readable summary of the job's execution.
data.labels[][ticket][sms_messages][][job][log]	string	*	A more verbose log.
data.labels[][ticket][sms_messages][][job][data]	array	*	An array of data, or payload, that the job processor needs to execute this job (stored in the db as json). This MUST always be an array, even if its an empty array
data.labels[][ticket][sms_messages][][job][original_job]	integer	*	Null unless the job was created as a retry - if so, the originating job ID is stored here so we can query it later. Note: You MUST specify the originating job, do not create a linked list of failed jobs.
data.labels[][ticket][sms_messages][][date_created]	DateTime	*
data.labels[][ticket][sms_messages][][from_number]	string	*	Permanent record of the phone number that sent this SMS. (Won't change even if Person changes their phone number).
data.labels[][ticket][sms_messages][][to_number]	string	*	Permanent record of the phone number that this SMS was sent to.
data.labels[][ticket][sms_messages][][message]	string	*	The SMS message.
data.labels[][ticket][sms_messages][][direction]	string	*	Just a system flag for reporting.
data.labels[][ticket][topic_links][]	array of objects (TicketCommunityTopicLink)	*
data.labels[][ticket][topic_links][][id]	integer	*	The unique filter ID.
data.labels[][ticket][topic_links][][ticket]	integer id (Ticket)	*
data.labels[][ticket][topic_links][][topic]	integer id (CommunityTopic)	*
data.labels[][ticket][topic_links][][person]	integer id (Person)	*
data.labels[][ticket][topic_links][][date_created]	DateTime	*
data.labels[][ticket][custom_data][]	array of objects (CustomDataTicket)	*
data.labels[][ticket][custom_data][][ticket]	object (Ticket)	*
data.labels[][ticket][custom_data][][field]	object (CustomDefTicket)	*
data.labels[][ticket][custom_data][][field][parent]	object (CustomDefTicket)	*
data.labels[][ticket][custom_data][][field][children][]	array of objects (CustomDefTicket)	*	Field children.
data.labels[][ticket][custom_data][][root_field]	object (CustomDefTicket)	*
data.labels[][ticket][labels][]	array of objects (LabelTicket)	*
data.labels[][ticket][sent_to_address]	string	*	The email address the ticket was sent to if it came in via a gateway. This is a full string (e.g., including CC's) of the original.
data.labels[][ticket][email_account]	object (EmailAccount)	*	The gateway this ticket originated from.
data.labels[][ticket][email_account][id]	integer	*
data.labels[][ticket][email_account][account_type]	string	*
data.labels[][ticket][email_account][is_enabled]	boolean	*
data.labels[][ticket][email_account][address]	string	*
data.labels[][ticket][email_account][cert_blob]	object (Blob)	*
data.labels[][ticket][email_account][cert_blob][sys_name]	string	*	A unique system name for the blob.
data.labels[][ticket][email_account][cert_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.labels[][ticket][email_account][cert_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.labels[][ticket][email_account][cert_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.labels[][ticket][email_account][cert_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.labels[][ticket][email_account][cert_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.labels[][ticket][email_account][cert_blob][file_url]	string	*	The HTTP link to download the file.
data.labels[][ticket][email_account][cert_blob][authcode]	string	*
data.labels[][ticket][email_account][cert_blob][blob_hash]	string	*
data.labels[][ticket][email_account][cert_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.labels[][ticket][email_account][cert_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.labels[][ticket][email_account][cert_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.labels[][ticket][email_account][cert_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.labels[][ticket][email_account][cert_blob][date_created]	DateTime	*
data.labels[][ticket][email_account][cert_blob][is_temp]	boolean	*
data.labels[][ticket][email_account][cert_blob][source_ref]	string	*
data.labels[][ticket][email_account][cert_blob][labels][]	array of objects (LabelBlob)	*
data.labels[][ticket][email_account][cert_blob][labels][][blob]	object (Blob)	*
data.labels[][ticket][email_account][key_blob]	object (Blob)	*
data.labels[][ticket][email_account_address]	string	*	The email address (from list of to/cc) that matched with the email account.
data.labels[][ticket][creation_system]	string	*
data.labels[][ticket][creation_system_option]	string	*	Optional information about the creation system. For example, source URL the ticket came from.
data.labels[][ticket][ticket_hash]	string	*
data.labels[][ticket][status]	string	*
data.labels[][ticket][ticket_status]	object (TicketStatus)	*
data.labels[][ticket][ticket_status][id]	integer	*
data.labels[][ticket][ticket_status][status_type]	string	*
data.labels[][ticket][ticket_status][status_code]	string	*
data.labels[][ticket][ticket_status][sys_id]	string	*
data.labels[][ticket][ticket_status][title]	string	*
data.labels[][ticket][ticket_status][display_order]	integer	*
data.labels[][ticket][ticket_status][pending_waiting_time_mode]	string	*	Where to count time spending in pending status. Check PENDING_WAITING_TIME_MODE_ constants
data.labels[][ticket][ticket_status][children][]	array of objects (TicketStatus)	*
data.labels[][ticket][ticket_status][options]	array	*
data.labels[][ticket][urgency]	integer	*
data.labels[][ticket][feedback_rating]	integer	*
data.labels[][ticket][date_feedback_rating]	DateTime	*
data.labels[][ticket][date_created]	DateTime	*
data.labels[][ticket][date_resolved]	DateTime	*
data.labels[][ticket][date_archived]	DateTime	*
data.labels[][ticket][date_first_agent_assign]	DateTime	*
data.labels[][ticket][date_first_agent_reply]	DateTime	*
data.labels[][ticket][date_last_agent_reply]	DateTime	*
data.labels[][ticket][date_last_user_reply]	DateTime	*
data.labels[][ticket][date_agent_waiting]	DateTime	*
data.labels[][ticket][date_user_waiting]	DateTime	*
data.labels[][ticket][date_status]	DateTime	*
data.labels[][ticket][date_on_hold]	DateTime	*
data.labels[][ticket][total_user_waiting]	integer	*
data.labels[][ticket][total_to_first_reply]	integer	*
data.labels[][ticket][total_user_waiting_wh_start]	DateTime	*
data.labels[][ticket][total_user_waiting_wh]	integer	*
data.labels[][ticket][total_to_first_reply_wh]	integer	*
data.labels[][ticket][locked_by_agent]	object (Person)	*
data.labels[][ticket][date_locked]	DateTime	*
data.labels[][ticket][has_attachments]	boolean	*
data.labels[][ticket][subject]	string	*
data.labels[][ticket][original_subject]	string	*
data.labels[][ticket][properties]	array	*
data.labels[][ticket][count_agent_replies]	integer	*
data.labels[][ticket][count_user_replies]	integer	*
data.labels[][ticket][worst_sla_status]	string	*
data.labels[][ticket][waiting_times]	array	*	Used to track ticket status changes and how much time ticket was in status Add new item every time status changed This is optimisation over TicketLog.
data.labels[][ticket][participants][]	array of objects (TicketParticipant)	*
data.labels[][ticket][participants][][id]	integer	*
data.labels[][ticket][participants][][ticket]	object (Ticket)	*
data.labels[][ticket][participants][][person]	object (Person)	*
data.labels[][ticket][participants][][access_code]	object (TicketAccessCode)	*
data.labels[][ticket][participants][][person_email]	object (PersonEmail)	*
data.labels[][ticket][participants][][default_on]	boolean	*	Default checkbox status of the user.
data.labels[][ticket][charges][]	array of objects (TicketCharge)	*
data.labels[][ticket][charges][][id]	integer	*
data.labels[][ticket][charges][][charge_time]	integer	*
data.labels[][ticket][charges][][amount]	float	*
data.labels[][ticket][charges][][date_created]	DateTime	*
data.labels[][ticket][charges][][ticket]	object (Ticket)	*
data.labels[][ticket][charges][][person]	object (Person)	*
data.labels[][ticket][charges][][organization]	object (Organization)	*
data.labels[][ticket][charges][][agent]	object (Person)	*
data.labels[][ticket][charges][][custom_data][]	array of objects (CustomDataBilling)	*
data.labels[][ticket][charges][][custom_data][][ticket_charge]	object (TicketCharge)	*
data.labels[][ticket][charges][][custom_data][][field]	object (CustomDefBilling)	*
data.labels[][ticket][charges][][custom_data][][field][parent]	object (CustomDefBilling)	*
data.labels[][ticket][charges][][custom_data][][field][children][]	array of objects (CustomDefBilling)	*	Field children.
data.labels[][ticket][charges][][custom_data][][root_field]	object (CustomDefBilling)	*
data.labels[][ticket][ticket_slas][]	array of objects (TicketSla)	*
data.labels[][ticket][ticket_slas][][id]	integer	*	The unique ID.
data.labels[][ticket][ticket_slas][][sla_status]	string	*	The SLA status.
data.labels[][ticket][ticket_slas][][warn_date]	DateTime	*	The SLA warn date.
data.labels[][ticket][ticket_slas][][fail_date]	DateTime	*	The SLA fail date.
data.labels[][ticket][ticket_slas][][is_completed]	boolean	*	Is the SLA completed?
data.labels[][ticket][ticket_slas][][is_completed_set]	boolean	*	Completed by automated action.
data.labels[][ticket][ticket_slas][][completed_time_taken]	integer	*	Time taken.
data.labels[][ticket][ticket_slas][][ticket]	integer id (Ticket)	*	Ticket.
data.labels[][ticket][ticket_slas][][sla]	integer id (Sla)	*	SLA.
data.labels[][ticket][ticket_slas][][date_applied]	DateTime	*	time and date when SLA was applied to the ticket.
data.labels[][ticket][ticket_slas][][date_completed]	DateTime	*	time when SLA status became OK.
data.labels[][ticket][jira_issues][]	array of objects (JiraIssue)	*	linked jira issues.
data.labels[][ticket][jira_issues][][id]	integer	*	The unique ID.
data.labels[][ticket][jira_issues][][ticket]	object (Ticket)	*	The associated DeskPRO ticket.
data.labels[][ticket][jira_issues][][issue_id]	integer	*
data.labels[][ticket][jira_issues][][status_id]	integer	*
data.labels[][ticket][jira_issues][][created]	DateTime	*	Export time.
data.labels[][ticket][problems][]	array of objects (Problem)	*
data.labels[][ticket][problems][][id]	integer	*	The unique ID.
data.labels[][ticket][problems][][title]	string	*	Problem title.
data.labels[][ticket][problems][][creator]	integer id (Person)	*	Person who created the problem.
data.labels[][ticket][problems][][created]	DateTime	*	Date when the problem was created.
data.labels[][ticket][problems][][is_open]	boolean	*	Is problem still has no solution?
data.labels[][ticket][problems][][tickets][]	array of integer ids (Ticket)	*	Tickets associated with problem.
data.labels[][ticket][stars][]	array of objects (TicketFlagged)	*
data.labels[][ticket][stars][][ticket]	object (Ticket)	*
data.labels[][ticket][stars][][person_id]	integer	*
data.labels[][ticket][stars][][color]	string	*
data.labels[][ticket][follow_ups][]	array of objects (TicketFollowUp)	*
data.labels[][ticket][follow_ups][][id]	integer	*	The unique ID.
data.labels[][ticket][follow_ups][][person]	integer id (Person)	*
data.labels[][ticket][follow_ups][][actions]	array	*
data.labels[][ticket][follow_ups][][cancel_if_user_reply]	boolean	*
data.labels[][ticket][follow_ups][][cancel_if_agent_reply]	boolean	*
data.labels[][ticket][follow_ups][][status]	string	*
data.labels[][ticket][follow_ups][][date_created]	DateTime	*
data.labels[][ticket][follow_ups][][date_to_run]	DateTime	*
data.labels[][ticket][follow_ups][][date_did_run]	DateTime	*
data.labels[][ticket][logs][]	array of objects (TicketLog)	*
data.labels[][ticket][logs][][id]	integer	*
data.labels[][ticket][logs][][parent]	object (TicketLog)	*
data.labels[][ticket][logs][][ticket]	object (Ticket)	*
data.labels[][ticket][logs][][person]	object (Person)	*
data.labels[][ticket][logs][][action_type]	string	*
data.labels[][ticket][logs][][id_object]	integer	*	If the log involves a specific thing in a ticket (eg a message that was moved), then that is this id.
data.labels[][ticket][logs][][id_before]	integer	*	The ID of the previous entity changed, or any other numeric value.
data.labels[][ticket][logs][][id_after]	integer	*	The ID of the new entity, or any other numeric value.
data.labels[][ticket][logs][][trigger_id]	integer	*	If the change was caused by a trigger, the trigger id. Note this is the integer ID (not a FK relation) so the record is kept even if the trigger itself is deleted.
data.labels[][ticket][logs][][escalation_id]	integer	*	If the change was caused by an escalation Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.labels[][ticket][logs][][macro_id]	integer	*	If the change was caused by an v2 macro Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.labels[][ticket][logs][][sla]	object (Sla)	*	If the change was caused by an SLA, the SLA.
data.labels[][ticket][logs][][sla][id]	integer	*	The unique ID.
data.labels[][ticket][logs][][sla][title]	string	*	SLA title.
data.labels[][ticket][logs][][sla][sla_type]	string	*	Type of SLA - first_response, resolution, waiting_time.
data.labels[][ticket][logs][][sla][active_time]	string	*	Whether active all the time (all) or during work hours only (work_hours) or use the default ticket-wide settings (default).
data.labels[][ticket][logs][][sla][work_start]	integer	*	When the work day starts. This is stored as the number of seconds after 00:00:00.
data.labels[][ticket][logs][][sla][work_end]	integer	*	When the work day ends. This is stored as the number of seconds after 00:00:00.
data.labels[][ticket][logs][][sla][work_days]	array	*	Array of work days, stored with keys corresponding to day numbers. Values are true. 0 = Sunday, 6 = Saturday (same as PHP, easy to convert to MySQL which is 1 = Sunday, 7 = Saturday).
data.labels[][ticket][logs][][sla][work_timezone]	string	*	Timezone for work hours/days to be considered in.
data.labels[][ticket][logs][][sla][work_holidays]	array	*	List of work holidays.
data.labels[][ticket][logs][][sla][apply_type]	string	*	Controls how the SLA is applied to tickets: all, terms, terms_before_triggers, manual.
data.labels[][ticket][logs][][sla][apply_terms]	object (TriggerTerms)	*	Conditions to apply.
data.labels[][ticket][logs][][sla][apply_terms][version]	integer	*	Terms version.
data.labels[][ticket][logs][][sla][apply_terms][terms]	array	*	Terms themselves.
data.labels[][ticket][logs][][sla][trigger_terms]	object (TriggerTerms)	*	Conditions to consider sla completed.
data.labels[][ticket][logs][][sla][warn_time]	integer	*	Warn time integer.
data.labels[][ticket][logs][][sla][warn_time_unit]	string	*	And it's unit (see warn time).
data.labels[][ticket][logs][][sla][warn_actions]	object (TriggerActions)	*	How to warn about SLA will fail.
data.labels[][ticket][logs][][sla][warn_actions][version]	integer	*	Actions version.
data.labels[][ticket][logs][][sla][warn_actions][actions]	array	*	Actions array representation.
data.labels[][ticket][logs][][sla][fail_time]	integer	*	Fail time integer.
data.labels[][ticket][logs][][sla][fail_time_unit]	string	*	And it's measuring unit (see fail_time).
data.labels[][ticket][logs][][sla][fail_actions]	object (TriggerActions)	*	What to do if SLA failed.
data.labels[][ticket][logs][][sla][exclude_ticket_statuses]	array	*	This SLA will not apply while tickets are in these pending statuses.
data.labels[][ticket][logs][][sla_status]	string	*
data.labels[][ticket][logs][][details]	array	*
data.labels[][ticket][logs][][date_created]	DateTime	*
data.labels[][ticket][chats][]	array of objects (ChatConversation)	*
data.labels[][ticket][created_with_channel]	string	*
data.labels[][ticket][last_channel_used]	string	*
data.labels[][ticket][channels]	array	*
data.labels[][ticket][pending_articles][]	array of objects (ArticlePendingCreate)	*
data.labels[][ticket][pending_articles][][id]	integer	*
data.labels[][ticket][pending_articles][][person]	integer id (Person)	*
data.labels[][ticket][pending_articles][][assigned_person]	integer id (Person)	*
data.labels[][ticket][pending_articles][][ticket]	integer id (Ticket)	*
data.labels[][ticket][pending_articles][][message]	integer id (TicketMessage)	*
data.labels[][ticket][pending_articles][][comment]	string	*
data.labels[][ticket][pending_articles][][date_created]	DateTime	*
data.labels[][ticket][summary]	object (TicketSummary)	*
data.labels[][ticket][summary][id]	integer	*
data.labels[][ticket][summary][ticket]	object (Ticket)	*
data.labels[][ticket][summary][summary]	string	*
data.labels[][ticket][summary][summary_input]	string	*
data.labels[][ticket][summary][date_created]	DateTime	*
data.labels[][label]		*
data.subject	string	*
data.id	integer	*
data.ref	string	*
data.auth	string	*
data.parent_ticket	object (Ticket)	*	Parent ticket.
data.parent_ticket[id]	integer	*
data.parent_ticket[ref]	string	*
data.parent_ticket[auth]	string	*
data.parent_ticket[parent_ticket]	object (Ticket)	*	Parent ticket.
data.parent_ticket[children_tickets][]	array of objects (Ticket)	*
data.parent_ticket[language]	object (Language)	*	The language the ticket is in.
data.parent_ticket[language][id]	integer	*	The unique ID.
data.parent_ticket[language][sys_name]	string	*	The unique sys name assigned to the language.
data.parent_ticket[language][title]	string	*	Title of the language.
data.parent_ticket[language][title_local]	string	*	Title of the language.
data.parent_ticket[language][base_filepath]	string	*	The base filepath for default phrases for this lang.
data.parent_ticket[language][locale]	string	*	The locale code.
data.parent_ticket[language][flag_image]	string	*	String path to image.
data.parent_ticket[language][is_rtl]	boolean	*	True if this is a right-to-left language.
data.parent_ticket[language][has_user]	boolean	*	True if has user.
data.parent_ticket[language][has_agent]	boolean	*	True if has agent.
data.parent_ticket[language][has_admin]	boolean	*	True if has admin.
data.parent_ticket[language][plural_categories][]	array of strings	*
data.parent_ticket[language][plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data.parent_ticket[language][flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`
data.parent_ticket[brand]	object (Brand)	*
data.parent_ticket[brand][id]	integer	*	The unique ID.
data.parent_ticket[brand][name]	string	*	The brand name.
data.parent_ticket[brand][slug]	string	*
data.parent_ticket[brand][url]	string	*	The brand url.
data.parent_ticket[brand][theme_set]	object (ThemeSet)	*
data.parent_ticket[brand][theme_set][id]	integer	*
data.parent_ticket[brand][theme_set][theme_id]	string	*
data.parent_ticket[brand][theme_set][title]	string	*
data.parent_ticket[brand][theme_set][options]		*
data.parent_ticket[brand][edit_theme_set]	object (ThemeSet)	*
data.parent_ticket[brand][departments][]	array of objects (Department)	*
data.parent_ticket[brand][departments][][id]	integer	*
data.parent_ticket[brand][departments][][parent]	object (Department)	*
data.parent_ticket[brand][departments][][children][]	array of objects (Department)	*
data.parent_ticket[brand][departments][][title]	string	*
data.parent_ticket[brand][departments][][user_title]	string	*
data.parent_ticket[brand][departments][][is_tickets_enabled]	boolean	*
data.parent_ticket[brand][departments][][is_chat_enabled]	boolean	*
data.parent_ticket[brand][departments][][display_order]	integer	*
data.parent_ticket[brand][departments][][avatar]	object (Blob)	*
data.parent_ticket[brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.parent_ticket[brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.parent_ticket[brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.parent_ticket[brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.parent_ticket[brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.parent_ticket[brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.parent_ticket[brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.parent_ticket[brand][departments][][avatar][authcode]	string	*
data.parent_ticket[brand][departments][][avatar][blob_hash]	string	*
data.parent_ticket[brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.parent_ticket[brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.parent_ticket[brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.parent_ticket[brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.parent_ticket[brand][departments][][avatar][date_created]	DateTime	*
data.parent_ticket[brand][departments][][avatar][is_temp]	boolean	*
data.parent_ticket[brand][departments][][avatar][source_ref]	string	*
data.parent_ticket[brand][departments][][avatar][labels]	array of objects (LabelBlob)	*
data.parent_ticket[brand][departments][][avatar][labels][blob]	object (Blob)	*
data.parent_ticket[brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.parent_ticket[brand][departments][][brands][]	array of objects (Brand)	*
data.parent_ticket[brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.parent_ticket[brand][departments][][permissions][][department]	integer id (Department)	*
data.parent_ticket[brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.parent_ticket[brand][departments][][permissions][][name]	string	*	The name of the permission.
data.parent_ticket[brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.parent_ticket[brand][departments][][permissions][][is_active]	boolean	*
data.parent_ticket[brand][departments][][chat_queue]	object (UserChatQueue)	*
data.parent_ticket[brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.parent_ticket[brand][departments][][chat_queue][name]	string	*
data.parent_ticket[brand][departments][][chat_queue][routing_model]	string	*
data.parent_ticket[brand][departments][][chat_queue][answer_timeout]	integer	*
data.parent_ticket[brand][departments][][chat_queue][is_all_agents]	boolean	*
data.parent_ticket[brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.parent_ticket[brand][departments][][chat_queue][max_queue_size]	integer	*
data.parent_ticket[brand][departments][][chat_queue][routingModel]		*
data.parent_ticket[brand][theme_sets][]	array of objects (ThemeSet)	*
data.parent_ticket[department]	object (Department)	*
data.parent_ticket[department][id]	integer	*
data.parent_ticket[department][parent]	object (Department)	*
data.parent_ticket[department][children][]	array of objects (Department)	*
data.parent_ticket[department][title]	string	*
data.parent_ticket[department][user_title]	string	*
data.parent_ticket[department][is_tickets_enabled]	boolean	*
data.parent_ticket[department][is_chat_enabled]	boolean	*
data.parent_ticket[department][display_order]	integer	*
data.parent_ticket[department][avatar]	object (Blob)	*
data.parent_ticket[department][avatar][sys_name]	string	*	A unique system name for the blob.
data.parent_ticket[department][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.parent_ticket[department][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.parent_ticket[department][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.parent_ticket[department][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.parent_ticket[department][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.parent_ticket[department][avatar][file_url]	string	*	The HTTP link to download the file.
data.parent_ticket[department][avatar][authcode]	string	*
data.parent_ticket[department][avatar][blob_hash]	string	*
data.parent_ticket[department][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.parent_ticket[department][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.parent_ticket[department][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.parent_ticket[department][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.parent_ticket[department][avatar][date_created]	DateTime	*
data.parent_ticket[department][avatar][is_temp]	boolean	*
data.parent_ticket[department][avatar][source_ref]	string	*
data.parent_ticket[department][avatar][labels][]	array of objects (LabelBlob)	*
data.parent_ticket[department][avatar][labels][][blob]	object (Blob)	*
data.parent_ticket[department][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.parent_ticket[department][brands][]	array of objects (Brand)	*
data.parent_ticket[department][permissions][]	array of objects (DepartmentPermission)	*
data.parent_ticket[department][permissions][][department]	integer id (Department)	*
data.parent_ticket[department][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.parent_ticket[department][permissions][][name]	string	*	The name of the permission.
data.parent_ticket[department][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.parent_ticket[department][permissions][][is_active]	boolean	*
data.parent_ticket[department][chat_queue]	object (UserChatQueue)	*
data.parent_ticket[department][chat_queue][id]	integer	*	The unique ID.
data.parent_ticket[department][chat_queue][name]	string	*
data.parent_ticket[department][chat_queue][routing_model]	string	*
data.parent_ticket[department][chat_queue][answer_timeout]	integer	*
data.parent_ticket[department][chat_queue][is_all_agents]	boolean	*
data.parent_ticket[department][chat_queue][departments][]	array of objects (Department)	*
data.parent_ticket[department][chat_queue][max_queue_size]	integer	*
data.parent_ticket[category]	object (TicketCategory)	*
data.parent_ticket[category][id]	integer	*	The unique ID.
data.parent_ticket[category][parent]	integer id (TicketCategory)	*	This category parent.
data.parent_ticket[category][title]	string	*	Category title.
data.parent_ticket[category][display_order]	integer	*	Obviously it's display order for lists.
data.parent_ticket[priority]	object (TicketPriority)	*
data.parent_ticket[priority][id]	integer	*	The unique ID.
data.parent_ticket[priority][title]	string	*	Priority title.
data.parent_ticket[priority][priority]	integer	*	The priority itself.
data.parent_ticket[workflow]	object (TicketWorkflow)	*
data.parent_ticket[workflow][id]	integer	*	The unique ID.
data.parent_ticket[workflow][title]	string	*	Workflow title.
data.parent_ticket[workflow][display_order]	integer	*	Workflow display order.
data.parent_ticket[product]	object (Product)	*
data.parent_ticket[product][parent]	integer id (Product)	*	Parent of the product.
data.parent_ticket[product][title]		*
data.parent_ticket[person]	object (Person)	*
data.parent_ticket[person_email]	object (PersonEmail)	*
data.parent_ticket[person_email][id]	integer	*	The unique ID.
data.parent_ticket[person_email][person]	integer id (Person)	*	Person owner of email.
data.parent_ticket[person_email][email]	string	*	The email address.
data.parent_ticket[person_email][email_domain]	string	*	The email address domain.
data.parent_ticket[person_email][is_validated]	boolean	*	True if validation passed.
data.parent_ticket[person_email][date_created]	DateTime	*	The original time the email was created.
data.parent_ticket[agent]	object (Person)	*
data.parent_ticket[agent_team]	object (AgentTeam)	*
data.parent_ticket[agent_team][id]	integer	*	The unique ID.
data.parent_ticket[agent_team][name]	string	*	The name of agent team.
data.parent_ticket[agent_team][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.parent_ticket[agent_team][members]		*
data.parent_ticket[organization]	object (Organization)	*
data.parent_ticket[organization][id]	integer	*	The unique ID.
data.parent_ticket[organization][picture_blob]	object (Blob)	*	The org picture.
data.parent_ticket[organization][picture_blob][sys_name]	string	*	A unique system name for the blob.
data.parent_ticket[organization][picture_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.parent_ticket[organization][picture_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.parent_ticket[organization][picture_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.parent_ticket[organization][picture_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.parent_ticket[organization][picture_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.parent_ticket[organization][picture_blob][file_url]	string	*	The HTTP link to download the file.
data.parent_ticket[organization][picture_blob][authcode]	string	*
data.parent_ticket[organization][picture_blob][blob_hash]	string	*
data.parent_ticket[organization][picture_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.parent_ticket[organization][picture_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.parent_ticket[organization][picture_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.parent_ticket[organization][picture_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.parent_ticket[organization][picture_blob][date_created]	DateTime	*
data.parent_ticket[organization][picture_blob][is_temp]	boolean	*
data.parent_ticket[organization][picture_blob][source_ref]	string	*
data.parent_ticket[organization][picture_blob][labels][]	array of objects (LabelBlob)	*
data.parent_ticket[organization][picture_blob][labels][][blob]	object (Blob)	*
data.parent_ticket[organization][icon_property]	object (IconProperty)	*
data.parent_ticket[organization][icon_property][urn]	string	*
data.parent_ticket[organization][icon_property][options]	array	*
data.parent_ticket[organization][name]	string	*	The organization name.
data.parent_ticket[organization][summary]	string	*	The summary field as filled in by agents.
data.parent_ticket[organization][importance]	integer	*	The org importance.
data.parent_ticket[organization][custom_data][]	array of objects (CustomDataOrganization)	*
data.parent_ticket[organization][custom_data][][organization]	object (Organization)	*
data.parent_ticket[organization][custom_data][][field]	object (CustomDefOrganization)	*
data.parent_ticket[organization][custom_data][][field][parent]	object (CustomDefOrganization)	*	Field`s parent.
data.parent_ticket[organization][custom_data][][field][children][]	array of objects (CustomDefOrganization)	*	Field children.
data.parent_ticket[organization][custom_data][][field][title]		*
data.parent_ticket[organization][custom_data][][root_field]	object (CustomDefOrganization)	*
data.parent_ticket[organization][usergroups][]	array of objects (Usergroup)	*	Usergroups the user belongs to.
data.parent_ticket[organization][usergroups][][id]	integer	*	The unique ID, DB-generated.
data.parent_ticket[organization][usergroups][][title]	string	*	Title of the usergroup.
data.parent_ticket[organization][usergroups][][note]	string	*	A note or description about the usergroup.
data.parent_ticket[organization][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.parent_ticket[organization][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.parent_ticket[organization][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.parent_ticket[organization][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.parent_ticket[organization][usergroups][][permissions][][id]	integer	*	The unique ID.
data.parent_ticket[organization][usergroups][][permissions][][name]	string	*	The name of the permission.
data.parent_ticket[organization][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.parent_ticket[organization][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.parent_ticket[organization][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.parent_ticket[organization][usergroups][][department_permissions][][department]	integer id (Department)	*
data.parent_ticket[organization][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.parent_ticket[organization][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.parent_ticket[organization][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.parent_ticket[organization][usergroups][][department_permissions][][is_active]	boolean	*
data.parent_ticket[organization][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.parent_ticket[organization][auto_cc_people][]	array of objects (Person)	*	Users who are set to automatically be added to tickets and other org things.
data.parent_ticket[organization][labels][]	array of objects (LabelOrganization)	*
data.parent_ticket[organization][labels][][organization]	object (Organization)	*
data.parent_ticket[organization][contact_data][]	array of objects (OrganizationContactData)	*
data.parent_ticket[organization][contact_data][][organization]		*
data.parent_ticket[organization][contact_data][][contact_type]		*
data.parent_ticket[organization][contact_data][][comment]		*
data.parent_ticket[organization][contact_data][][field_1]		*
data.parent_ticket[organization][contact_data][][field_2]		*
data.parent_ticket[organization][contact_data][][field_3]		*
data.parent_ticket[organization][contact_data][][field_5]		*
data.parent_ticket[organization][contact_data][][field_9]		*
data.parent_ticket[organization][emails][]	array of objects (OrganizationEmail)	*
data.parent_ticket[organization][emails][][id]	integer	*	The unique log id.
data.parent_ticket[organization][emails][][organization]	object (Organization)	*
data.parent_ticket[organization][emails][][email]	string	*
data.parent_ticket[organization][emails][][date_created]	DateTime	*
data.parent_ticket[organization][email_domains][]	array of objects (OrganizationEmailDomain)	*
data.parent_ticket[organization][email_domains][][domain]	string	*	The email domain.
data.parent_ticket[organization][email_domains][][organization]	object (Organization)	*	The users organization.
data.parent_ticket[organization][date_created]	DateTime	*	The date the org was inserted into the system.
data.parent_ticket[organization][members][]	array of objects (Person)	*
data.parent_ticket[organization][parent]	object (Organization)	*
data.parent_ticket[organization][children][]	array of objects (Organization)	*
data.parent_ticket[organization][tickets][]	array of objects (Ticket)	*
data.parent_ticket[organization][organization_members][]	array of objects (OrganizationMember)	*
data.parent_ticket[organization][organization_members][][id]	integer	*
data.parent_ticket[organization][organization_members][][person]	integer id (Person)	*
data.parent_ticket[organization][organization_members][][organization]	integer id (Organization)	*
data.parent_ticket[organization][organization_members][][is_manager]	boolean	*
data.parent_ticket[organization][organization_members][][position]	string	*
data.parent_ticket[organization][organization_members][][created_at]	DateTime	*
data.parent_ticket[organization][organization_members][][updated_at]	DateTime	*
data.parent_ticket[organization][publicUsergroups]		*
data.parent_ticket[linked_chat]	object (ChatConversation)	*
data.parent_ticket[linked_chat][id]	integer	*	The unique id of chat conversation.
data.parent_ticket[linked_chat][department]	object (Department)	*	Department which chat was assigned.
data.parent_ticket[linked_chat][brand]	object (Brand)	*	Department which chat was assigned.
data.parent_ticket[linked_chat][task_id]	integer	*
data.parent_ticket[linked_chat][ticket]	object (Ticket)	*
data.parent_ticket[linked_chat][labels][]	array of objects (LabelChatConversation)	*
data.parent_ticket[linked_chat][labels][][chat]	object (ChatConversation)	*
data.parent_ticket[linked_chat][subject]	string	*	Subject of the chat conversation.
data.parent_ticket[linked_chat][status]	string	*	Status of the chat conversation.
data.parent_ticket[linked_chat][agent]	object (Person)	*	If this is a user conversation, this is the agent assigned.
data.parent_ticket[linked_chat][agent_team]	object (AgentTeam)	*	If this is a team chat, the team it is.
data.parent_ticket[linked_chat][person]	object (Person)	*	If this is a user conversation, this is the user who started the chat.
data.parent_ticket[linked_chat][session]	object (Session)	*	If this is a user convo, this is the users session.
data.parent_ticket[linked_chat][session][id]	integer	*	The unique ID.
data.parent_ticket[linked_chat][session][auth]	string	*	The authcode for the session to verify an id.
data.parent_ticket[linked_chat][session][interface]	string	*	The Interface the session is for.
data.parent_ticket[linked_chat][session][person]	object (Person)	*
data.parent_ticket[linked_chat][session][user_agent]	string	*	The users user agent string.
data.parent_ticket[linked_chat][session][visitor_id]	string	*
data.parent_ticket[linked_chat][session][ip_address]	string	*	The users IP address.
data.parent_ticket[linked_chat][session][data]	string	*
data.parent_ticket[linked_chat][session][is_person]	boolean	*
data.parent_ticket[linked_chat][session][is_bot]	boolean	*
data.parent_ticket[linked_chat][session][is_helpdesk]	boolean	*
data.parent_ticket[linked_chat][session][active_status]	string	*	(Agents) Status (available or away).
data.parent_ticket[linked_chat][session][is_chat_available]	boolean	*	(Agents) Wehn status is available, if they are available for chat.
data.parent_ticket[linked_chat][session][date_created]	DateTime	*
data.parent_ticket[linked_chat][session][date_last]	DateTime	*
data.parent_ticket[linked_chat][session][date_last_page]	DateTime	*
data.parent_ticket[linked_chat][visitor_id]	string	*
data.parent_ticket[linked_chat][person_name]	string	*	User chat: The users name, if they arent a person.
data.parent_ticket[linked_chat][person_email]	string	*	User chat: The users email, if they aren`t a person.
data.parent_ticket[linked_chat][participants][]	array of objects (Person)	*
data.parent_ticket[linked_chat][messages][]	array of objects (ChatMessage)	*
data.parent_ticket[linked_chat][messages][][id]	integer	*	The unique ID.
data.parent_ticket[linked_chat][messages][][author_id]	integer	*	Author id (legacy).
data.parent_ticket[linked_chat][messages][][author_type]	string	*	Author type (legacy).
data.parent_ticket[linked_chat][messages][][conversation_id]	integer	*	Conversation id (legacy).
data.parent_ticket[linked_chat][messages][][author]	integer id (Person)	*	Person who created the message.
data.parent_ticket[linked_chat][messages][][content]	string	*	The message.
data.parent_ticket[linked_chat][messages][][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.parent_ticket[linked_chat][messages][][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.parent_ticket[linked_chat][messages][][is_html]	boolean	*	Is the content an HTML message?
data.parent_ticket[linked_chat][messages][][metadata]	array	*	Additional data.
data.parent_ticket[linked_chat][messages][][date_created]	DateTime	*	Date message was created.
data.parent_ticket[linked_chat][messages][][date_received]	DateTime	*	Date message was received.
data.parent_ticket[linked_chat][custom_data][]	array of objects (CustomDataChat)	*
data.parent_ticket[linked_chat][custom_data][][conversation]	object (ChatConversation)	*	The conversation the message belongs to.
data.parent_ticket[linked_chat][custom_data][][field]	object (CustomDefChat)	*
data.parent_ticket[linked_chat][custom_data][][field][parent]	object (CustomDefChat)	*
data.parent_ticket[linked_chat][custom_data][][field][children][]	array of objects (CustomDefChat)	*	Field children.
data.parent_ticket[linked_chat][custom_data][][field][title]		*
data.parent_ticket[linked_chat][custom_data][][root_field]	object (CustomDefChat)	*
data.parent_ticket[linked_chat][rating_response_time]	integer	*
data.parent_ticket[linked_chat][rating_overall]	integer	*
data.parent_ticket[linked_chat][rating_comment]	string	*
data.parent_ticket[linked_chat][is_agent]	boolean	*	Is this an agent chat.
data.parent_ticket[linked_chat][is_window]	boolean	*	If the chat is popped out into a window. This is used to make sure the JS widget on pages doesn't load again.
data.parent_ticket[linked_chat][date_created]	DateTime	*	Date when chat was started.
data.parent_ticket[linked_chat][date_user_waiting]	DateTime	*	Since when the user has started waiting (i.e., time the assignment was 0).
data.parent_ticket[linked_chat][date_assigned]	DateTime	*
data.parent_ticket[linked_chat][date_agent_typing]	DateTime	*	Date when agent typed last time.
data.parent_ticket[linked_chat][date_first_agent_message]	DateTime	*
data.parent_ticket[linked_chat][date_ended]	DateTime	*	Date when chat was ended.
data.parent_ticket[linked_chat][total_to_ended]	integer	*
data.parent_ticket[linked_chat][ended_by]	string	*	Who ended the chat.
data.parent_ticket[linked_chat][should_send_transcript]	boolean	*	True if transcript should be send.
data.parent_ticket[linked_chat][date_transcript_sent]	DateTime	*	Date when transcript was sent.
data.parent_ticket[linked_chat][email_validation_code]	string	*
data.parent_ticket[linked_chat][email_validated]	boolean	*
data.parent_ticket[linked_chat][access_token]	string	*
data.parent_ticket[attachments][]	array of objects (TicketAttachment)	*
data.parent_ticket[attachments][][id]	integer	*	The unique ID.
data.parent_ticket[attachments][][ticket]	integer id (Ticket)	*	Ticket this attachment belongs to.
data.parent_ticket[attachments][][person]	integer id (Person)	*	Who created the attachment.
data.parent_ticket[attachments][][blob]	object (Blob)	*	Actual attachment.
data.parent_ticket[attachments][][blob][sys_name]	string	*	A unique system name for the blob.
data.parent_ticket[attachments][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.parent_ticket[attachments][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.parent_ticket[attachments][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.parent_ticket[attachments][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.parent_ticket[attachments][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.parent_ticket[attachments][][blob][file_url]	string	*	The HTTP link to download the file.
data.parent_ticket[attachments][][blob][authcode]	string	*
data.parent_ticket[attachments][][blob][blob_hash]	string	*
data.parent_ticket[attachments][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.parent_ticket[attachments][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.parent_ticket[attachments][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.parent_ticket[attachments][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.parent_ticket[attachments][][blob][date_created]	DateTime	*
data.parent_ticket[attachments][][blob][is_temp]	boolean	*
data.parent_ticket[attachments][][blob][source_ref]	string	*
data.parent_ticket[attachments][][blob][labels][]	array of objects (LabelBlob)	*
data.parent_ticket[attachments][][blob][labels][][blob]	object (Blob)	*
data.parent_ticket[attachments][][message]	integer id (TicketMessage)	*	Message - holder of this attachment.
data.parent_ticket[attachments][][is_agent_note]	boolean	*	True if this attachmen just a note.
data.parent_ticket[attachments][][is_inline]	boolean	*	Is this attachment is embed in message.
data.parent_ticket[access_codes][]	array of objects (TicketAccessCode)	*
data.parent_ticket[access_codes][][id]	integer	*
data.parent_ticket[access_codes][][ticket]	object (Ticket)	*
data.parent_ticket[access_codes][][person]	object (Person)	*
data.parent_ticket[access_codes][][auth]	string	*
data.parent_ticket[messages][]	array of objects (TicketMessage)	*
data.parent_ticket[messages][][id]	integer	*	The unique id of message.
data.parent_ticket[messages][][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data.parent_ticket[messages][][person]	object (Person)	*	Person this message was sent by.
data.parent_ticket[messages][][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data.parent_ticket[messages][][email_source][id]	integer	*
data.parent_ticket[messages][][email_source][uuid]	string	*
data.parent_ticket[messages][][email_source][blob]	object (Blob)	*
data.parent_ticket[messages][][email_source][blob][sys_name]	string	*	A unique system name for the blob.
data.parent_ticket[messages][][email_source][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.parent_ticket[messages][][email_source][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.parent_ticket[messages][][email_source][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.parent_ticket[messages][][email_source][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.parent_ticket[messages][][email_source][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.parent_ticket[messages][][email_source][blob][file_url]	string	*	The HTTP link to download the file.
data.parent_ticket[messages][][email_source][blob][authcode]	string	*
data.parent_ticket[messages][][email_source][blob][blob_hash]	string	*
data.parent_ticket[messages][][email_source][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.parent_ticket[messages][][email_source][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.parent_ticket[messages][][email_source][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.parent_ticket[messages][][email_source][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.parent_ticket[messages][][email_source][blob][date_created]	DateTime	*
data.parent_ticket[messages][][email_source][blob][is_temp]	boolean	*
data.parent_ticket[messages][][email_source][blob][source_ref]	string	*
data.parent_ticket[messages][][email_source][blob][labels][]	array of objects (LabelBlob)	*
data.parent_ticket[messages][][email_source][blob][labels][][blob]	object (Blob)	*
data.parent_ticket[messages][][email_source][object_type]	string	*	The type of object this is attached to (should be the table name of the super type, eg: tickets, people, organizations). This typically is not set until after the email is processed (ie the status is 'processed').
data.parent_ticket[messages][][email_source][object_id]	integer	*	The ID of the object this is attached to.
data.parent_ticket[messages][][email_source][from_email]	string	*
data.parent_ticket[messages][][email_source][status]	string	*	The current status of the message: - inserted: Only inserted - processing: Currently processing - complete: Fully processed - error: Tried to process but there was some kind of error (see error_code).
data.parent_ticket[messages][][email_source][date_status]	DateTime	*
data.parent_ticket[messages][][email_source][error_code]	string	*	When status is error, this is the code that describes the error.
data.parent_ticket[messages][][email_source][date_created]	DateTime	*
data.parent_ticket[messages][][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.parent_ticket[messages][][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.parent_ticket[messages][][snippet_use_logs][][id]	integer	*	The unique ID.
data.parent_ticket[messages][][snippet_use_logs][][snippet]	object (SnippetV2)	*	Snippet used.
data.parent_ticket[messages][][snippet_use_logs][][snippet][id]	integer	*
data.parent_ticket[messages][][snippet_use_logs][][snippet][title]	string	*
data.parent_ticket[messages][][snippet_use_logs][][snippet][author]	object (Person)	*
data.parent_ticket[messages][][snippet_use_logs][][snippet][is_private]	boolean	*
data.parent_ticket[messages][][snippet_use_logs][][snippet][avatar]	object (Blob)	*
data.parent_ticket[messages][][snippet_use_logs][][snippet][avatar][sys_name]	string	*	A unique system name for the blob.
data.parent_ticket[messages][][snippet_use_logs][][snippet][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.parent_ticket[messages][][snippet_use_logs][][snippet][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.parent_ticket[messages][][snippet_use_logs][][snippet][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.parent_ticket[messages][][snippet_use_logs][][snippet][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.parent_ticket[messages][][snippet_use_logs][][snippet][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.parent_ticket[messages][][snippet_use_logs][][snippet][avatar][file_url]	string	*	The HTTP link to download the file.
data.parent_ticket[messages][][snippet_use_logs][][snippet][avatar][authcode]	string	*
data.parent_ticket[messages][][snippet_use_logs][][snippet][avatar][blob_hash]	string	*
data.parent_ticket[messages][][snippet_use_logs][][snippet][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.parent_ticket[messages][][snippet_use_logs][][snippet][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.parent_ticket[messages][][snippet_use_logs][][snippet][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.parent_ticket[messages][][snippet_use_logs][][snippet][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.parent_ticket[messages][][snippet_use_logs][][snippet][avatar][date_created]	DateTime	*
data.parent_ticket[messages][][snippet_use_logs][][snippet][avatar][is_temp]	boolean	*
data.parent_ticket[messages][][snippet_use_logs][][snippet][avatar][source_ref]	string	*
data.parent_ticket[messages][][snippet_use_logs][][snippet][avatar][labels][]	array of objects (LabelBlob)	*
data.parent_ticket[messages][][snippet_use_logs][][snippet][avatar][labels][][blob]	object (Blob)	*
data.parent_ticket[messages][][snippet_use_logs][][snippet][status]	string	*
data.parent_ticket[messages][][snippet_use_logs][][snippet][shortcut_codes]	array	*
data.parent_ticket[messages][][snippet_use_logs][][snippet][inline_translations]	array	*
data.parent_ticket[messages][][snippet_use_logs][][snippet][translations][]	array of objects (SnippetV2Translation)	*
data.parent_ticket[messages][][snippet_use_logs][][snippet][translations][][id]	integer	*	The unique ID.
data.parent_ticket[messages][][snippet_use_logs][][snippet][translations][][snippet]	object (SnippetV2)	*	Snippet translated.
data.parent_ticket[messages][][snippet_use_logs][][snippet][translations][][language]	object (Language)	*
data.parent_ticket[messages][][snippet_use_logs][][snippet][translations][][content]	array	*	Snippet content.
data.parent_ticket[messages][][snippet_use_logs][][snippet][translations][][blobs][]	array of objects (Blob)	*
data.parent_ticket[messages][][snippet_use_logs][][snippet][categories][]	array of objects (SnippetV2Category)	*
data.parent_ticket[messages][][snippet_use_logs][][snippet][categories][][id]	integer	*
data.parent_ticket[messages][][snippet_use_logs][][snippet][categories][][title]	string	*
data.parent_ticket[messages][][snippet_use_logs][][snippet][categories][][is_global]	boolean	*
data.parent_ticket[messages][][snippet_use_logs][][snippet][categories][][display_order]	integer	*
data.parent_ticket[messages][][snippet_use_logs][][snippet][categories][][parent]	object (SnippetV2Category)	*
data.parent_ticket[messages][][snippet_use_logs][][snippet][categories][][agent_teams][]	array of objects (AgentTeam)	*
data.parent_ticket[messages][][snippet_use_logs][][snippet][display_order]	integer	*
data.parent_ticket[messages][][snippet_use_logs][][snippet][date_created]	DateTime	*
data.parent_ticket[messages][][snippet_use_logs][][ticket_message]	object (TicketMessage)	*	Ticket Message where the snippet was used.
data.parent_ticket[messages][][snippet_use_logs][][chat_message]	object (ChatMessage)	*	Chat Message where the snippet was used.
data.parent_ticket[messages][][snippet_use_logs][][chat_message][id]	integer	*	The unique ID.
data.parent_ticket[messages][][snippet_use_logs][][chat_message][author_id]	integer	*	Author id (legacy).
data.parent_ticket[messages][][snippet_use_logs][][chat_message][author_type]	string	*	Author type (legacy).
data.parent_ticket[messages][][snippet_use_logs][][chat_message][conversation_id]	integer	*	Conversation id (legacy).
data.parent_ticket[messages][][snippet_use_logs][][chat_message][author]	integer id (Person)	*	Person who created the message.
data.parent_ticket[messages][][snippet_use_logs][][chat_message][content]	string	*	The message.
data.parent_ticket[messages][][snippet_use_logs][][chat_message][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.parent_ticket[messages][][snippet_use_logs][][chat_message][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.parent_ticket[messages][][snippet_use_logs][][chat_message][is_html]	boolean	*	Is the content an HTML message?
data.parent_ticket[messages][][snippet_use_logs][][chat_message][metadata]	array	*	Additional data.
data.parent_ticket[messages][][snippet_use_logs][][chat_message][date_created]	DateTime	*	Date message was created.
data.parent_ticket[messages][][snippet_use_logs][][chat_message][date_received]	DateTime	*	Date message was received.
data.parent_ticket[messages][][snippet_use_logs][][language]	object (Language)	*	Snippet translated.
data.parent_ticket[messages][][snippet_use_logs][][person]	object (Person)	*
data.parent_ticket[messages][][snippet_use_logs][][rating]	integer	*
data.parent_ticket[messages][][snippet_use_logs][][rating_person]	object (Person)	*
data.parent_ticket[messages][][snippet_use_logs][][rating_message]	string	*
data.parent_ticket[messages][][snippet_use_logs][][date_created]	DateTime	*
data.parent_ticket[messages][][date_created]	DateTime	*	Date when message was created.
data.parent_ticket[messages][][is_agent_note]	boolean	*	Is this message agent note?
data.parent_ticket[messages][][is_hidden]	boolean	*	Is this message hidden?
data.parent_ticket[messages][][creation_system]	string	*	How this message was created.
data.parent_ticket[messages][][ip_address]	string	*	An ip address from which message was sent.
data.parent_ticket[messages][][visitor_id]	string	*	Unique ID of visitor left this message.
data.parent_ticket[messages][][hostname]	string	*	Host from which message was left.
data.parent_ticket[messages][][geo_country]	string	*	Country message is from (deprecated).
data.parent_ticket[messages][][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.parent_ticket[messages][][message_hash]	string	*	An unique hash of message.
data.parent_ticket[messages][][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.parent_ticket[messages][][primary_translation][id]	integer	*
data.parent_ticket[messages][][primary_translation][ticket]	object (Ticket)	*
data.parent_ticket[messages][][primary_translation][ticket_message]	object (TicketMessage)	*
data.parent_ticket[messages][][primary_translation][from_lang_code]	string	*
data.parent_ticket[messages][][primary_translation][lang_code]	string	*
data.parent_ticket[messages][][primary_translation][message]	string	*
data.parent_ticket[messages][][primary_translation][date_created]	DateTime	*
data.parent_ticket[messages][][message]	string	*	The message, will be in HTML!
data.parent_ticket[messages][][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.parent_ticket[messages][][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.parent_ticket[messages][][message_source]	string	*	The message source.
data.parent_ticket[messages][][message_source_type]	string	*	The message source type.
data.parent_ticket[messages][][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.parent_ticket[messages][][lang_code]	string	*	The set/detected lang code.
data.parent_ticket[messages][][email_message_id][]	array of objects (TicketMessageEmailId)	*
data.parent_ticket[messages][][email_message_id][][id]	integer	*
data.parent_ticket[messages][][email_message_id][][message]	object (TicketMessage)	*
data.parent_ticket[messages][][email_message_id][][email_id]	string	*
data.parent_ticket[messages][][ticket_feedback][]	array of objects (TicketFeedback)	*
data.parent_ticket[messages][][ticket_feedback][][id]	integer	*
data.parent_ticket[messages][][ticket_feedback][][ticket]	object (Ticket)	*
data.parent_ticket[messages][][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data.parent_ticket[messages][][ticket_feedback][][person]	object (Person)	*
data.parent_ticket[messages][][ticket_feedback][][rating]	integer	*
data.parent_ticket[messages][][ticket_feedback][][message]	string	*
data.parent_ticket[messages][][ticket_feedback][][date_created]	DateTime	*
data.parent_ticket[messages][][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data.parent_ticket[messages][][ticket_message_forwards][][id]	integer	*
data.parent_ticket[messages][][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data.parent_ticket[messages][][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data.parent_ticket[messages][][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data.parent_ticket[messages][][ticket_message_forwards][][subject]	string	*
data.parent_ticket[messages][][ticket_message_forwards][][from_email]	string	*
data.parent_ticket[messages][][ticket_message_forwards][][tos]	array	*
data.parent_ticket[messages][][ticket_message_forwards][][ccs]	array	*
data.parent_ticket[messages][][ticket_message_forwards][][bccs]	array	*
data.parent_ticket[messages][][ticket_message_forwards][][message]	string	*
data.parent_ticket[messages][][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data.parent_ticket[messages][][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data.parent_ticket[messages][][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.parent_ticket[messages][][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.parent_ticket[messages][][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.parent_ticket[messages][][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.parent_ticket[messages][][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data.parent_ticket[messages][][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data.parent_ticket[messages][][ticket_message_forwards][][blobs][][authcode]	string	*
data.parent_ticket[messages][][ticket_message_forwards][][blobs][][blob_hash]	string	*
data.parent_ticket[messages][][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.parent_ticket[messages][][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data.parent_ticket[messages][][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data.parent_ticket[messages][][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data.parent_ticket[messages][][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data.parent_ticket[messages][][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data.parent_ticket[messages][][ticket_message_forwards][][blobs][][source_ref]	string	*
data.parent_ticket[messages][][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data.parent_ticket[messages][][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data.parent_ticket[messages][][ticket_message_forwards][][date_created]	DateTime	*
data.parent_ticket[messages][][channel_message]	object (TicketMessageChannelMessage)	*
data.parent_ticket[messages][][channel_message][id]	integer	*	@var int The unique id of message.
data.parent_ticket[messages][][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data.parent_ticket[messages][][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data.parent_ticket[messages][][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data.parent_ticket[messages][][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data.parent_ticket[messages][][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data.parent_ticket[messages][][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data.parent_ticket[messages][][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data.parent_ticket[messages][][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data.parent_ticket[messages][][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data.parent_ticket[sms_messages][]	array of objects (TicketSms)	*
data.parent_ticket[sms_messages][][id]	integer	*
data.parent_ticket[sms_messages][][ticket]	object (Ticket)	*
data.parent_ticket[sms_messages][][person]	object (Person)	*
data.parent_ticket[sms_messages][][sms_account]	object (SmsAccount)	*
data.parent_ticket[sms_messages][][sms_account][id]	integer	*	The unique ID.
data.parent_ticket[sms_messages][][sms_account][type]	string	*
data.parent_ticket[sms_messages][][sms_account][params]	array	*
data.parent_ticket[sms_messages][][sms_account][identifier]	string	*
data.parent_ticket[sms_messages][][sms_account][is_enabled]	boolean	*
data.parent_ticket[sms_messages][][sms_account][is_connected]	boolean	*
data.parent_ticket[sms_messages][][sms_account][is_tested]	boolean	*
data.parent_ticket[sms_messages][][sms_account][test_code]	string	*
data.parent_ticket[sms_messages][][job]	object (Job)	*
data.parent_ticket[sms_messages][][job][id]	integer	*	The unique job id.
data.parent_ticket[sms_messages][][job][type]	string	*	The job type, used by the Job Router to find the right Job Processor.
data.parent_ticket[sms_messages][][job][status]	string	*	The status of the job.
data.parent_ticket[sms_messages][][job][status_code]	string	*	Any code to further classify the status.
data.parent_ticket[sms_messages][][job][date_touch]	DateTime	*	Date the last time a process "touched" this ticket.
data.parent_ticket[sms_messages][][job][date_created]	DateTime	*	Date this job entered the "jobs" table.
data.parent_ticket[sms_messages][][job][date_last_try]	DateTime	*	Last time we processed this job.
data.parent_ticket[sms_messages][][job][date_next_try]	DateTime	*	If this DateTime is in the future, it won't be selected for execution.
data.parent_ticket[sms_messages][][job][num_tries]	integer	*	The number of times this job has been executed Job Processor (usually indicated failures if > 1).
data.parent_ticket[sms_messages][][job][log_summary]	string	*	A human readable summary of the job's execution.
data.parent_ticket[sms_messages][][job][log]	string	*	A more verbose log.
data.parent_ticket[sms_messages][][job][data]	array	*	An array of data, or payload, that the job processor needs to execute this job (stored in the db as json). This MUST always be an array, even if its an empty array
data.parent_ticket[sms_messages][][job][original_job]	integer	*	Null unless the job was created as a retry - if so, the originating job ID is stored here so we can query it later. Note: You MUST specify the originating job, do not create a linked list of failed jobs.
data.parent_ticket[sms_messages][][date_created]	DateTime	*
data.parent_ticket[sms_messages][][from_number]	string	*	Permanent record of the phone number that sent this SMS. (Won't change even if Person changes their phone number).
data.parent_ticket[sms_messages][][to_number]	string	*	Permanent record of the phone number that this SMS was sent to.
data.parent_ticket[sms_messages][][message]	string	*	The SMS message.
data.parent_ticket[sms_messages][][direction]	string	*	Just a system flag for reporting.
data.parent_ticket[topic_links][]	array of objects (TicketCommunityTopicLink)	*
data.parent_ticket[topic_links][][id]	integer	*	The unique filter ID.
data.parent_ticket[topic_links][][ticket]	integer id (Ticket)	*
data.parent_ticket[topic_links][][topic]	integer id (CommunityTopic)	*
data.parent_ticket[topic_links][][person]	integer id (Person)	*
data.parent_ticket[topic_links][][date_created]	DateTime	*
data.parent_ticket[custom_data][]	array of objects (CustomDataTicket)	*
data.parent_ticket[custom_data][][ticket]	object (Ticket)	*
data.parent_ticket[custom_data][][field]	object (CustomDefTicket)	*
data.parent_ticket[custom_data][][field][parent]	object (CustomDefTicket)	*
data.parent_ticket[custom_data][][field][children][]	array of objects (CustomDefTicket)	*	Field children.
data.parent_ticket[custom_data][][field][title]		*
data.parent_ticket[custom_data][][root_field]	object (CustomDefTicket)	*
data.parent_ticket[labels][]	array of objects (LabelTicket)	*
data.parent_ticket[labels][][ticket]	object (Ticket)	*
data.parent_ticket[sent_to_address]	string	*	The email address the ticket was sent to if it came in via a gateway. This is a full string (e.g., including CC's) of the original.
data.parent_ticket[email_account]	object (EmailAccount)	*	The gateway this ticket originated from.
data.parent_ticket[email_account][id]	integer	*
data.parent_ticket[email_account][account_type]	string	*
data.parent_ticket[email_account][is_enabled]	boolean	*
data.parent_ticket[email_account][address]	string	*
data.parent_ticket[email_account][cert_blob]	object (Blob)	*
data.parent_ticket[email_account][cert_blob][sys_name]	string	*	A unique system name for the blob.
data.parent_ticket[email_account][cert_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.parent_ticket[email_account][cert_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.parent_ticket[email_account][cert_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.parent_ticket[email_account][cert_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.parent_ticket[email_account][cert_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.parent_ticket[email_account][cert_blob][file_url]	string	*	The HTTP link to download the file.
data.parent_ticket[email_account][cert_blob][authcode]	string	*
data.parent_ticket[email_account][cert_blob][blob_hash]	string	*
data.parent_ticket[email_account][cert_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.parent_ticket[email_account][cert_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.parent_ticket[email_account][cert_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.parent_ticket[email_account][cert_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.parent_ticket[email_account][cert_blob][date_created]	DateTime	*
data.parent_ticket[email_account][cert_blob][is_temp]	boolean	*
data.parent_ticket[email_account][cert_blob][source_ref]	string	*
data.parent_ticket[email_account][cert_blob][labels][]	array of objects (LabelBlob)	*
data.parent_ticket[email_account][cert_blob][labels][][blob]	object (Blob)	*
data.parent_ticket[email_account][key_blob]	object (Blob)	*
data.parent_ticket[email_account_address]	string	*	The email address (from list of to/cc) that matched with the email account.
data.parent_ticket[creation_system]	string	*
data.parent_ticket[creation_system_option]	string	*	Optional information about the creation system. For example, source URL the ticket came from.
data.parent_ticket[ticket_hash]	string	*
data.parent_ticket[status]	string	*
data.parent_ticket[ticket_status]	object (TicketStatus)	*
data.parent_ticket[ticket_status][id]	integer	*
data.parent_ticket[ticket_status][status_type]	string	*
data.parent_ticket[ticket_status][status_code]	string	*
data.parent_ticket[ticket_status][sys_id]	string	*
data.parent_ticket[ticket_status][title]	string	*
data.parent_ticket[ticket_status][display_order]	integer	*
data.parent_ticket[ticket_status][pending_waiting_time_mode]	string	*	Where to count time spending in pending status. Check PENDING_WAITING_TIME_MODE_ constants
data.parent_ticket[ticket_status][children][]	array of objects (TicketStatus)	*
data.parent_ticket[ticket_status][options]	array	*
data.parent_ticket[ticket_status][statusType]		*
data.parent_ticket[ticket_status][displayOrder]	integer	*
data.parent_ticket[urgency]	integer	*
data.parent_ticket[feedback_rating]	integer	*
data.parent_ticket[date_feedback_rating]	DateTime	*
data.parent_ticket[date_created]	DateTime	*
data.parent_ticket[date_resolved]	DateTime	*
data.parent_ticket[date_archived]	DateTime	*
data.parent_ticket[date_first_agent_assign]	DateTime	*
data.parent_ticket[date_first_agent_reply]	DateTime	*
data.parent_ticket[date_last_agent_reply]	DateTime	*
data.parent_ticket[date_last_user_reply]	DateTime	*
data.parent_ticket[date_agent_waiting]	DateTime	*
data.parent_ticket[date_user_waiting]	DateTime	*
data.parent_ticket[date_status]	DateTime	*
data.parent_ticket[date_on_hold]	DateTime	*
data.parent_ticket[total_user_waiting]	integer	*
data.parent_ticket[total_to_first_reply]	integer	*
data.parent_ticket[total_user_waiting_wh_start]	DateTime	*
data.parent_ticket[total_user_waiting_wh]	integer	*
data.parent_ticket[total_to_first_reply_wh]	integer	*
data.parent_ticket[locked_by_agent]	object (Person)	*
data.parent_ticket[date_locked]	DateTime	*
data.parent_ticket[has_attachments]	boolean	*
data.parent_ticket[subject]	string	*
data.parent_ticket[original_subject]	string	*
data.parent_ticket[properties]	array	*
data.parent_ticket[count_agent_replies]	integer	*
data.parent_ticket[count_user_replies]	integer	*
data.parent_ticket[worst_sla_status]	string	*
data.parent_ticket[waiting_times]	array	*	Used to track ticket status changes and how much time ticket was in status Add new item every time status changed This is optimisation over TicketLog.
data.parent_ticket[participants][]	array of objects (TicketParticipant)	*
data.parent_ticket[participants][][id]	integer	*
data.parent_ticket[participants][][ticket]	object (Ticket)	*
data.parent_ticket[participants][][person]	object (Person)	*
data.parent_ticket[participants][][access_code]	object (TicketAccessCode)	*
data.parent_ticket[participants][][person_email]	object (PersonEmail)	*
data.parent_ticket[participants][][default_on]	boolean	*	Default checkbox status of the user.
data.parent_ticket[charges][]	array of objects (TicketCharge)	*
data.parent_ticket[charges][][id]	integer	*
data.parent_ticket[charges][][charge_time]	integer	*
data.parent_ticket[charges][][amount]	float	*
data.parent_ticket[charges][][date_created]	DateTime	*
data.parent_ticket[charges][][ticket]	object (Ticket)	*
data.parent_ticket[charges][][person]	object (Person)	*
data.parent_ticket[charges][][organization]	object (Organization)	*
data.parent_ticket[charges][][agent]	object (Person)	*
data.parent_ticket[charges][][custom_data][]	array of objects (CustomDataBilling)	*
data.parent_ticket[charges][][custom_data][][ticket_charge]	object (TicketCharge)	*
data.parent_ticket[charges][][custom_data][][field]	object (CustomDefBilling)	*
data.parent_ticket[charges][][custom_data][][field][parent]	object (CustomDefBilling)	*
data.parent_ticket[charges][][custom_data][][field][children][]	array of objects (CustomDefBilling)	*	Field children.
data.parent_ticket[charges][][custom_data][][field][title]		*
data.parent_ticket[charges][][custom_data][][root_field]	object (CustomDefBilling)	*
data.parent_ticket[ticket_slas][]	array of objects (TicketSla)	*
data.parent_ticket[ticket_slas][][id]	integer	*	The unique ID.
data.parent_ticket[ticket_slas][][sla_status]	string	*	The SLA status.
data.parent_ticket[ticket_slas][][warn_date]	DateTime	*	The SLA warn date.
data.parent_ticket[ticket_slas][][fail_date]	DateTime	*	The SLA fail date.
data.parent_ticket[ticket_slas][][is_completed]	boolean	*	Is the SLA completed?
data.parent_ticket[ticket_slas][][is_completed_set]	boolean	*	Completed by automated action.
data.parent_ticket[ticket_slas][][completed_time_taken]	integer	*	Time taken.
data.parent_ticket[ticket_slas][][ticket]	integer id (Ticket)	*	Ticket.
data.parent_ticket[ticket_slas][][sla]	integer id (Sla)	*	SLA.
data.parent_ticket[ticket_slas][][date_applied]	DateTime	*	time and date when SLA was applied to the ticket.
data.parent_ticket[ticket_slas][][date_completed]	DateTime	*	time when SLA status became OK.
data.parent_ticket[jira_issues][]	array of objects (JiraIssue)	*	linked jira issues.
data.parent_ticket[jira_issues][][id]	integer	*	The unique ID.
data.parent_ticket[jira_issues][][ticket]	object (Ticket)	*	The associated DeskPRO ticket.
data.parent_ticket[jira_issues][][issue_id]	integer	*
data.parent_ticket[jira_issues][][status_id]	integer	*
data.parent_ticket[jira_issues][][created]	DateTime	*	Export time.
data.parent_ticket[problems][]	array of objects (Problem)	*
data.parent_ticket[problems][][id]	integer	*	The unique ID.
data.parent_ticket[problems][][title]	string	*	Problem title.
data.parent_ticket[problems][][creator]	integer id (Person)	*	Person who created the problem.
data.parent_ticket[problems][][created]	DateTime	*	Date when the problem was created.
data.parent_ticket[problems][][is_open]	boolean	*	Is problem still has no solution?
data.parent_ticket[problems][][tickets][]	array of integer ids (Ticket)	*	Tickets associated with problem.
data.parent_ticket[stars][]	array of objects (TicketFlagged)	*
data.parent_ticket[stars][][ticket]	object (Ticket)	*
data.parent_ticket[stars][][person_id]	integer	*
data.parent_ticket[stars][][color]	string	*
data.parent_ticket[follow_ups][]	array of objects (TicketFollowUp)	*
data.parent_ticket[follow_ups][][id]	integer	*	The unique ID.
data.parent_ticket[follow_ups][][person]	integer id (Person)	*
data.parent_ticket[follow_ups][][actions]	array	*
data.parent_ticket[follow_ups][][cancel_if_user_reply]	boolean	*
data.parent_ticket[follow_ups][][cancel_if_agent_reply]	boolean	*
data.parent_ticket[follow_ups][][status]	string	*
data.parent_ticket[follow_ups][][date_created]	DateTime	*
data.parent_ticket[follow_ups][][date_to_run]	DateTime	*
data.parent_ticket[follow_ups][][date_did_run]	DateTime	*
data.parent_ticket[follow_ups][][dateToRun]		*
data.parent_ticket[logs][]	array of objects (TicketLog)	*
data.parent_ticket[logs][][id]	integer	*
data.parent_ticket[logs][][parent]	object (TicketLog)	*
data.parent_ticket[logs][][ticket]	object (Ticket)	*
data.parent_ticket[logs][][person]	object (Person)	*
data.parent_ticket[logs][][action_type]	string	*
data.parent_ticket[logs][][id_object]	integer	*	If the log involves a specific thing in a ticket (eg a message that was moved), then that is this id.
data.parent_ticket[logs][][id_before]	integer	*	The ID of the previous entity changed, or any other numeric value.
data.parent_ticket[logs][][id_after]	integer	*	The ID of the new entity, or any other numeric value.
data.parent_ticket[logs][][trigger_id]	integer	*	If the change was caused by a trigger, the trigger id. Note this is the integer ID (not a FK relation) so the record is kept even if the trigger itself is deleted.
data.parent_ticket[logs][][escalation_id]	integer	*	If the change was caused by an escalation Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.parent_ticket[logs][][macro_id]	integer	*	If the change was caused by an v2 macro Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.parent_ticket[logs][][sla]	object (Sla)	*	If the change was caused by an SLA, the SLA.
data.parent_ticket[logs][][sla][id]	integer	*	The unique ID.
data.parent_ticket[logs][][sla][title]	string	*	SLA title.
data.parent_ticket[logs][][sla][sla_type]	string	*	Type of SLA - first_response, resolution, waiting_time.
data.parent_ticket[logs][][sla][active_time]	string	*	Whether active all the time (all) or during work hours only (work_hours) or use the default ticket-wide settings (default).
data.parent_ticket[logs][][sla][work_start]	integer	*	When the work day starts. This is stored as the number of seconds after 00:00:00.
data.parent_ticket[logs][][sla][work_end]	integer	*	When the work day ends. This is stored as the number of seconds after 00:00:00.
data.parent_ticket[logs][][sla][work_days]	array	*	Array of work days, stored with keys corresponding to day numbers. Values are true. 0 = Sunday, 6 = Saturday (same as PHP, easy to convert to MySQL which is 1 = Sunday, 7 = Saturday).
data.parent_ticket[logs][][sla][work_timezone]	string	*	Timezone for work hours/days to be considered in.
data.parent_ticket[logs][][sla][work_holidays]	array	*	List of work holidays.
data.parent_ticket[logs][][sla][apply_type]	string	*	Controls how the SLA is applied to tickets: all, terms, terms_before_triggers, manual.
data.parent_ticket[logs][][sla][apply_terms]	object (TriggerTerms)	*	Conditions to apply.
data.parent_ticket[logs][][sla][apply_terms][version]	integer	*	Terms version.
data.parent_ticket[logs][][sla][apply_terms][terms]	array	*	Terms themselves.
data.parent_ticket[logs][][sla][trigger_terms]	object (TriggerTerms)	*	Conditions to consider sla completed.
data.parent_ticket[logs][][sla][warn_time]	integer	*	Warn time integer.
data.parent_ticket[logs][][sla][warn_time_unit]	string	*	And it's unit (see warn time).
data.parent_ticket[logs][][sla][warn_actions]	object (TriggerActions)	*	How to warn about SLA will fail.
data.parent_ticket[logs][][sla][warn_actions][version]	integer	*	Actions version.
data.parent_ticket[logs][][sla][warn_actions][actions]	array	*	Actions array representation.
data.parent_ticket[logs][][sla][fail_time]	integer	*	Fail time integer.
data.parent_ticket[logs][][sla][fail_time_unit]	string	*	And it's measuring unit (see fail_time).
data.parent_ticket[logs][][sla][fail_actions]	object (TriggerActions)	*	What to do if SLA failed.
data.parent_ticket[logs][][sla][exclude_ticket_statuses]	array	*	This SLA will not apply while tickets are in these pending statuses.
data.parent_ticket[logs][][sla_status]	string	*
data.parent_ticket[logs][][details]	array	*
data.parent_ticket[logs][][date_created]	DateTime	*
data.parent_ticket[chats][]	array of objects (ChatConversation)	*
data.parent_ticket[created_with_channel]	string	*
data.parent_ticket[last_channel_used]	string	*
data.parent_ticket[channels]	array	*
data.parent_ticket[pending_articles][]	array of objects (ArticlePendingCreate)	*
data.parent_ticket[pending_articles][][id]	integer	*
data.parent_ticket[pending_articles][][person]	integer id (Person)	*
data.parent_ticket[pending_articles][][assigned_person]	integer id (Person)	*
data.parent_ticket[pending_articles][][ticket]	integer id (Ticket)	*
data.parent_ticket[pending_articles][][message]	integer id (TicketMessage)	*
data.parent_ticket[pending_articles][][comment]	string	*
data.parent_ticket[pending_articles][][date_created]	DateTime	*
data.parent_ticket[summary]	object (TicketSummary)	*
data.parent_ticket[summary][id]	integer	*
data.parent_ticket[summary][ticket]	object (Ticket)	*
data.parent_ticket[summary][summary]	string	*
data.parent_ticket[summary][summary_input]	string	*
data.parent_ticket[summary][date_created]	DateTime	*
data.children_tickets[]	array of objects (Ticket)	*
data.language	object (Language)	*	The language the ticket is in.
data.language[id]	integer	*	The unique ID.
data.language[sys_name]	string	*	The unique sys name assigned to the language.
data.language[title]	string	*	Title of the language.
data.language[title_local]	string	*	Title of the language.
data.language[base_filepath]	string	*	The base filepath for default phrases for this lang.
data.language[locale]	string	*	The locale code.
data.language[flag_image]	string	*	String path to image.
data.language[is_rtl]	boolean	*	True if this is a right-to-left language.
data.language[has_user]	boolean	*	True if has user.
data.language[has_agent]	boolean	*	True if has agent.
data.language[has_admin]	boolean	*	True if has admin.
data.language[plural_categories][]	array of strings	*
data.language[plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data.language[flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`
data.brand	object (Brand)	*
data.brand[id]	integer	*	The unique ID.
data.brand[name]	string	*	The brand name.
data.brand[slug]	string	*
data.brand[url]	string	*	The brand url.
data.brand[theme_set]	object (ThemeSet)	*
data.brand[theme_set][id]	integer	*
data.brand[theme_set][theme_id]	string	*
data.brand[theme_set][title]	string	*
data.brand[theme_set][options]		*
data.brand[edit_theme_set]	object (ThemeSet)	*
data.brand[departments][]	array of objects (Department)	*
data.brand[departments][][id]	integer	*
data.brand[departments][][parent]	object (Department)	*
data.brand[departments][][children][]	array of objects (Department)	*
data.brand[departments][][title]	string	*
data.brand[departments][][user_title]	string	*
data.brand[departments][][is_tickets_enabled]	boolean	*
data.brand[departments][][is_chat_enabled]	boolean	*
data.brand[departments][][display_order]	integer	*
data.brand[departments][][avatar]	object (Blob)	*
data.brand[departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.brand[departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.brand[departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.brand[departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.brand[departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.brand[departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.brand[departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.brand[departments][][avatar][authcode]	string	*
data.brand[departments][][avatar][blob_hash]	string	*
data.brand[departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.brand[departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.brand[departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.brand[departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.brand[departments][][avatar][date_created]	DateTime	*
data.brand[departments][][avatar][is_temp]	boolean	*
data.brand[departments][][avatar][source_ref]	string	*
data.brand[departments][][avatar][labels]	array of objects (LabelBlob)	*
data.brand[departments][][avatar][labels][blob]	object (Blob)	*
data.brand[departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.brand[departments][][brands][]	array of objects (Brand)	*
data.brand[departments][][permissions][]	array of objects (DepartmentPermission)	*
data.brand[departments][][permissions][][department]	integer id (Department)	*
data.brand[departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.brand[departments][][permissions][][name]	string	*	The name of the permission.
data.brand[departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.brand[departments][][permissions][][is_active]	boolean	*
data.brand[departments][][chat_queue]	object (UserChatQueue)	*
data.brand[departments][][chat_queue][id]	integer	*	The unique ID.
data.brand[departments][][chat_queue][name]	string	*
data.brand[departments][][chat_queue][routing_model]	string	*
data.brand[departments][][chat_queue][answer_timeout]	integer	*
data.brand[departments][][chat_queue][is_all_agents]	boolean	*
data.brand[departments][][chat_queue][departments][]	array of objects (Department)	*
data.brand[departments][][chat_queue][max_queue_size]	integer	*
data.brand[departments][][chat_queue][routingModel]		*
data.brand[theme_sets][]	array of objects (ThemeSet)	*
data.category	object (TicketCategory)	*
data.category[id]	integer	*	The unique ID.
data.category[parent]	integer id (TicketCategory)	*	This category parent.
data.category[title]	string	*	Category title.
data.category[display_order]	integer	*	Obviously it's display order for lists.
data.priority	object (TicketPriority)	*
data.priority[id]	integer	*	The unique ID.
data.priority[title]	string	*	Priority title.
data.priority[priority]	integer	*	The priority itself.
data.workflow	object (TicketWorkflow)	*
data.workflow[id]	integer	*	The unique ID.
data.workflow[title]	string	*	Workflow title.
data.workflow[display_order]	integer	*	Workflow display order.
data.product	object (Product)	*
data.product[parent]	integer id (Product)	*	Parent of the product.
data.product[title]		*
data.person_email	object (PersonEmail)	*
data.person_email[id]	integer	*	The unique ID.
data.person_email[person]	integer id (Person)	*	Person owner of email.
data.person_email[email]	string	*	The email address.
data.person_email[email_domain]	string	*	The email address domain.
data.person_email[is_validated]	boolean	*	True if validation passed.
data.person_email[date_created]	DateTime	*	The original time the email was created.
data.agent_team	object (AgentTeam)	*
data.agent_team[id]	integer	*	The unique ID.
data.agent_team[name]	string	*	The name of agent team.
data.agent_team[avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.agent_team[members]		*
data.organization	object (Organization)	*
data.organization[id]	integer	*	The unique ID.
data.organization[picture_blob]	object (Blob)	*	The org picture.
data.organization[picture_blob][sys_name]	string	*	A unique system name for the blob.
data.organization[picture_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.organization[picture_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.organization[picture_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.organization[picture_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.organization[picture_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.organization[picture_blob][file_url]	string	*	The HTTP link to download the file.
data.organization[picture_blob][authcode]	string	*
data.organization[picture_blob][blob_hash]	string	*
data.organization[picture_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.organization[picture_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.organization[picture_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.organization[picture_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.organization[picture_blob][date_created]	DateTime	*
data.organization[picture_blob][is_temp]	boolean	*
data.organization[picture_blob][source_ref]	string	*
data.organization[picture_blob][labels][]	array of objects (LabelBlob)	*
data.organization[picture_blob][labels][][blob]	object (Blob)	*
data.organization[icon_property]	object (IconProperty)	*
data.organization[icon_property][urn]	string	*
data.organization[icon_property][options]	array	*
data.organization[name]	string	*	The organization name.
data.organization[summary]	string	*	The summary field as filled in by agents.
data.organization[importance]	integer	*	The org importance.
data.organization[custom_data][]	array of objects (CustomDataOrganization)	*
data.organization[custom_data][][organization]	object (Organization)	*
data.organization[custom_data][][field]	object (CustomDefOrganization)	*
data.organization[custom_data][][field][parent]	object (CustomDefOrganization)	*	Field`s parent.
data.organization[custom_data][][field][children][]	array of objects (CustomDefOrganization)	*	Field children.
data.organization[custom_data][][field][title]		*
data.organization[custom_data][][root_field]	object (CustomDefOrganization)	*
data.organization[usergroups][]	array of objects (Usergroup)	*	Usergroups the user belongs to.
data.organization[usergroups][][id]	integer	*	The unique ID, DB-generated.
data.organization[usergroups][][title]	string	*	Title of the usergroup.
data.organization[usergroups][][note]	string	*	A note or description about the usergroup.
data.organization[usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.organization[usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.organization[usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.organization[usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.organization[usergroups][][permissions][][id]	integer	*	The unique ID.
data.organization[usergroups][][permissions][][name]	string	*	The name of the permission.
data.organization[usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.organization[usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.organization[usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.organization[usergroups][][department_permissions][][department]	integer id (Department)	*
data.organization[usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.organization[usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.organization[usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.organization[usergroups][][department_permissions][][is_active]	boolean	*
data.organization[usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.organization[auto_cc_people][]	array of objects (Person)	*	Users who are set to automatically be added to tickets and other org things.
data.organization[labels][]	array of objects (LabelOrganization)	*
data.organization[labels][][organization]	object (Organization)	*
data.organization[contact_data][]	array of objects (OrganizationContactData)	*
data.organization[contact_data][][organization]		*
data.organization[contact_data][][contact_type]		*
data.organization[contact_data][][comment]		*
data.organization[contact_data][][field_1]		*
data.organization[contact_data][][field_2]		*
data.organization[contact_data][][field_3]		*
data.organization[contact_data][][field_5]		*
data.organization[contact_data][][field_9]		*
data.organization[emails][]	array of objects (OrganizationEmail)	*
data.organization[emails][][id]	integer	*	The unique log id.
data.organization[emails][][organization]	object (Organization)	*
data.organization[emails][][email]	string	*
data.organization[emails][][date_created]	DateTime	*
data.organization[email_domains][]	array of objects (OrganizationEmailDomain)	*
data.organization[email_domains][][domain]	string	*	The email domain.
data.organization[email_domains][][organization]	object (Organization)	*	The users organization.
data.organization[date_created]	DateTime	*	The date the org was inserted into the system.
data.organization[members][]	array of objects (Person)	*
data.organization[parent]	object (Organization)	*
data.organization[children][]	array of objects (Organization)	*
data.organization[tickets][]	array of objects (Ticket)	*
data.organization[organization_members][]	array of objects (OrganizationMember)	*
data.organization[organization_members][][id]	integer	*
data.organization[organization_members][][person]	integer id (Person)	*
data.organization[organization_members][][organization]	integer id (Organization)	*
data.organization[organization_members][][is_manager]	boolean	*
data.organization[organization_members][][position]	string	*
data.organization[organization_members][][created_at]	DateTime	*
data.organization[organization_members][][updated_at]	DateTime	*
data.organization[publicUsergroups]		*
data.linked_chat	object (ChatConversation)	*
data.linked_chat[id]	integer	*	The unique id of chat conversation.
data.linked_chat[department]	object (Department)	*	Department which chat was assigned.
data.linked_chat[brand]	object (Brand)	*	Department which chat was assigned.
data.linked_chat[task_id]	integer	*
data.linked_chat[ticket]	object (Ticket)	*
data.linked_chat[labels][]	array of objects (LabelChatConversation)	*
data.linked_chat[labels][][chat]	object (ChatConversation)	*
data.linked_chat[subject]	string	*	Subject of the chat conversation.
data.linked_chat[status]	string	*	Status of the chat conversation.
data.linked_chat[agent]	object (Person)	*	If this is a user conversation, this is the agent assigned.
data.linked_chat[agent_team]	object (AgentTeam)	*	If this is a team chat, the team it is.
data.linked_chat[person]	object (Person)	*	If this is a user conversation, this is the user who started the chat.
data.linked_chat[session]	object (Session)	*	If this is a user convo, this is the users session.
data.linked_chat[session][id]	integer	*	The unique ID.
data.linked_chat[session][auth]	string	*	The authcode for the session to verify an id.
data.linked_chat[session][interface]	string	*	The Interface the session is for.
data.linked_chat[session][person]	object (Person)	*
data.linked_chat[session][user_agent]	string	*	The users user agent string.
data.linked_chat[session][visitor_id]	string	*
data.linked_chat[session][ip_address]	string	*	The users IP address.
data.linked_chat[session][data]	string	*
data.linked_chat[session][is_person]	boolean	*
data.linked_chat[session][is_bot]	boolean	*
data.linked_chat[session][is_helpdesk]	boolean	*
data.linked_chat[session][active_status]	string	*	(Agents) Status (available or away).
data.linked_chat[session][is_chat_available]	boolean	*	(Agents) Wehn status is available, if they are available for chat.
data.linked_chat[session][date_created]	DateTime	*
data.linked_chat[session][date_last]	DateTime	*
data.linked_chat[session][date_last_page]	DateTime	*
data.linked_chat[visitor_id]	string	*
data.linked_chat[person_name]	string	*	User chat: The users name, if they arent a person.
data.linked_chat[person_email]	string	*	User chat: The users email, if they aren`t a person.
data.linked_chat[participants][]	array of objects (Person)	*
data.linked_chat[messages][]	array of objects (ChatMessage)	*
data.linked_chat[messages][][id]	integer	*	The unique ID.
data.linked_chat[messages][][author_id]	integer	*	Author id (legacy).
data.linked_chat[messages][][author_type]	string	*	Author type (legacy).
data.linked_chat[messages][][conversation_id]	integer	*	Conversation id (legacy).
data.linked_chat[messages][][author]	integer id (Person)	*	Person who created the message.
data.linked_chat[messages][][content]	string	*	The message.
data.linked_chat[messages][][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.linked_chat[messages][][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.linked_chat[messages][][is_html]	boolean	*	Is the content an HTML message?
data.linked_chat[messages][][metadata]	array	*	Additional data.
data.linked_chat[messages][][date_created]	DateTime	*	Date message was created.
data.linked_chat[messages][][date_received]	DateTime	*	Date message was received.
data.linked_chat[custom_data][]	array of objects (CustomDataChat)	*
data.linked_chat[custom_data][][conversation]	object (ChatConversation)	*	The conversation the message belongs to.
data.linked_chat[custom_data][][field]	object (CustomDefChat)	*
data.linked_chat[custom_data][][field][parent]	object (CustomDefChat)	*
data.linked_chat[custom_data][][field][children][]	array of objects (CustomDefChat)	*	Field children.
data.linked_chat[custom_data][][field][title]		*
data.linked_chat[custom_data][][root_field]	object (CustomDefChat)	*
data.linked_chat[rating_response_time]	integer	*
data.linked_chat[rating_overall]	integer	*
data.linked_chat[rating_comment]	string	*
data.linked_chat[is_agent]	boolean	*	Is this an agent chat.
data.linked_chat[is_window]	boolean	*	If the chat is popped out into a window. This is used to make sure the JS widget on pages doesn't load again.
data.linked_chat[date_created]	DateTime	*	Date when chat was started.
data.linked_chat[date_user_waiting]	DateTime	*	Since when the user has started waiting (i.e., time the assignment was 0).
data.linked_chat[date_assigned]	DateTime	*
data.linked_chat[date_agent_typing]	DateTime	*	Date when agent typed last time.
data.linked_chat[date_first_agent_message]	DateTime	*
data.linked_chat[date_ended]	DateTime	*	Date when chat was ended.
data.linked_chat[total_to_ended]	integer	*
data.linked_chat[ended_by]	string	*	Who ended the chat.
data.linked_chat[should_send_transcript]	boolean	*	True if transcript should be send.
data.linked_chat[date_transcript_sent]	DateTime	*	Date when transcript was sent.
data.linked_chat[email_validation_code]	string	*
data.linked_chat[email_validated]	boolean	*
data.linked_chat[access_token]	string	*
data.attachments[]	array of objects (TicketAttachment)	*
data.attachments[][id]	integer	*	The unique ID.
data.attachments[][ticket]	integer id (Ticket)	*	Ticket this attachment belongs to.
data.attachments[][person]	integer id (Person)	*	Who created the attachment.
data.attachments[][blob]	object (Blob)	*	Actual attachment.
data.attachments[][blob][sys_name]	string	*	A unique system name for the blob.
data.attachments[][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.attachments[][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.attachments[][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.attachments[][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.attachments[][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.attachments[][blob][file_url]	string	*	The HTTP link to download the file.
data.attachments[][blob][authcode]	string	*
data.attachments[][blob][blob_hash]	string	*
data.attachments[][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.attachments[][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.attachments[][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.attachments[][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.attachments[][blob][date_created]	DateTime	*
data.attachments[][blob][is_temp]	boolean	*
data.attachments[][blob][source_ref]	string	*
data.attachments[][blob][labels][]	array of objects (LabelBlob)	*
data.attachments[][blob][labels][][blob]	object (Blob)	*
data.attachments[][message]	integer id (TicketMessage)	*	Message - holder of this attachment.
data.attachments[][is_agent_note]	boolean	*	True if this attachmen just a note.
data.attachments[][is_inline]	boolean	*	Is this attachment is embed in message.
data.access_codes[]	array of objects (TicketAccessCode)	*
data.access_codes[][id]	integer	*
data.access_codes[][ticket]	object (Ticket)	*
data.access_codes[][person]	object (Person)	*
data.access_codes[][auth]	string	*
data.messages[]	array of objects (TicketMessage)	*
data.messages[][id]	integer	*	The unique id of message.
data.messages[][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data.messages[][person]	object (Person)	*	Person this message was sent by.
data.messages[][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data.messages[][email_source][id]	integer	*
data.messages[][email_source][uuid]	string	*
data.messages[][email_source][blob]	object (Blob)	*
data.messages[][email_source][blob][sys_name]	string	*	A unique system name for the blob.
data.messages[][email_source][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.messages[][email_source][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.messages[][email_source][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.messages[][email_source][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.messages[][email_source][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.messages[][email_source][blob][file_url]	string	*	The HTTP link to download the file.
data.messages[][email_source][blob][authcode]	string	*
data.messages[][email_source][blob][blob_hash]	string	*
data.messages[][email_source][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.messages[][email_source][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.messages[][email_source][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.messages[][email_source][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.messages[][email_source][blob][date_created]	DateTime	*
data.messages[][email_source][blob][is_temp]	boolean	*
data.messages[][email_source][blob][source_ref]	string	*
data.messages[][email_source][blob][labels][]	array of objects (LabelBlob)	*
data.messages[][email_source][blob][labels][][blob]	object (Blob)	*
data.messages[][email_source][object_type]	string	*	The type of object this is attached to (should be the table name of the super type, eg: tickets, people, organizations). This typically is not set until after the email is processed (ie the status is 'processed').
data.messages[][email_source][object_id]	integer	*	The ID of the object this is attached to.
data.messages[][email_source][from_email]	string	*
data.messages[][email_source][status]	string	*	The current status of the message: - inserted: Only inserted - processing: Currently processing - complete: Fully processed - error: Tried to process but there was some kind of error (see error_code).
data.messages[][email_source][date_status]	DateTime	*
data.messages[][email_source][error_code]	string	*	When status is error, this is the code that describes the error.
data.messages[][email_source][date_created]	DateTime	*
data.messages[][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.messages[][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.messages[][snippet_use_logs][][id]	integer	*	The unique ID.
data.messages[][snippet_use_logs][][snippet]	object (SnippetV2)	*	Snippet used.
data.messages[][snippet_use_logs][][snippet][id]	integer	*
data.messages[][snippet_use_logs][][snippet][title]	string	*
data.messages[][snippet_use_logs][][snippet][author]	object (Person)	*
data.messages[][snippet_use_logs][][snippet][is_private]	boolean	*
data.messages[][snippet_use_logs][][snippet][avatar]	object (Blob)	*
data.messages[][snippet_use_logs][][snippet][avatar][sys_name]	string	*	A unique system name for the blob.
data.messages[][snippet_use_logs][][snippet][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.messages[][snippet_use_logs][][snippet][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.messages[][snippet_use_logs][][snippet][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.messages[][snippet_use_logs][][snippet][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.messages[][snippet_use_logs][][snippet][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.messages[][snippet_use_logs][][snippet][avatar][file_url]	string	*	The HTTP link to download the file.
data.messages[][snippet_use_logs][][snippet][avatar][authcode]	string	*
data.messages[][snippet_use_logs][][snippet][avatar][blob_hash]	string	*
data.messages[][snippet_use_logs][][snippet][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.messages[][snippet_use_logs][][snippet][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.messages[][snippet_use_logs][][snippet][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.messages[][snippet_use_logs][][snippet][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.messages[][snippet_use_logs][][snippet][avatar][date_created]	DateTime	*
data.messages[][snippet_use_logs][][snippet][avatar][is_temp]	boolean	*
data.messages[][snippet_use_logs][][snippet][avatar][source_ref]	string	*
data.messages[][snippet_use_logs][][snippet][avatar][labels][]	array of objects (LabelBlob)	*
data.messages[][snippet_use_logs][][snippet][avatar][labels][][blob]	object (Blob)	*
data.messages[][snippet_use_logs][][snippet][status]	string	*
data.messages[][snippet_use_logs][][snippet][shortcut_codes]	array	*
data.messages[][snippet_use_logs][][snippet][inline_translations]	array	*
data.messages[][snippet_use_logs][][snippet][translations][]	array of objects (SnippetV2Translation)	*
data.messages[][snippet_use_logs][][snippet][translations][][id]	integer	*	The unique ID.
data.messages[][snippet_use_logs][][snippet][translations][][snippet]	object (SnippetV2)	*	Snippet translated.
data.messages[][snippet_use_logs][][snippet][translations][][language]	object (Language)	*
data.messages[][snippet_use_logs][][snippet][translations][][content]	array	*	Snippet content.
data.messages[][snippet_use_logs][][snippet][translations][][blobs][]	array of objects (Blob)	*
data.messages[][snippet_use_logs][][snippet][categories][]	array of objects (SnippetV2Category)	*
data.messages[][snippet_use_logs][][snippet][categories][][id]	integer	*
data.messages[][snippet_use_logs][][snippet][categories][][title]	string	*
data.messages[][snippet_use_logs][][snippet][categories][][is_global]	boolean	*
data.messages[][snippet_use_logs][][snippet][categories][][display_order]	integer	*
data.messages[][snippet_use_logs][][snippet][categories][][parent]	object (SnippetV2Category)	*
data.messages[][snippet_use_logs][][snippet][categories][][agent_teams][]	array of objects (AgentTeam)	*
data.messages[][snippet_use_logs][][snippet][display_order]	integer	*
data.messages[][snippet_use_logs][][snippet][date_created]	DateTime	*
data.messages[][snippet_use_logs][][ticket_message]	object (TicketMessage)	*	Ticket Message where the snippet was used.
data.messages[][snippet_use_logs][][chat_message]	object (ChatMessage)	*	Chat Message where the snippet was used.
data.messages[][snippet_use_logs][][chat_message][id]	integer	*	The unique ID.
data.messages[][snippet_use_logs][][chat_message][author_id]	integer	*	Author id (legacy).
data.messages[][snippet_use_logs][][chat_message][author_type]	string	*	Author type (legacy).
data.messages[][snippet_use_logs][][chat_message][conversation_id]	integer	*	Conversation id (legacy).
data.messages[][snippet_use_logs][][chat_message][author]	integer id (Person)	*	Person who created the message.
data.messages[][snippet_use_logs][][chat_message][content]	string	*	The message.
data.messages[][snippet_use_logs][][chat_message][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.messages[][snippet_use_logs][][chat_message][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.messages[][snippet_use_logs][][chat_message][is_html]	boolean	*	Is the content an HTML message?
data.messages[][snippet_use_logs][][chat_message][metadata]	array	*	Additional data.
data.messages[][snippet_use_logs][][chat_message][date_created]	DateTime	*	Date message was created.
data.messages[][snippet_use_logs][][chat_message][date_received]	DateTime	*	Date message was received.
data.messages[][snippet_use_logs][][language]	object (Language)	*	Snippet translated.
data.messages[][snippet_use_logs][][person]	object (Person)	*
data.messages[][snippet_use_logs][][rating]	integer	*
data.messages[][snippet_use_logs][][rating_person]	object (Person)	*
data.messages[][snippet_use_logs][][rating_message]	string	*
data.messages[][snippet_use_logs][][date_created]	DateTime	*
data.messages[][date_created]	DateTime	*	Date when message was created.
data.messages[][is_agent_note]	boolean	*	Is this message agent note?
data.messages[][is_hidden]	boolean	*	Is this message hidden?
data.messages[][creation_system]	string	*	How this message was created.
data.messages[][ip_address]	string	*	An ip address from which message was sent.
data.messages[][visitor_id]	string	*	Unique ID of visitor left this message.
data.messages[][hostname]	string	*	Host from which message was left.
data.messages[][geo_country]	string	*	Country message is from (deprecated).
data.messages[][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.messages[][message_hash]	string	*	An unique hash of message.
data.messages[][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.messages[][primary_translation][id]	integer	*
data.messages[][primary_translation][ticket]	object (Ticket)	*
data.messages[][primary_translation][ticket_message]	object (TicketMessage)	*
data.messages[][primary_translation][from_lang_code]	string	*
data.messages[][primary_translation][lang_code]	string	*
data.messages[][primary_translation][message]	string	*
data.messages[][primary_translation][date_created]	DateTime	*
data.messages[][message]	string	*	The message, will be in HTML!
data.messages[][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.messages[][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.messages[][message_source]	string	*	The message source.
data.messages[][message_source_type]	string	*	The message source type.
data.messages[][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.messages[][lang_code]	string	*	The set/detected lang code.
data.messages[][email_message_id][]	array of objects (TicketMessageEmailId)	*
data.messages[][email_message_id][][id]	integer	*
data.messages[][email_message_id][][message]	object (TicketMessage)	*
data.messages[][email_message_id][][email_id]	string	*
data.messages[][ticket_feedback][]	array of objects (TicketFeedback)	*
data.messages[][ticket_feedback][][id]	integer	*
data.messages[][ticket_feedback][][ticket]	object (Ticket)	*
data.messages[][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data.messages[][ticket_feedback][][person]	object (Person)	*
data.messages[][ticket_feedback][][rating]	integer	*
data.messages[][ticket_feedback][][message]	string	*
data.messages[][ticket_feedback][][date_created]	DateTime	*
data.messages[][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data.messages[][ticket_message_forwards][][id]	integer	*
data.messages[][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data.messages[][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data.messages[][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data.messages[][ticket_message_forwards][][subject]	string	*
data.messages[][ticket_message_forwards][][from_email]	string	*
data.messages[][ticket_message_forwards][][tos]	array	*
data.messages[][ticket_message_forwards][][ccs]	array	*
data.messages[][ticket_message_forwards][][bccs]	array	*
data.messages[][ticket_message_forwards][][message]	string	*
data.messages[][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data.messages[][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data.messages[][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.messages[][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.messages[][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.messages[][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.messages[][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data.messages[][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data.messages[][ticket_message_forwards][][blobs][][authcode]	string	*
data.messages[][ticket_message_forwards][][blobs][][blob_hash]	string	*
data.messages[][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.messages[][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data.messages[][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data.messages[][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data.messages[][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data.messages[][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data.messages[][ticket_message_forwards][][blobs][][source_ref]	string	*
data.messages[][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data.messages[][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data.messages[][ticket_message_forwards][][date_created]	DateTime	*
data.messages[][channel_message]	object (TicketMessageChannelMessage)	*
data.messages[][channel_message][id]	integer	*	@var int The unique id of message.
data.messages[][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data.messages[][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data.messages[][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data.messages[][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data.messages[][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data.messages[][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data.messages[][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data.messages[][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data.messages[][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data.sms_messages[]	array of objects (TicketSms)	*
data.sms_messages[][id]	integer	*
data.sms_messages[][ticket]	object (Ticket)	*
data.sms_messages[][person]	object (Person)	*
data.sms_messages[][sms_account]	object (SmsAccount)	*
data.sms_messages[][sms_account][id]	integer	*	The unique ID.
data.sms_messages[][sms_account][type]	string	*
data.sms_messages[][sms_account][params]	array	*
data.sms_messages[][sms_account][identifier]	string	*
data.sms_messages[][sms_account][is_enabled]	boolean	*
data.sms_messages[][sms_account][is_connected]	boolean	*
data.sms_messages[][sms_account][is_tested]	boolean	*
data.sms_messages[][sms_account][test_code]	string	*
data.sms_messages[][job]	object (Job)	*
data.sms_messages[][job][id]	integer	*	The unique job id.
data.sms_messages[][job][type]	string	*	The job type, used by the Job Router to find the right Job Processor.
data.sms_messages[][job][status]	string	*	The status of the job.
data.sms_messages[][job][status_code]	string	*	Any code to further classify the status.
data.sms_messages[][job][date_touch]	DateTime	*	Date the last time a process "touched" this ticket.
data.sms_messages[][job][date_created]	DateTime	*	Date this job entered the "jobs" table.
data.sms_messages[][job][date_last_try]	DateTime	*	Last time we processed this job.
data.sms_messages[][job][date_next_try]	DateTime	*	If this DateTime is in the future, it won't be selected for execution.
data.sms_messages[][job][num_tries]	integer	*	The number of times this job has been executed Job Processor (usually indicated failures if > 1).
data.sms_messages[][job][log_summary]	string	*	A human readable summary of the job's execution.
data.sms_messages[][job][log]	string	*	A more verbose log.
data.sms_messages[][job][data]	array	*	An array of data, or payload, that the job processor needs to execute this job (stored in the db as json). This MUST always be an array, even if its an empty array
data.sms_messages[][job][original_job]	integer	*	Null unless the job was created as a retry - if so, the originating job ID is stored here so we can query it later. Note: You MUST specify the originating job, do not create a linked list of failed jobs.
data.sms_messages[][date_created]	DateTime	*
data.sms_messages[][from_number]	string	*	Permanent record of the phone number that sent this SMS. (Won't change even if Person changes their phone number).
data.sms_messages[][to_number]	string	*	Permanent record of the phone number that this SMS was sent to.
data.sms_messages[][message]	string	*	The SMS message.
data.sms_messages[][direction]	string	*	Just a system flag for reporting.
data.topic_links[]	array of objects (TicketCommunityTopicLink)	*
data.topic_links[][id]	integer	*	The unique filter ID.
data.topic_links[][ticket]	integer id (Ticket)	*
data.topic_links[][topic]	integer id (CommunityTopic)	*
data.topic_links[][person]	integer id (Person)	*
data.topic_links[][date_created]	DateTime	*
data.custom_data[]	array of objects (CustomDataTicket)	*
data.custom_data[][ticket]	object (Ticket)	*
data.custom_data[][field]	object (CustomDefTicket)	*
data.custom_data[][field][parent]	object (CustomDefTicket)	*
data.custom_data[][field][children][]	array of objects (CustomDefTicket)	*	Field children.
data.custom_data[][field][title]		*
data.custom_data[][root_field]	object (CustomDefTicket)	*
data.sent_to_address	string	*	The email address the ticket was sent to if it came in via a gateway. This is a full string (e.g., including CC's) of the original.
data.email_account	object (EmailAccount)	*	The gateway this ticket originated from.
data.email_account[id]	integer	*
data.email_account[account_type]	string	*
data.email_account[is_enabled]	boolean	*
data.email_account[address]	string	*
data.email_account[cert_blob]	object (Blob)	*
data.email_account[cert_blob][sys_name]	string	*	A unique system name for the blob.
data.email_account[cert_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.email_account[cert_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.email_account[cert_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.email_account[cert_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.email_account[cert_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.email_account[cert_blob][file_url]	string	*	The HTTP link to download the file.
data.email_account[cert_blob][authcode]	string	*
data.email_account[cert_blob][blob_hash]	string	*
data.email_account[cert_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.email_account[cert_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.email_account[cert_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.email_account[cert_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.email_account[cert_blob][date_created]	DateTime	*
data.email_account[cert_blob][is_temp]	boolean	*
data.email_account[cert_blob][source_ref]	string	*
data.email_account[cert_blob][labels][]	array of objects (LabelBlob)	*
data.email_account[cert_blob][labels][][blob]	object (Blob)	*
data.email_account[key_blob]	object (Blob)	*
data.email_account_address	string	*	The email address (from list of to/cc) that matched with the email account.
data.creation_system	string	*
data.creation_system_option	string	*	Optional information about the creation system. For example, source URL the ticket came from.
data.ticket_hash	string	*
data.status	string	*
data.ticket_status	object (TicketStatus)	*
data.ticket_status[id]	integer	*
data.ticket_status[status_type]	string	*
data.ticket_status[status_code]	string	*
data.ticket_status[sys_id]	string	*
data.ticket_status[title]	string	*
data.ticket_status[display_order]	integer	*
data.ticket_status[pending_waiting_time_mode]	string	*	Where to count time spending in pending status. Check PENDING_WAITING_TIME_MODE_ constants
data.ticket_status[children][]	array of objects (TicketStatus)	*
data.ticket_status[options]	array	*
data.ticket_status[statusType]		*
data.ticket_status[displayOrder]	integer	*
data.urgency	integer	*
data.feedback_rating	integer	*
data.date_feedback_rating	DateTime	*
data.date_created	DateTime	*
data.date_resolved	DateTime	*
data.date_archived	DateTime	*
data.date_first_agent_assign	DateTime	*
data.date_first_agent_reply	DateTime	*
data.date_last_agent_reply	DateTime	*
data.date_last_user_reply	DateTime	*
data.date_agent_waiting	DateTime	*
data.date_user_waiting	DateTime	*
data.date_status	DateTime	*
data.date_on_hold	DateTime	*
data.total_user_waiting	integer	*
data.total_to_first_reply	integer	*
data.total_user_waiting_wh_start	DateTime	*
data.total_user_waiting_wh	integer	*
data.total_to_first_reply_wh	integer	*
data.locked_by_agent	object (Person)	*
data.date_locked	DateTime	*
data.has_attachments	boolean	*
data.original_subject	string	*
data.properties	array	*
data.count_agent_replies	integer	*
data.count_user_replies	integer	*
data.worst_sla_status	string	*
data.waiting_times	array	*	Used to track ticket status changes and how much time ticket was in status Add new item every time status changed This is optimisation over TicketLog.
data.participants[]	array of objects (TicketParticipant)	*
data.participants[][id]	integer	*
data.participants[][ticket]	object (Ticket)	*
data.participants[][person]	object (Person)	*
data.participants[][access_code]	object (TicketAccessCode)	*
data.participants[][person_email]	object (PersonEmail)	*
data.participants[][default_on]	boolean	*	Default checkbox status of the user.
data.charges[]	array of objects (TicketCharge)	*
data.charges[][id]	integer	*
data.charges[][charge_time]	integer	*
data.charges[][amount]	float	*
data.charges[][date_created]	DateTime	*
data.charges[][ticket]	object (Ticket)	*
data.charges[][person]	object (Person)	*
data.charges[][organization]	object (Organization)	*
data.charges[][agent]	object (Person)	*
data.charges[][custom_data][]	array of objects (CustomDataBilling)	*
data.charges[][custom_data][][ticket_charge]	object (TicketCharge)	*
data.charges[][custom_data][][field]	object (CustomDefBilling)	*
data.charges[][custom_data][][field][parent]	object (CustomDefBilling)	*
data.charges[][custom_data][][field][children][]	array of objects (CustomDefBilling)	*	Field children.
data.charges[][custom_data][][field][title]		*
data.charges[][custom_data][][root_field]	object (CustomDefBilling)	*
data.ticket_slas[]	array of objects (TicketSla)	*
data.ticket_slas[][id]	integer	*	The unique ID.
data.ticket_slas[][sla_status]	string	*	The SLA status.
data.ticket_slas[][warn_date]	DateTime	*	The SLA warn date.
data.ticket_slas[][fail_date]	DateTime	*	The SLA fail date.
data.ticket_slas[][is_completed]	boolean	*	Is the SLA completed?
data.ticket_slas[][is_completed_set]	boolean	*	Completed by automated action.
data.ticket_slas[][completed_time_taken]	integer	*	Time taken.
data.ticket_slas[][ticket]	integer id (Ticket)	*	Ticket.
data.ticket_slas[][sla]	integer id (Sla)	*	SLA.
data.ticket_slas[][date_applied]	DateTime	*	time and date when SLA was applied to the ticket.
data.ticket_slas[][date_completed]	DateTime	*	time when SLA status became OK.
data.jira_issues[]	array of objects (JiraIssue)	*	linked jira issues.
data.jira_issues[][id]	integer	*	The unique ID.
data.jira_issues[][ticket]	object (Ticket)	*	The associated DeskPRO ticket.
data.jira_issues[][issue_id]	integer	*
data.jira_issues[][status_id]	integer	*
data.jira_issues[][created]	DateTime	*	Export time.
data.problems[]	array of objects (Problem)	*
data.problems[][id]	integer	*	The unique ID.
data.problems[][title]	string	*	Problem title.
data.problems[][creator]	integer id (Person)	*	Person who created the problem.
data.problems[][created]	DateTime	*	Date when the problem was created.
data.problems[][is_open]	boolean	*	Is problem still has no solution?
data.problems[][tickets][]	array of integer ids (Ticket)	*	Tickets associated with problem.
data.stars[]	array of objects (TicketFlagged)	*
data.stars[][ticket]	object (Ticket)	*
data.stars[][person_id]	integer	*
data.stars[][color]	string	*
data.follow_ups[]	array of objects (TicketFollowUp)	*
data.follow_ups[][id]	integer	*	The unique ID.
data.follow_ups[][person]	integer id (Person)	*
data.follow_ups[][actions]	array	*
data.follow_ups[][cancel_if_user_reply]	boolean	*
data.follow_ups[][cancel_if_agent_reply]	boolean	*
data.follow_ups[][status]	string	*
data.follow_ups[][date_created]	DateTime	*
data.follow_ups[][date_to_run]	DateTime	*
data.follow_ups[][date_did_run]	DateTime	*
data.follow_ups[][dateToRun]		*
data.logs[]	array of objects (TicketLog)	*
data.logs[][id]	integer	*
data.logs[][parent]	object (TicketLog)	*
data.logs[][ticket]	object (Ticket)	*
data.logs[][person]	object (Person)	*
data.logs[][action_type]	string	*
data.logs[][id_object]	integer	*	If the log involves a specific thing in a ticket (eg a message that was moved), then that is this id.
data.logs[][id_before]	integer	*	The ID of the previous entity changed, or any other numeric value.
data.logs[][id_after]	integer	*	The ID of the new entity, or any other numeric value.
data.logs[][trigger_id]	integer	*	If the change was caused by a trigger, the trigger id. Note this is the integer ID (not a FK relation) so the record is kept even if the trigger itself is deleted.
data.logs[][escalation_id]	integer	*	If the change was caused by an escalation Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.logs[][macro_id]	integer	*	If the change was caused by an v2 macro Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.logs[][sla]	object (Sla)	*	If the change was caused by an SLA, the SLA.
data.logs[][sla][id]	integer	*	The unique ID.
data.logs[][sla][title]	string	*	SLA title.
data.logs[][sla][sla_type]	string	*	Type of SLA - first_response, resolution, waiting_time.
data.logs[][sla][active_time]	string	*	Whether active all the time (all) or during work hours only (work_hours) or use the default ticket-wide settings (default).
data.logs[][sla][work_start]	integer	*	When the work day starts. This is stored as the number of seconds after 00:00:00.
data.logs[][sla][work_end]	integer	*	When the work day ends. This is stored as the number of seconds after 00:00:00.
data.logs[][sla][work_days]	array	*	Array of work days, stored with keys corresponding to day numbers. Values are true. 0 = Sunday, 6 = Saturday (same as PHP, easy to convert to MySQL which is 1 = Sunday, 7 = Saturday).
data.logs[][sla][work_timezone]	string	*	Timezone for work hours/days to be considered in.
data.logs[][sla][work_holidays]	array	*	List of work holidays.
data.logs[][sla][apply_type]	string	*	Controls how the SLA is applied to tickets: all, terms, terms_before_triggers, manual.
data.logs[][sla][apply_terms]	object (TriggerTerms)	*	Conditions to apply.
data.logs[][sla][apply_terms][version]	integer	*	Terms version.
data.logs[][sla][apply_terms][terms]	array	*	Terms themselves.
data.logs[][sla][trigger_terms]	object (TriggerTerms)	*	Conditions to consider sla completed.
data.logs[][sla][warn_time]	integer	*	Warn time integer.
data.logs[][sla][warn_time_unit]	string	*	And it's unit (see warn time).
data.logs[][sla][warn_actions]	object (TriggerActions)	*	How to warn about SLA will fail.
data.logs[][sla][warn_actions][version]	integer	*	Actions version.
data.logs[][sla][warn_actions][actions]	array	*	Actions array representation.
data.logs[][sla][fail_time]	integer	*	Fail time integer.
data.logs[][sla][fail_time_unit]	string	*	And it's measuring unit (see fail_time).
data.logs[][sla][fail_actions]	object (TriggerActions)	*	What to do if SLA failed.
data.logs[][sla][exclude_ticket_statuses]	array	*	This SLA will not apply while tickets are in these pending statuses.
data.logs[][sla_status]	string	*
data.logs[][details]	array	*
data.logs[][date_created]	DateTime	*
data.chats[]	array of objects (ChatConversation)	*
data.created_with_channel	string	*
data.last_channel_used	string	*
data.channels	array	*
data.pending_articles[]	array of objects (ArticlePendingCreate)	*
data.pending_articles[][id]	integer	*
data.pending_articles[][person]	integer id (Person)	*
data.pending_articles[][assigned_person]	integer id (Person)	*
data.pending_articles[][ticket]	integer id (Ticket)	*
data.pending_articles[][message]	integer id (TicketMessage)	*
data.pending_articles[][comment]	string	*
data.pending_articles[][date_created]	DateTime	*
data.summary	object (TicketSummary)	*
data.summary[id]	integer	*
data.summary[ticket]	object (Ticket)	*
data.summary[summary]	string	*
data.summary[summary_input]	string	*
data.summary[date_created]	DateTime	*

Status Code	Description
200	Everything is OK
400	Returned if request is malformed
403	You are not allowed to edit this layout

PUT /api/v2/ticket_forms/{context}/{id}

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_forms.put_context

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
context	agent\|user	string	Ticket layout context
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format	Description
person[id]	string	false
person[name]	string	false
person[email]	string	false
person[fieldId]	string	false
person[key]	string	false
department	choice	false
subject	string	false
message[message]	string	false		Message
message[format]	choice	false	["html","text"]
message[message_source_type]	string	false
message[message_source]	string	false
attachments[][is_inline]	boolean	false
fields	string	false
brand	choice	false
labels[]	array of strings	false

Status Code	Description
200	Everything is OK
400	Returned if request is malformed
403	You are not allowed to edit this layout

GET /api/v2/ticket_labels/{label}/tickets

Get tickets with the given label

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_labels.get_tickets

Requirements
Response
Status Codes

Name	Requirement	Type	Description
label	\w	string	label to filter tickets

Parameter	Type	Versions	Description
data[]	array of objects (Ticket)	*
data[][id]	integer	*	The unique ID.
data[][ref]	string	*	String reference.
data[][auth]	string	*	Auth string.
data[][parent]	integer id (Ticket)	*	Parent of this ticket.
data[][language]	integer id (Language)	*	Language associated with this ticket.
data[][brand]	integer id (Brand)	*	Ticket brand.
data[][department]	integer id (Department)	*	Ticket where this department is processing.
data[][category]	integer id (TicketCategory)	*	Category of this ticket.
data[][priority]	integer id (TicketPriority)	*	Priority of this ticket.
data[][workflow]	integer id (TicketWorkflow)	*	Workflow entity.
data[][product]	integer id (Product)	*	Product about which this ticket.
data[][person]	integer id (Person)	*	Person created this ticket.
data[][person_email]	string representation (PersonEmail)	*	Person's email.
data[][agent]	integer id (Person)	*	Agent assigned.
data[][agent_team]	integer id (AgentTeam)	*	Agent team where this ticket is processing.
data[][organization]	integer id (Organization)	*	Organization team where this ticket is processing.
data[][linked_chat]	integer id (ChatConversation)	*	ChatConversation where this ticket is discussed.
data[][sent_to_address]	array	*	Addresses where ticket was send.
data[][email_account]	integer id (EmailAccount)	*	Email account used to gather the ticket.
data[][email_account_address]	string	*	Email account address used to gather the ticket.
data[][creation_system]	string	*	How this ticket appears.
data[][creation_system_option]	string	*	Option used by creation system.
data[][ticket_hash]	string	*	Unique hash.
data[][status]	string	<=20170400	Legacy ticket status.
data[][hidden_status]	string	<=20170400	Legacy ticket hidden status.
data[][ticket_status]	string	*	Ticket status.
data[][is_hold]	boolean	*	Is this on hold?
data[][labels][]	array of strings	*	String array of labels.
data[][urgency]	integer	*	How urgent this ticket?
data[][feedback_rating]	integer	*	Its rating based on feedback votes.
data[][date_feedback_rating]	DateTime	*	When the rating was calculated.
data[][date_created]	DateTime	*	When the ticket was created.
data[][date_resolved]	DateTime	*	When the ticket was resolved.
data[][date_archived]	DateTime	*	And archived at last.
data[][date_first_agent_assign]	DateTime	*	When it was assigned to agent at the very first time.
data[][date_first_agent_reply]	DateTime	*	When it was first time replied.
data[][date_last_agent_reply]	DateTime	*	And when it was replied the last time.
data[][date_last_user_reply]	DateTime	*	And the date user replied here last time.
data[][date_agent_waiting]	DateTime	*	Time when agent started to wait user.
data[][date_user_waiting]	DateTime	*	And the time when user started to wait agent.
data[][date_status]	DateTime	*	When status was changed.
data[][total_user_waiting]	integer	*	How much user was waited?
data[][total_to_first_reply]	integer	*	Total waiting before first reply.
data[][total_user_waiting_wh]	integer	*	Total user waiting in working hours.
data[][total_to_first_reply_wh]	integer	*	Total waiting before first reply in working hour.
data[][locked_by_agent]	integer id (Person)	*	An agent who locked the ticket.
data[][date_locked]	DateTime	*	Date time when ticket was locked.
data[][date_on_hold]	DateTime	*	Datetime when ticket was set on hold.
data[][has_attachments]	boolean	*	Does this ticket has attachments?
data[][subject]	string	*	Ticket subject.
data[][original_subject]	string	*	Original subject given by creator.
data[][properties]	array	*	Array of properties.
data[][problems][]	array of integer ids (Problem)	*	An array of associated problems.
data[][count_agent_replies]	integer	*	Count of all replies made by agents.
data[][count_user_replies]	integer	*	Count of all replies made by user.
data[][worst_sla_status]	string	*	Well, this is worst SLA status.
data[][waiting_times]	array	*	An array of waiting times.
data[][ticket_slas][]	array of integer ids (TicketSla)	*	All ticket SLAS.
data[][fields][]	dynamically declared custom fields (ticket)	*	Custom ticket fields.
data[][contextual_fields]	custom handler result for (custom_per_data)	*	Contextual ticket fields (per user/org fields).
data[][children][]	array of integer ids (Ticket)	*	Ticket children.
data[][siblings][]	array of integer ids (Ticket)	*	Ticket siblings.
data[][cc][]	array of integer ids (Person)	*	User should be acknowledged about this ticket.
data[][star]	string	*	Person star color.
data[][ticket_layout]	custom handler result for (raw)	*
data[][ticket_excerpt]	custom handler result for (raw)	*
data[][ticket_agent_errors]	custom handler result for (raw)	*
data[][ticket_user_errors]	custom handler result for (raw)	*
data[][ticket_permissions]	custom handler result for (raw)	*
data[][access_code]	string	*	Access code.
data[][followers]	string	*	Followers of that ticket as a comma-separated list of names.

Status Code	Description
200	Will be returned in case of success

GET /api/v2/ticket_layouts/{context}

Get ticket layouts

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_layouts.list

Requirements
Response
Status Codes

Name	Requirement	Type	Description
context	agent\|user	string	context for layout

Parameter	Type	Versions	Description
data[]	array of objects (TicketLayout)	*
data[][department]	integer id (Department)	*	Department uses this layout.
data[][fields][]	array of objects (LayoutField)	*	An array of fields describing layout.
data[][fields][][field_type]	string	*
data[][fields][][field_id]	string	*
data[][fields][][options]	object (LayoutFieldOptions)	*
data[][fields][][options][on_newticket]	boolean	*
data[][fields][][options][on_viewticket]	boolean	*
data[][fields][][options][on_viewticket_mode]	string	*
data[][fields][][options][on_editticket]	boolean	*
data[][fields][][options][criteria]	object (LayoutFieldCriteria)	*
data[][fields][][options][criteria][mode]	string	*
data[][fields][][options][criteria][terms][]	array of objects (LayoutFieldCriteriaTerm)	*
data[][fields][][options][criteria][terms][][type]	string	*
data[][fields][][options][criteria][terms][][op]	string	*
data[][fields][][options][criteria][terms][][options]	array	*
data[][fields][][required]	boolean	*
data[][context]	string	*	Agent or user context.

Status Code	Description
200	Returned with list of layouts

GET /api/v2/ticket_layouts/{context}.js

Get ticket layouts JS with compiled fields criteria

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_layouts.list_js

Requirements
Status Codes

Name	Requirement	Type	Description
context	agent\|user	string	context for layout

Status Code	Description
200	Returned with list of layouts

GET /api/v2/ticket_layouts/{context}/{department}

Get ticket department layout for given context

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_layouts.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
department	\d+\|default	integer\|string	department id for which you want to get layout
context	agent\|user	string	context of layout

Parameter	Type	Versions	Description
data.department	integer id (Department)	*	Department uses this layout.
data.fields[]	array of objects (LayoutField)	*	An array of fields describing layout.
data.fields[][field_type]	string	*
data.fields[][field_id]	string	*
data.fields[][options]	object (LayoutFieldOptions)	*
data.fields[][options][on_newticket]	boolean	*
data.fields[][options][on_viewticket]	boolean	*
data.fields[][options][on_viewticket_mode]	string	*
data.fields[][options][on_editticket]	boolean	*
data.fields[][options][criteria]	object (LayoutFieldCriteria)	*
data.fields[][options][criteria][mode]	string	*
data.fields[][options][criteria][terms][]	array of objects (LayoutFieldCriteriaTerm)	*
data.fields[][options][criteria][terms][][type]	string	*
data.fields[][options][criteria][terms][][op]	string	*
data.fields[][options][criteria][terms][][options]	array	*
data.fields[][required]	boolean	*
data.context	string	*	Agent or user context.

Status Code	Description
200	Returned if everything is ok
400	Returned if department wasn't found

GET /api/v2/ticket_layouts/{context}/{department}.js

Get ticket department layout JS with compiled fields criteria for given context

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_layouts.get_js

Requirements
Status Codes

Name	Requirement	Type	Description
department	\d+\|default	integer\|string	department id for which you want to get layout
context	agent\|user	string	context of layout

Status Code	Description
200	Returned if everything is ok
400	Returned if department wasn't found

GET /api/v2/ticket_lists CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.filters.ticket_lists.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (TicketList)	*
data[][id]	integer	*	The unique ID.
data[][title]	string	*	The filter`s title.
data[][query]	string	*	FQL query.
data[][is_global]	boolean	*
data[][is_enabled]	boolean	*
data[][shared_teams][]	array of integer ids (AgentTeam)	*	Specific teams to share this with.
data[][shared_agents][]	array of integer ids (Person)	*	Specific agents to share this with.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

GET /api/v2/ticket_lists/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.filters.ticket_lists.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.title	string	*	The filter`s title.
data.query	string	*	FQL query.
data.is_global	boolean	*
data.is_enabled	boolean	*
data.shared_teams[]	array of integer ids (AgentTeam)	*	Specific teams to share this with.
data.shared_agents[]	array of integer ids (Person)	*	Specific agents to share this with.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

GET /api/v2/ticket_lists/{ticketList}/tickets

get tickets for specific ticket list

GET /api/v2/ticket_logs CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_logs_all_tickets.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

action_type

Pattern	action_starter\|free\|attach_added\|attach_removed\|community_topic_link_added\|community_topic_link_removed\|followup_created\|followup_removed\|new_billing\|modify_billing\|delete_billing\|changed_person\|changed_agent\|changed_agent_team\|changed_brand\|changed_category\|changed_custom_field\|changed_department\|changed_organization\|changed_labels\|changed_language\|changed_product\|changed_workflow\|changed_slas\|changed_status\|changed_subject\|changed_problems\|changed_priority\|changed_agent_participants\|changed_user_participants\|changed_sla_status\|changed_urgency\|ticket_created\|merged_from\|parent_ticket\|children_tickets\|ticket_email\|split_to\|split_from\|ticket_sla_status\|app_message\|feedback_rating\|person_email_changed\|email_account\|task_created\|message_created\|message_edit\|message_note_status\|message_removed\|ticket_approval_details\|trigger\|webhook\|call_recording_downloaded\|call_recording_deleted
Description	Action type
Datatype	string

date_created

Description	Date created filter. You can specify a single date or a range of dates using the `--` separator.
Datatype	string
Pattern	Y-m-d\|Y-m-d--Y-m-d

Parameter	Type	Versions
data[]	array of objects (TicketLogAllTickets)	*
data[][id]	integer	*
data[][parent]	integer id (TicketLog)	*
data[][ticket]	integer id (Ticket)	*
data[][person]	integer id (Person)	*
data[][action_type]	string	*
data[][details]	array	*
data[][date_created]	DateTime	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

GET /api/v2/ticket_macros CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_macros.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (TicketMacro)	*
data[][summary][]	array of strings	*	Get macro summary.
data[][id]	integer	*	The unique ID.
data[][person]	integer id (Person)	*	The person - owner of the macro.
data[][department]	integer id (Department)	*	Department which can use the macro.
data[][title]	string	*	Title of the macro.
data[][is_enabled]	boolean	*	Is macro enabled?
data[][is_global]	boolean	*	Is macro global?
data[][actions]	array	*	Macro actions.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

GET /api/v2/ticket_macros/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_macros.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.summary[]	array of strings	*	Get macro summary.
data.id	integer	*	The unique ID.
data.person	integer id (Person)	*	The person - owner of the macro.
data.department	integer id (Department)	*	Department which can use the macro.
data.title	string	*	Title of the macro.
data.is_enabled	boolean	*	Is macro enabled?
data.is_global	boolean	*	Is macro global?
data.actions	array	*	Macro actions.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

POST /api/v2/ticket_macros/{id}/apply/{ticket}

apply macro to ticket

Documentation

Apply macro with given id to the specified ticket.

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_macros.apply_macro

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	the macro identity
ticketId	\d+	integer	the ticket identity
ticket		Ticket

Status Code	Description
204	Everything is OK
403	User is not allowed to modify the ticket
404	Ticket wasn't found Macro wasn't found

GET /api/v2/ticket_problems CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_problems.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (Problem)	*
data[][title]	string	*	Problem title.
data[][id]	integer	*	The unique ID.
data[][creator]	integer id (Person)	*	Person who created the problem.
data[][created]	DateTime	*	Date when the problem was created.
data[][is_open]	boolean	*	Is problem still has no solution?
data[][tickets][]	array of integer ids (Ticket)	*	Tickets associated with problem.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/ticket_problems CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_problems.post

Parameters
Response
Status Codes

Parameter	Type	Required?	Format	Description
title	string	true
is_open	boolean	false

Parameter	Type	Versions	Description
data.title	string	*	Problem title.
data.id	integer	*	The unique ID.
data.creator	integer id (Person)	*	Person who created the problem.
data.created	DateTime	*	Date when the problem was created.
data.is_open	boolean	*	Is problem still has no solution?
data.tickets[]	array of integer ids (Ticket)	*	Tickets associated with problem.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/ticket_problems/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_problems.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/ticket_problems/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_problems.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/ticket_problems/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_problems.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.title	string	*	Problem title.
data.id	integer	*	The unique ID.
data.creator	integer id (Person)	*	Person who created the problem.
data.created	DateTime	*	Date when the problem was created.
data.is_open	boolean	*	Is problem still has no solution?
data.tickets[]	array of integer ids (Ticket)	*	Tickets associated with problem.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/ticket_problems/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_problems.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format	Description
title	string	false
is_open	boolean	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/ticket_problems/{id}/tickets

Get tickets associated with the given problem

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_problems.get_tickets

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	problem id

Parameter	Type	Versions	Description
data[]	array of objects (Ticket)	*
data[][id]	integer	*	The unique ID.
data[][ref]	string	*	String reference.
data[][auth]	string	*	Auth string.
data[][parent]	integer id (Ticket)	*	Parent of this ticket.
data[][language]	integer id (Language)	*	Language associated with this ticket.
data[][brand]	integer id (Brand)	*	Ticket brand.
data[][department]	integer id (Department)	*	Ticket where this department is processing.
data[][category]	integer id (TicketCategory)	*	Category of this ticket.
data[][priority]	integer id (TicketPriority)	*	Priority of this ticket.
data[][workflow]	integer id (TicketWorkflow)	*	Workflow entity.
data[][product]	integer id (Product)	*	Product about which this ticket.
data[][person]	integer id (Person)	*	Person created this ticket.
data[][person_email]	string representation (PersonEmail)	*	Person's email.
data[][agent]	integer id (Person)	*	Agent assigned.
data[][agent_team]	integer id (AgentTeam)	*	Agent team where this ticket is processing.
data[][organization]	integer id (Organization)	*	Organization team where this ticket is processing.
data[][linked_chat]	integer id (ChatConversation)	*	ChatConversation where this ticket is discussed.
data[][sent_to_address]	array	*	Addresses where ticket was send.
data[][email_account]	integer id (EmailAccount)	*	Email account used to gather the ticket.
data[][email_account_address]	string	*	Email account address used to gather the ticket.
data[][creation_system]	string	*	How this ticket appears.
data[][creation_system_option]	string	*	Option used by creation system.
data[][ticket_hash]	string	*	Unique hash.
data[][status]	string	<=20170400	Legacy ticket status.
data[][hidden_status]	string	<=20170400	Legacy ticket hidden status.
data[][ticket_status]	string	*	Ticket status.
data[][is_hold]	boolean	*	Is this on hold?
data[][labels][]	array of strings	*	String array of labels.
data[][urgency]	integer	*	How urgent this ticket?
data[][feedback_rating]	integer	*	Its rating based on feedback votes.
data[][date_feedback_rating]	DateTime	*	When the rating was calculated.
data[][date_created]	DateTime	*	When the ticket was created.
data[][date_resolved]	DateTime	*	When the ticket was resolved.
data[][date_archived]	DateTime	*	And archived at last.
data[][date_first_agent_assign]	DateTime	*	When it was assigned to agent at the very first time.
data[][date_first_agent_reply]	DateTime	*	When it was first time replied.
data[][date_last_agent_reply]	DateTime	*	And when it was replied the last time.
data[][date_last_user_reply]	DateTime	*	And the date user replied here last time.
data[][date_agent_waiting]	DateTime	*	Time when agent started to wait user.
data[][date_user_waiting]	DateTime	*	And the time when user started to wait agent.
data[][date_status]	DateTime	*	When status was changed.
data[][total_user_waiting]	integer	*	How much user was waited?
data[][total_to_first_reply]	integer	*	Total waiting before first reply.
data[][total_user_waiting_wh]	integer	*	Total user waiting in working hours.
data[][total_to_first_reply_wh]	integer	*	Total waiting before first reply in working hour.
data[][locked_by_agent]	integer id (Person)	*	An agent who locked the ticket.
data[][date_locked]	DateTime	*	Date time when ticket was locked.
data[][date_on_hold]	DateTime	*	Datetime when ticket was set on hold.
data[][has_attachments]	boolean	*	Does this ticket has attachments?
data[][subject]	string	*	Ticket subject.
data[][original_subject]	string	*	Original subject given by creator.
data[][properties]	array	*	Array of properties.
data[][problems][]	array of integer ids (Problem)	*	An array of associated problems.
data[][count_agent_replies]	integer	*	Count of all replies made by agents.
data[][count_user_replies]	integer	*	Count of all replies made by user.
data[][worst_sla_status]	string	*	Well, this is worst SLA status.
data[][waiting_times]	array	*	An array of waiting times.
data[][ticket_slas][]	array of integer ids (TicketSla)	*	All ticket SLAS.
data[][fields][]	dynamically declared custom fields (ticket)	*	Custom ticket fields.
data[][contextual_fields]	custom handler result for (custom_per_data)	*	Contextual ticket fields (per user/org fields).
data[][children][]	array of integer ids (Ticket)	*	Ticket children.
data[][siblings][]	array of integer ids (Ticket)	*	Ticket siblings.
data[][cc][]	array of integer ids (Person)	*	User should be acknowledged about this ticket.
data[][star]	string	*	Person star color.
data[][ticket_layout]	custom handler result for (raw)	*
data[][ticket_excerpt]	custom handler result for (raw)	*
data[][ticket_agent_errors]	custom handler result for (raw)	*
data[][ticket_user_errors]	custom handler result for (raw)	*
data[][ticket_permissions]	custom handler result for (raw)	*
data[][access_code]	string	*	Access code.
data[][followers]	string	*	Followers of that ticket as a comma-separated list of names.

Status Code	Description
200	Returned if success

GET /api/v2/ticket_stars

get a list of ticket stars

Documentation

Get a list of ticket stars.

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_stars.list

Response
Status Codes

Parameter	Type	Versions	Description
data[]	array of objects (TicketStar)	*
data[][id]	integer	*	Star id.
data[][name]	string	*	Star name.
data[][color]	string	*	Star color.
data[][hex]	string	*	Hex color representation.

Status Code	Description
200	Returned if everything is ok

GET /api/v2/ticket_stars/counts

Get the counts of tickets marked with each star

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_stars.get_ticket_stars_counts

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if success

PUT /api/v2/ticket_stars/{id}

Update ticket star name

Documentation

Update a ticket star name.

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_stars.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	the id of star to update
name	\w	string	the name of star to set

Parameter	Type	Required?	Format	Description
name	string	false

Status Code	Description
204	If update was successful
400	If you provided wrong formed request

GET /api/v2/ticket_stars/{star}/tickets

Get the tickets for a star

Documentation

Fetch a list of tickets starred with provided star.

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_stars.get_tickets

Requirements
Response
Status Codes

Name	Requirement	Type	Description
star	\d+	integer	the id of star to filter by

Parameter	Type	Versions	Description
data[]	array of objects (Ticket)	*
data[][id]	integer	*	The unique ID.
data[][ref]	string	*	String reference.
data[][auth]	string	*	Auth string.
data[][parent]	integer id (Ticket)	*	Parent of this ticket.
data[][language]	integer id (Language)	*	Language associated with this ticket.
data[][brand]	integer id (Brand)	*	Ticket brand.
data[][department]	integer id (Department)	*	Ticket where this department is processing.
data[][category]	integer id (TicketCategory)	*	Category of this ticket.
data[][priority]	integer id (TicketPriority)	*	Priority of this ticket.
data[][workflow]	integer id (TicketWorkflow)	*	Workflow entity.
data[][product]	integer id (Product)	*	Product about which this ticket.
data[][person]	integer id (Person)	*	Person created this ticket.
data[][person_email]	string representation (PersonEmail)	*	Person's email.
data[][agent]	integer id (Person)	*	Agent assigned.
data[][agent_team]	integer id (AgentTeam)	*	Agent team where this ticket is processing.
data[][organization]	integer id (Organization)	*	Organization team where this ticket is processing.
data[][linked_chat]	integer id (ChatConversation)	*	ChatConversation where this ticket is discussed.
data[][sent_to_address]	array	*	Addresses where ticket was send.
data[][email_account]	integer id (EmailAccount)	*	Email account used to gather the ticket.
data[][email_account_address]	string	*	Email account address used to gather the ticket.
data[][creation_system]	string	*	How this ticket appears.
data[][creation_system_option]	string	*	Option used by creation system.
data[][ticket_hash]	string	*	Unique hash.
data[][status]	string	<=20170400	Legacy ticket status.
data[][hidden_status]	string	<=20170400	Legacy ticket hidden status.
data[][ticket_status]	string	*	Ticket status.
data[][is_hold]	boolean	*	Is this on hold?
data[][labels][]	array of strings	*	String array of labels.
data[][urgency]	integer	*	How urgent this ticket?
data[][feedback_rating]	integer	*	Its rating based on feedback votes.
data[][date_feedback_rating]	DateTime	*	When the rating was calculated.
data[][date_created]	DateTime	*	When the ticket was created.
data[][date_resolved]	DateTime	*	When the ticket was resolved.
data[][date_archived]	DateTime	*	And archived at last.
data[][date_first_agent_assign]	DateTime	*	When it was assigned to agent at the very first time.
data[][date_first_agent_reply]	DateTime	*	When it was first time replied.
data[][date_last_agent_reply]	DateTime	*	And when it was replied the last time.
data[][date_last_user_reply]	DateTime	*	And the date user replied here last time.
data[][date_agent_waiting]	DateTime	*	Time when agent started to wait user.
data[][date_user_waiting]	DateTime	*	And the time when user started to wait agent.
data[][date_status]	DateTime	*	When status was changed.
data[][total_user_waiting]	integer	*	How much user was waited?
data[][total_to_first_reply]	integer	*	Total waiting before first reply.
data[][total_user_waiting_wh]	integer	*	Total user waiting in working hours.
data[][total_to_first_reply_wh]	integer	*	Total waiting before first reply in working hour.
data[][locked_by_agent]	integer id (Person)	*	An agent who locked the ticket.
data[][date_locked]	DateTime	*	Date time when ticket was locked.
data[][date_on_hold]	DateTime	*	Datetime when ticket was set on hold.
data[][has_attachments]	boolean	*	Does this ticket has attachments?
data[][subject]	string	*	Ticket subject.
data[][original_subject]	string	*	Original subject given by creator.
data[][properties]	array	*	Array of properties.
data[][problems][]	array of integer ids (Problem)	*	An array of associated problems.
data[][count_agent_replies]	integer	*	Count of all replies made by agents.
data[][count_user_replies]	integer	*	Count of all replies made by user.
data[][worst_sla_status]	string	*	Well, this is worst SLA status.
data[][waiting_times]	array	*	An array of waiting times.
data[][ticket_slas][]	array of integer ids (TicketSla)	*	All ticket SLAS.
data[][fields][]	dynamically declared custom fields (ticket)	*	Custom ticket fields.
data[][contextual_fields]	custom handler result for (custom_per_data)	*	Contextual ticket fields (per user/org fields).
data[][children][]	array of integer ids (Ticket)	*	Ticket children.
data[][siblings][]	array of integer ids (Ticket)	*	Ticket siblings.
data[][cc][]	array of integer ids (Person)	*	User should be acknowledged about this ticket.
data[][star]	string	*	Person star color.
data[][ticket_layout]	custom handler result for (raw)	*
data[][ticket_excerpt]	custom handler result for (raw)	*
data[][ticket_agent_errors]	custom handler result for (raw)	*
data[][ticket_user_errors]	custom handler result for (raw)	*
data[][ticket_permissions]	custom handler result for (raw)	*
data[][access_code]	string	*	Access code.
data[][followers]	string	*	Followers of that ticket as a comma-separated list of names.

Status Code	Description
200	Returned if success

GET /api/v2/ticket_statuses CRUD

Get list of hidden and custom ticket statuses

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_statuses.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

status_type

Pattern	pending\|awaiting_agent\|awaiting_user\|resolved
Description	Filter by status type
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (TicketStatus)	*
data[][statusType]		*
data[][title]	string	*
data[][displayOrder]	integer	*
data[][id]	integer	*
data[][status_type]	string	*
data[][status_code]	string	*
data[][sys_id]	string	*
data[][display_order]	integer	*
data[][pending_waiting_time_mode]	string	*	Where to count time spending in pending status. Check PENDING_WAITING_TIME_MODE_ constants
data[][children][]	array of objects (TicketStatus)	*
data[][children][][id]	integer	*
data[][children][][status_type]	string	*
data[][children][][status_code]	string	*
data[][children][][sys_id]	string	*
data[][children][][title]	string	*
data[][children][][display_order]	integer	*
data[][children][][pending_waiting_time_mode]	string	*	Where to count time spending in pending status. Check PENDING_WAITING_TIME_MODE_ constants
data[][children][][children][]	array of objects (TicketStatus)	*
data[][children][][options]	array	*
data[][options]	array	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/ticket_statuses CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_statuses.post

Parameters
Response
Status Codes

Parameter	Type	Required?	Format
status_type	choice	true	["awaiting_agent","awaiting_user","pending","resolved"]
sys_id	string	false
title	string	true
parent	choice	false
display_order	integer	false
pending_waiting_time_mode	choice	true	["agent","user","none"]

Parameter	Type	Versions	Description
data.statusType		*
data.title	string	*
data.displayOrder	integer	*
data.id	integer	*
data.status_type	string	*
data.status_code	string	*
data.sys_id	string	*
data.display_order	integer	*
data.pending_waiting_time_mode	string	*	Where to count time spending in pending status. Check PENDING_WAITING_TIME_MODE_ constants
data.children[]	array of objects (TicketStatus)	*
data.children[][id]	integer	*
data.children[][status_type]	string	*
data.children[][status_code]	string	*
data.children[][sys_id]	string	*
data.children[][title]	string	*
data.children[][display_order]	integer	*
data.children[][pending_waiting_time_mode]	string	*	Where to count time spending in pending status. Check PENDING_WAITING_TIME_MODE_ constants
data.children[][children][]	array of objects (TicketStatus)	*
data.children[][options]	array	*
data.children[][statusType]		*
data.children[][displayOrder]	integer	*
data.options	array	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/ticket_statuses/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_statuses.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/ticket_statuses/deleted/purge CRUD

Purge deleted tickets manually

DELETE /api/v2/ticket_statuses/spam/purge CRUD

Purge spam tickets manually

DELETE /api/v2/ticket_statuses/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_statuses.delete

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+\|.*?	integer\|string	The id of the resource

Parameter	Type	Required?	Format	Description
	string	false		Set to new status instead of deleted

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/ticket_statuses/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_statuses.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+\|.*?	integer\|string	The id of the resource

Parameter	Type	Versions	Description
data.statusType		*
data.title	string	*
data.displayOrder	integer	*
data.id	integer	*
data.status_type	string	*
data.status_code	string	*
data.sys_id	string	*
data.display_order	integer	*
data.pending_waiting_time_mode	string	*	Where to count time spending in pending status. Check PENDING_WAITING_TIME_MODE_ constants
data.children[]	array of objects (TicketStatus)	*
data.children[][id]	integer	*
data.children[][status_type]	string	*
data.children[][status_code]	string	*
data.children[][sys_id]	string	*
data.children[][title]	string	*
data.children[][display_order]	integer	*
data.children[][pending_waiting_time_mode]	string	*	Where to count time spending in pending status. Check PENDING_WAITING_TIME_MODE_ constants
data.children[][children][]	array of objects (TicketStatus)	*
data.children[][options]	array	*
data.children[][statusType]		*
data.children[][displayOrder]	integer	*
data.options	array	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/ticket_statuses/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_statuses.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format
status_type	choice	false	["awaiting_agent","awaiting_user","pending","resolved"]
sys_id	string	false
title	string	false
parent	choice	false
display_order	integer	false
pending_waiting_time_mode	choice	false	["agent","user","none"]

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/tickets

Get a list of tickets (see parameters description for additional information)

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.tickets.list

Filters
Response
Status Codes

Name

Information

order_by

Description	tickets list sort
Pattern	id\|urgency\|date_created\|date_status\|date_last_agent_reply\|date_last_user_reply\|date_last_reply\|date_user_waiting\|total_user_waiting\|subject\|status
Datatype	string

ids

Description	ticket list to fetch, comma separated list
Datatype	string
Pattern	[\d+,]+

group_sort

Description	tickets list sort order
Datatype	string
Pattern	asc\|desc

page

Description	pagination page parameter
Datatype	integer
Pattern	\d+

count

Description	pagination results per page parameter.
Datatype	integer
Pattern	\d+

filter

Description	TicketFilter ID option
Datatype	integer
Pattern	\d+

labels

Description	labels filter option
Datatype	array
Pattern	[\w+,]+

star

Description	star filter
Datatype	integer
Pattern	\d+

status

Description	status filter
Datatype	integer
Pattern	[\w+]

not_status

Description	not status filter
Datatype	integer
Pattern	[\w+]

date_status

Description	date status filter
Datatype	string
Pattern	[\w+]

date_created

Description	date created filter
Datatype	string
Pattern	[\w+]

date_resolved

Description	date resolved filter
Datatype	string
Pattern	[\w+]

date_last_agent_reply

Description	date last agent reply filter
Datatype	string
Pattern	[\w+]

date_last_user_reply

Description	date last user reply filter
Datatype	string
Pattern	[\w+]

agent

Description	agent filter
Datatype	integer
Pattern	\d+

person

Description	person filter
Datatype	integer
Pattern	\d+

language

Description	language filter
Datatype	integer
Pattern	\d+

organization

Description	organization filter
Datatype	integer
Pattern	\d+

problem

Description	problem filter
Datatype	integer
Pattern	\d+

department

Description	department filter
Datatype	integer
Pattern	\d+

category

Description	category filter
Datatype	integer
Pattern	\d+

sla

Description	sla id filter
Datatype	integer
Pattern	\d+

sla_status

Description	sla status filter
Datatype	integer
Pattern	ok\|warning\|fail

ticket_field.{id}

Description	\n * Custom ticket field filter. To filter by a custom field with ID=1 you need to add\n * ?ticket_field.1=value to the query string
Datatype	string
Pattern	\d+\|\w+

brand

Description	brand filter
Datatype	integer
Pattern	\d+

Parameter	Type	Versions	Description
data[]	array of objects (Ticket)	*
data[][id]	integer	*	The unique ID.
data[][ref]	string	*	String reference.
data[][auth]	string	*	Auth string.
data[][parent]	integer id (Ticket)	*	Parent of this ticket.
data[][language]	integer id (Language)	*	Language associated with this ticket.
data[][brand]	integer id (Brand)	*	Ticket brand.
data[][department]	integer id (Department)	*	Ticket where this department is processing.
data[][category]	integer id (TicketCategory)	*	Category of this ticket.
data[][priority]	integer id (TicketPriority)	*	Priority of this ticket.
data[][workflow]	integer id (TicketWorkflow)	*	Workflow entity.
data[][product]	integer id (Product)	*	Product about which this ticket.
data[][person]	integer id (Person)	*	Person created this ticket.
data[][person_email]	string representation (PersonEmail)	*	Person's email.
data[][agent]	integer id (Person)	*	Agent assigned.
data[][agent_team]	integer id (AgentTeam)	*	Agent team where this ticket is processing.
data[][organization]	integer id (Organization)	*	Organization team where this ticket is processing.
data[][linked_chat]	integer id (ChatConversation)	*	ChatConversation where this ticket is discussed.
data[][sent_to_address]	array	*	Addresses where ticket was send.
data[][email_account]	integer id (EmailAccount)	*	Email account used to gather the ticket.
data[][email_account_address]	string	*	Email account address used to gather the ticket.
data[][creation_system]	string	*	How this ticket appears.
data[][creation_system_option]	string	*	Option used by creation system.
data[][ticket_hash]	string	*	Unique hash.
data[][status]	string	<=20170400	Legacy ticket status.
data[][hidden_status]	string	<=20170400	Legacy ticket hidden status.
data[][ticket_status]	string	*	Ticket status.
data[][is_hold]	boolean	*	Is this on hold?
data[][labels][]	array of strings	*	String array of labels.
data[][urgency]	integer	*	How urgent this ticket?
data[][feedback_rating]	integer	*	Its rating based on feedback votes.
data[][date_feedback_rating]	DateTime	*	When the rating was calculated.
data[][date_created]	DateTime	*	When the ticket was created.
data[][date_resolved]	DateTime	*	When the ticket was resolved.
data[][date_archived]	DateTime	*	And archived at last.
data[][date_first_agent_assign]	DateTime	*	When it was assigned to agent at the very first time.
data[][date_first_agent_reply]	DateTime	*	When it was first time replied.
data[][date_last_agent_reply]	DateTime	*	And when it was replied the last time.
data[][date_last_user_reply]	DateTime	*	And the date user replied here last time.
data[][date_agent_waiting]	DateTime	*	Time when agent started to wait user.
data[][date_user_waiting]	DateTime	*	And the time when user started to wait agent.
data[][date_status]	DateTime	*	When status was changed.
data[][total_user_waiting]	integer	*	How much user was waited?
data[][total_to_first_reply]	integer	*	Total waiting before first reply.
data[][total_user_waiting_wh]	integer	*	Total user waiting in working hours.
data[][total_to_first_reply_wh]	integer	*	Total waiting before first reply in working hour.
data[][locked_by_agent]	integer id (Person)	*	An agent who locked the ticket.
data[][date_locked]	DateTime	*	Date time when ticket was locked.
data[][date_on_hold]	DateTime	*	Datetime when ticket was set on hold.
data[][has_attachments]	boolean	*	Does this ticket has attachments?
data[][subject]	string	*	Ticket subject.
data[][original_subject]	string	*	Original subject given by creator.
data[][properties]	array	*	Array of properties.
data[][problems][]	array of integer ids (Problem)	*	An array of associated problems.
data[][count_agent_replies]	integer	*	Count of all replies made by agents.
data[][count_user_replies]	integer	*	Count of all replies made by user.
data[][worst_sla_status]	string	*	Well, this is worst SLA status.
data[][waiting_times]	array	*	An array of waiting times.
data[][ticket_slas][]	array of integer ids (TicketSla)	*	All ticket SLAS.
data[][fields][]	dynamically declared custom fields (ticket)	*	Custom ticket fields.
data[][contextual_fields]	custom handler result for (custom_per_data)	*	Contextual ticket fields (per user/org fields).
data[][children][]	array of integer ids (Ticket)	*	Ticket children.
data[][siblings][]	array of integer ids (Ticket)	*	Ticket siblings.
data[][cc][]	array of integer ids (Person)	*	User should be acknowledged about this ticket.
data[][star]	string	*	Person star color.
data[][ticket_layout]	custom handler result for (raw)	*
data[][ticket_excerpt]	custom handler result for (raw)	*
data[][ticket_agent_errors]	custom handler result for (raw)	*
data[][ticket_user_errors]	custom handler result for (raw)	*
data[][ticket_permissions]	custom handler result for (raw)	*
data[][access_code]	string	*	Access code.
data[][followers]	string	*	Followers of that ticket as a comma-separated list of names.

Status Code	Description
200	Returned if everything is OK
400	You request was malformed

POST /api/v2/tickets CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.tickets.post

Parameters
Response
Status Codes

Parameter	Type	Required?	Format	Description
subject	string	true
department	choice	true
parent	choice	true
children[]	array of choices	true
language	choice	true
person[id]	string	false
person[name]	string	false
person[email]	string	false
person[fieldId]	string	false
person[key]	string	false
agent[id]	string	false
agent[name]	string	false
agent[email]	string	false
agent[fieldId]	string	false
agent[key]	string	false
agent_team	choice	true
organization	choice	true
status	choice	true	["live","awaiting_agent","awaiting_agent.4","awaiting_user","awaiting_user.3","pending","pending.5","resolved","resolved.6","archived","hidden","hidden.1","hidden.2"]
is_hold	boolean	true
urgency	float	true
labels[]	array of strings	true
cc[][person][id]	string	false
cc[][person][name]	string	false
cc[][person][email]	string	false
cc[][person][fieldId]	string	false
cc[][person][key]	string	false
cc[][person_email]	string	true
fields[1][mode]	string	false
fields[1][criteria]	string	false
fields[1][data]	choice	true
fields[5][mode]	string	false
fields[5][criteria]	string	false
fields[5][data]	string	true
fields[6][mode]	string	false
fields[6][criteria]	string	false
fields[6][data]	string	true
fields[7][mode]	string	false
fields[7][criteria]	string	false
fields[7][data][]	array of choices	true
fields[11][mode]	string	false
fields[11][criteria]	string	false
fields[11][data]	date	true	yyyy-MM-dd
fields[12][mode]	string	false
fields[12][criteria]	string	false
fields[12][data]	choice	true
fields[19][mode]	string	false
fields[19][criteria]	string	false
fields[19][data][]	array of choices	true
fields[24][mode]	string	false
fields[24][criteria]	string	false
fields[24][data]	choice	true
fields[31][mode]	string	false
fields[31][criteria]	string	false
fields[31][data][]	array of choices	true
fields[36][mode]	string	false
fields[36][criteria]	string	false
fields[36][data]	choice	true
fields[45][mode]	string	false
fields[45][criteria]	string	false
fields[45][data]	datetime	true	yyyy-MM-dd'T'HH:mm:ss
fields[46][mode]	string	false
fields[46][criteria]	string	false
fields[46][data]	string	false
fields[47][mode]	string	false
fields[47][criteria]	string	false
fields[47][data]	string	false
fields[48][mode]	string	false
fields[48][criteria]	string	false
fields[48][data]	string	true
fields[49][mode]	string	false
fields[49][criteria]	string	false
fields[50][mode]	string	false
fields[50][criteria]	string	false
fields[51][mode]	string	false
fields[51][criteria]	string	false
fields[51][data]	choice	false	[-10,-9,-8,-7,-6,-5,-4,-3,-2,-1,0,1,2,3,4,5,6,7,8,9,10]
fields[52][mode]	string	false
fields[52][criteria]	string	false
fields[52][data]	string	true
fields[53][mode]	string	false
fields[53][criteria]	string	false
fields[53][data]	boolean	true
fields[54][mode]	string	false
fields[54][criteria]	string	false
fields[54][data][]	array of choices	true
fields[62][mode]	string	false
fields[62][criteria]	string	false
fields[62][data]	string	true
fields[63][mode]	string	false
fields[63][criteria]	string	false
fields[63][data][]	array of choices	true
star[color]	choice	true	{"1":"blue","2":"green","3":"orange","4":"pink","5":"purple","6":"red","7":"yellow"}
summary[summary]	string	true
summary[summaryInput]	string	true
date_created	datetime	false	yyyy-MM-dd'T'HH:mm:ss
context	choice	true	["agent","user"]
add_charge_time	float	true
macros[]	array of choices	false
date_feedback_rating	datetime	false	yyyy-MM-dd'T'HH:mm:ss
date_resolved	datetime	false	yyyy-MM-dd'T'HH:mm:ss
date_archived	datetime	false	yyyy-MM-dd'T'HH:mm:ss
date_first_agent_assign	datetime	false	yyyy-MM-dd'T'HH:mm:ss
date_first_agent_reply	datetime	false	yyyy-MM-dd'T'HH:mm:ss
date_last_agent_reply	datetime	false	yyyy-MM-dd'T'HH:mm:ss
date_last_user_reply	datetime	false	yyyy-MM-dd'T'HH:mm:ss
date_agent_waiting	datetime	false	yyyy-MM-dd'T'HH:mm:ss
date_user_waiting	datetime	false	yyyy-MM-dd'T'HH:mm:ss
date_status	datetime	false	yyyy-MM-dd'T'HH:mm:ss
date_on_hold	datetime	false	yyyy-MM-dd'T'HH:mm:ss
date_locked	datetime	false	yyyy-MM-dd'T'HH:mm:ss
total_user_waiting	integer	false
total_to_first_reply	integer	false
message[message]	string	true		Message
message[primary_translation][message]	string	true
message[primary_translation][from_language]	string	false
message[primary_translation][language]	string	true
message[person][id]	string	false
message[person][name]	string	false
message[person][email]	string	false
message[person][fieldId]	string	false
message[person][key]	string	false
message[format]	choice	true	["html","text"]
message[message_source_type]	string	false
message[message_source]	string	false
message[is_note]	boolean	true
message[attachments][][is_inline]	boolean	false
message[status]	choice	false	["live","awaiting_agent","awaiting_agent.4","awaiting_user","awaiting_user.3","pending","pending.5","resolved","resolved.6","archived","hidden","hidden.1","hidden.2"]
message[macros][]	array of choices	false
message[snippets][]	array of choices	false
message[date_created]	datetime	false	yyyy-MM-dd'T'HH:mm:ss
messages[][message]	string	true		Message
messages[][primary_translation][message]	string	true
messages[][primary_translation][from_language]	string	false
messages[][primary_translation][language]	string	true
messages[][format]	choice	true	["html","text"]
messages[][message_source_type]	string	false
messages[][message_source]	string	false
messages[][is_note]	boolean	true
messages[][attachments][][is_inline]	boolean	false
messages[][date_created]	datetime	false	yyyy-MM-dd'T'HH:mm:ss
brand	choice	false

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.ref	string	*	String reference.
data.auth	string	*	Auth string.
data.parent	integer id (Ticket)	*	Parent of this ticket.
data.language	integer id (Language)	*	Language associated with this ticket.
data.brand	integer id (Brand)	*	Ticket brand.
data.department	integer id (Department)	*	Ticket where this department is processing.
data.category	integer id (TicketCategory)	*	Category of this ticket.
data.priority	integer id (TicketPriority)	*	Priority of this ticket.
data.workflow	integer id (TicketWorkflow)	*	Workflow entity.
data.product	integer id (Product)	*	Product about which this ticket.
data.person	integer id (Person)	*	Person created this ticket.
data.person_email	string representation (PersonEmail)	*	Person's email.
data.agent	integer id (Person)	*	Agent assigned.
data.agent_team	integer id (AgentTeam)	*	Agent team where this ticket is processing.
data.organization	integer id (Organization)	*	Organization team where this ticket is processing.
data.linked_chat	integer id (ChatConversation)	*	ChatConversation where this ticket is discussed.
data.sent_to_address	array	*	Addresses where ticket was send.
data.email_account	integer id (EmailAccount)	*	Email account used to gather the ticket.
data.email_account_address	string	*	Email account address used to gather the ticket.
data.creation_system	string	*	How this ticket appears.
data.creation_system_option	string	*	Option used by creation system.
data.ticket_hash	string	*	Unique hash.
data.status	string	<=20170400	Legacy ticket status.
data.hidden_status	string	<=20170400	Legacy ticket hidden status.
data.ticket_status	string	*	Ticket status.
data.is_hold	boolean	*	Is this on hold?
data.labels[]	array of strings	*	String array of labels.
data.urgency	integer	*	How urgent this ticket?
data.feedback_rating	integer	*	Its rating based on feedback votes.
data.date_feedback_rating	DateTime	*	When the rating was calculated.
data.date_created	DateTime	*	When the ticket was created.
data.date_resolved	DateTime	*	When the ticket was resolved.
data.date_archived	DateTime	*	And archived at last.
data.date_first_agent_assign	DateTime	*	When it was assigned to agent at the very first time.
data.date_first_agent_reply	DateTime	*	When it was first time replied.
data.date_last_agent_reply	DateTime	*	And when it was replied the last time.
data.date_last_user_reply	DateTime	*	And the date user replied here last time.
data.date_agent_waiting	DateTime	*	Time when agent started to wait user.
data.date_user_waiting	DateTime	*	And the time when user started to wait agent.
data.date_status	DateTime	*	When status was changed.
data.total_user_waiting	integer	*	How much user was waited?
data.total_to_first_reply	integer	*	Total waiting before first reply.
data.total_user_waiting_wh	integer	*	Total user waiting in working hours.
data.total_to_first_reply_wh	integer	*	Total waiting before first reply in working hour.
data.locked_by_agent	integer id (Person)	*	An agent who locked the ticket.
data.date_locked	DateTime	*	Date time when ticket was locked.
data.date_on_hold	DateTime	*	Datetime when ticket was set on hold.
data.has_attachments	boolean	*	Does this ticket has attachments?
data.subject	string	*	Ticket subject.
data.original_subject	string	*	Original subject given by creator.
data.properties	array	*	Array of properties.
data.problems[]	array of integer ids (Problem)	*	An array of associated problems.
data.count_agent_replies	integer	*	Count of all replies made by agents.
data.count_user_replies	integer	*	Count of all replies made by user.
data.worst_sla_status	string	*	Well, this is worst SLA status.
data.waiting_times	array	*	An array of waiting times.
data.ticket_slas[]	array of integer ids (TicketSla)	*	All ticket SLAS.
data.fields[]	dynamically declared custom fields (ticket)	*	Custom ticket fields.
data.contextual_fields	custom handler result for (custom_per_data)	*	Contextual ticket fields (per user/org fields).
data.children[]	array of integer ids (Ticket)	*	Ticket children.
data.siblings[]	array of integer ids (Ticket)	*	Ticket siblings.
data.cc[]	array of integer ids (Person)	*	User should be acknowledged about this ticket.
data.star	string	*	Person star color.
data.ticket_layout	custom handler result for (raw)	*
data.ticket_excerpt	custom handler result for (raw)	*
data.ticket_agent_errors	custom handler result for (raw)	*
data.ticket_user_errors	custom handler result for (raw)	*
data.ticket_permissions	custom handler result for (raw)	*
data.access_code	string	*	Access code.
data.followers	string	*	Followers of that ticket as a comma-separated list of names.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/tickets/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.tickets.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

GET /api/v2/tickets/ids

Get a list of tickets (see parameters description for additional information)

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.tickets.list_ids

Filters
Status Codes

Name

Information

order_by

Description	tickets list sort
Pattern	id\|urgency\|date_created\|date_last_agent_reply\|date_last_user_reply\|date_last_reply\|date_user_waiting\|total_user_waiting\|subject\|status
Datatype	string

ids

Description	ticket list to fetch, comma separated list
Datatype	string
Pattern	[\d+,]+

order_dir

Description	tickets list sort order
Datatype	string
Pattern	asc\|desc

page

Description	pagination page parameter
Datatype	integer
Pattern	\d+

count

Description	pagination results per page parameter.
Datatype	integer
Pattern	\d+

filter

Description	TicketFilter ID option
Datatype	integer
Pattern	\d+

labels

Description	labels filter option
Datatype	array
Pattern	[\w+,]+

star

Description	star filter
Datatype	integer
Pattern	\d+

status

Description	status filter
Datatype	integer
Pattern	[\w+]

not_status

Description	not status filter
Datatype	integer
Pattern	[\w+]

date_created

Description	date created filter
Datatype	string
Pattern	[\w+]

date_resolved

Description	date resolved filter
Datatype	string
Pattern	[\w+]

date_last_agent_reply

Description	date last agent reply filter
Datatype	string
Pattern	[\w+]

date_last_user_reply

Description	date last user reply filter
Datatype	string
Pattern	[\w+]

agent

Description	agent filter
Datatype	integer
Pattern	\d+

person

Description	person filter
Datatype	integer
Pattern	\d+

language

Description	language filter
Datatype	integer
Pattern	\d+

organization

Description	organization filter
Datatype	integer
Pattern	\d+

problem

Description	problem filter
Datatype	integer
Pattern	\d+

department

Description	department filter
Datatype	integer
Pattern	\d+

sla

Description	sla id filter
Datatype	integer
Pattern	\d+

sla_status

Description	sla status filter
Datatype	integer
Pattern	ok\|warning\|fail

ticket_field.{id}

Description	\n * Custom ticket field filter. To filter by a custom field with ID=1 you need to add\n * ?ticket_field.1=value to the query string
Datatype	string
Pattern	\d+\|\w+

brand

Description	brand filter
Datatype	integer
Pattern	\d+

Status Code	Description
200	Returned if everything is OK
400	You request was malformed

DELETE /api/v2/tickets/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.tickets.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	ref:[\w\-\.]+\|\d+	integer\|string	The id\|ref of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/tickets/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.tickets.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	ref:[\w\-\.]+\|\d+	integer\|string	The id\|ref of the resource

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.ref	string	*	String reference.
data.auth	string	*	Auth string.
data.parent	integer id (Ticket)	*	Parent of this ticket.
data.language	integer id (Language)	*	Language associated with this ticket.
data.brand	integer id (Brand)	*	Ticket brand.
data.department	integer id (Department)	*	Ticket where this department is processing.
data.category	integer id (TicketCategory)	*	Category of this ticket.
data.priority	integer id (TicketPriority)	*	Priority of this ticket.
data.workflow	integer id (TicketWorkflow)	*	Workflow entity.
data.product	integer id (Product)	*	Product about which this ticket.
data.person	integer id (Person)	*	Person created this ticket.
data.person_email	string representation (PersonEmail)	*	Person's email.
data.agent	integer id (Person)	*	Agent assigned.
data.agent_team	integer id (AgentTeam)	*	Agent team where this ticket is processing.
data.organization	integer id (Organization)	*	Organization team where this ticket is processing.
data.linked_chat	integer id (ChatConversation)	*	ChatConversation where this ticket is discussed.
data.sent_to_address	array	*	Addresses where ticket was send.
data.email_account	integer id (EmailAccount)	*	Email account used to gather the ticket.
data.email_account_address	string	*	Email account address used to gather the ticket.
data.creation_system	string	*	How this ticket appears.
data.creation_system_option	string	*	Option used by creation system.
data.ticket_hash	string	*	Unique hash.
data.status	string	<=20170400	Legacy ticket status.
data.hidden_status	string	<=20170400	Legacy ticket hidden status.
data.ticket_status	string	*	Ticket status.
data.is_hold	boolean	*	Is this on hold?
data.labels[]	array of strings	*	String array of labels.
data.urgency	integer	*	How urgent this ticket?
data.feedback_rating	integer	*	Its rating based on feedback votes.
data.date_feedback_rating	DateTime	*	When the rating was calculated.
data.date_created	DateTime	*	When the ticket was created.
data.date_resolved	DateTime	*	When the ticket was resolved.
data.date_archived	DateTime	*	And archived at last.
data.date_first_agent_assign	DateTime	*	When it was assigned to agent at the very first time.
data.date_first_agent_reply	DateTime	*	When it was first time replied.
data.date_last_agent_reply	DateTime	*	And when it was replied the last time.
data.date_last_user_reply	DateTime	*	And the date user replied here last time.
data.date_agent_waiting	DateTime	*	Time when agent started to wait user.
data.date_user_waiting	DateTime	*	And the time when user started to wait agent.
data.date_status	DateTime	*	When status was changed.
data.total_user_waiting	integer	*	How much user was waited?
data.total_to_first_reply	integer	*	Total waiting before first reply.
data.total_user_waiting_wh	integer	*	Total user waiting in working hours.
data.total_to_first_reply_wh	integer	*	Total waiting before first reply in working hour.
data.locked_by_agent	integer id (Person)	*	An agent who locked the ticket.
data.date_locked	DateTime	*	Date time when ticket was locked.
data.date_on_hold	DateTime	*	Datetime when ticket was set on hold.
data.has_attachments	boolean	*	Does this ticket has attachments?
data.subject	string	*	Ticket subject.
data.original_subject	string	*	Original subject given by creator.
data.properties	array	*	Array of properties.
data.problems[]	array of integer ids (Problem)	*	An array of associated problems.
data.count_agent_replies	integer	*	Count of all replies made by agents.
data.count_user_replies	integer	*	Count of all replies made by user.
data.worst_sla_status	string	*	Well, this is worst SLA status.
data.waiting_times	array	*	An array of waiting times.
data.ticket_slas[]	array of integer ids (TicketSla)	*	All ticket SLAS.
data.fields[]	dynamically declared custom fields (ticket)	*	Custom ticket fields.
data.contextual_fields	custom handler result for (custom_per_data)	*	Contextual ticket fields (per user/org fields).
data.children[]	array of integer ids (Ticket)	*	Ticket children.
data.siblings[]	array of integer ids (Ticket)	*	Ticket siblings.
data.cc[]	array of integer ids (Person)	*	User should be acknowledged about this ticket.
data.star	string	*	Person star color.
data.ticket_layout	custom handler result for (raw)	*
data.ticket_excerpt	custom handler result for (raw)	*
data.ticket_agent_errors	custom handler result for (raw)	*
data.ticket_user_errors	custom handler result for (raw)	*
data.ticket_permissions	custom handler result for (raw)	*
data.access_code	string	*	Access code.
data.followers	string	*	Followers of that ticket as a comma-separated list of names.

Status Code	Description
200	We will return such status in case we found your entity
301	Redirect to the new entity if deleted entity has spesified ID
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/tickets/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.tickets.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	ref:[\w\-\.]+\|\d+	integer\|string	The id\|ref of the resource

Parameter	Type	Required?	Format	Description
subject	string	false
department	choice	false
parent	choice	false
children[]	array of choices	false
language	choice	false
person[id]	string	false
person[name]	string	false
person[email]	string	false
person[fieldId]	string	false
person[key]	string	false
agent[id]	string	false
agent[name]	string	false
agent[email]	string	false
agent[fieldId]	string	false
agent[key]	string	false
agent_team	choice	false
organization	choice	false
status	choice	false	["live","awaiting_agent","awaiting_agent.4","awaiting_user","awaiting_user.3","pending","pending.5","resolved","resolved.6","archived","hidden","hidden.1","hidden.2"]
is_hold	boolean	false
urgency	float	false
labels[]	array of strings	false
cc[][person][id]	string	false
cc[][person][name]	string	false
cc[][person][email]	string	false
cc[][person][fieldId]	string	false
cc[][person][key]	string	false
cc[][person_email]	string	false
fields[1][mode]	string	false
fields[1][criteria]	string	false
fields[1][data]	choice	false
fields[5][mode]	string	false
fields[5][criteria]	string	false
fields[5][data]	string	false
fields[6][mode]	string	false
fields[6][criteria]	string	false
fields[6][data]	string	false
fields[7][mode]	string	false
fields[7][criteria]	string	false
fields[7][data][]	array of choices	false
fields[11][mode]	string	false
fields[11][criteria]	string	false
fields[11][data]	date	false	yyyy-MM-dd
fields[12][mode]	string	false
fields[12][criteria]	string	false
fields[12][data]	choice	false
fields[19][mode]	string	false
fields[19][criteria]	string	false
fields[19][data][]	array of choices	false
fields[24][mode]	string	false
fields[24][criteria]	string	false
fields[24][data]	choice	false
fields[31][mode]	string	false
fields[31][criteria]	string	false
fields[31][data][]	array of choices	false
fields[36][mode]	string	false
fields[36][criteria]	string	false
fields[36][data]	choice	false
fields[45][mode]	string	false
fields[45][criteria]	string	false
fields[45][data]	datetime	false	yyyy-MM-dd'T'HH:mm:ss
fields[46][mode]	string	false
fields[46][criteria]	string	false
fields[46][data]	string	false
fields[47][mode]	string	false
fields[47][criteria]	string	false
fields[47][data]	string	false
fields[48][mode]	string	false
fields[48][criteria]	string	false
fields[48][data]	string	false
fields[49][mode]	string	false
fields[49][criteria]	string	false
fields[50][mode]	string	false
fields[50][criteria]	string	false
fields[51][mode]	string	false
fields[51][criteria]	string	false
fields[51][data]	choice	false	[-10,-9,-8,-7,-6,-5,-4,-3,-2,-1,0,1,2,3,4,5,6,7,8,9,10]
fields[52][mode]	string	false
fields[52][criteria]	string	false
fields[52][data]	string	false
fields[53][mode]	string	false
fields[53][criteria]	string	false
fields[53][data]	boolean	false
fields[54][mode]	string	false
fields[54][criteria]	string	false
fields[54][data][]	array of choices	false
fields[62][mode]	string	false
fields[62][criteria]	string	false
fields[62][data]	string	false
fields[63][mode]	string	false
fields[63][criteria]	string	false
fields[63][data][]	array of choices	false
star[color]	choice	false	{"1":"blue","2":"green","3":"orange","4":"pink","5":"purple","6":"red","7":"yellow"}
summary[summary]	string	false
summary[summaryInput]	string	false
date_created	datetime	false	yyyy-MM-dd'T'HH:mm:ss
context	choice	false	["agent","user"]
add_charge_time	float	false
macros[]	array of choices	false
date_feedback_rating	datetime	false	yyyy-MM-dd'T'HH:mm:ss
date_resolved	datetime	false	yyyy-MM-dd'T'HH:mm:ss
date_archived	datetime	false	yyyy-MM-dd'T'HH:mm:ss
date_first_agent_assign	datetime	false	yyyy-MM-dd'T'HH:mm:ss
date_first_agent_reply	datetime	false	yyyy-MM-dd'T'HH:mm:ss
date_last_agent_reply	datetime	false	yyyy-MM-dd'T'HH:mm:ss
date_last_user_reply	datetime	false	yyyy-MM-dd'T'HH:mm:ss
date_agent_waiting	datetime	false	yyyy-MM-dd'T'HH:mm:ss
date_user_waiting	datetime	false	yyyy-MM-dd'T'HH:mm:ss
date_status	datetime	false	yyyy-MM-dd'T'HH:mm:ss
date_on_hold	datetime	false	yyyy-MM-dd'T'HH:mm:ss
date_locked	datetime	false	yyyy-MM-dd'T'HH:mm:ss
total_user_waiting	integer	false
total_to_first_reply	integer	false
message[message]	string	false		Message
message[primary_translation][message]	string	false
message[primary_translation][from_language]	string	false
message[primary_translation][language]	string	false
message[person][id]	string	false
message[person][name]	string	false
message[person][email]	string	false
message[person][fieldId]	string	false
message[person][key]	string	false
message[format]	choice	false	["html","text"]
message[message_source_type]	string	false
message[message_source]	string	false
message[is_note]	boolean	false
message[attachments][][is_inline]	boolean	false
message[status]	choice	false	["live","awaiting_agent","awaiting_agent.4","awaiting_user","awaiting_user.3","pending","pending.5","resolved","resolved.6","archived","hidden","hidden.1","hidden.2"]
message[macros][]	array of choices	false
message[snippets][]	array of choices	false
message[date_created]	datetime	false	yyyy-MM-dd'T'HH:mm:ss
messages[][message]	string	false		Message
messages[][primary_translation][message]	string	false
messages[][primary_translation][from_language]	string	false
messages[][primary_translation][language]	string	false
messages[][format]	choice	false	["html","text"]
messages[][message_source_type]	string	false
messages[][message_source]	string	false
messages[][is_note]	boolean	false
messages[][attachments][][is_inline]	boolean	false
messages[][date_created]	datetime	false	yyyy-MM-dd'T'HH:mm:ss
brand	choice	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/tickets/{id}/download-debug-report CRUD

Download debug report file

Applicable api modes

signed

Api tags for this endpoint

tickets.tickets.download_debug_report

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer\|string	The id\|ref of the resource

Status Code	Description
200	Returns the requested resource
400	We will return this in case your request was malformed

POST /api/v2/tickets/{id}/merge/{mergeId} CRUD

Merge tickets

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.tickets.merge

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	ref:[\w\-\.]+\|\d+	integer\|string	The id\|ref of the resource
mergeId	ref:[\w\-\.]+\|\d+	integer\|string	The id\|ref of the merging resource

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.ref	string	*	String reference.
data.auth	string	*	Auth string.
data.parent	integer id (Ticket)	*	Parent of this ticket.
data.language	integer id (Language)	*	Language associated with this ticket.
data.brand	integer id (Brand)	*	Ticket brand.
data.department	integer id (Department)	*	Ticket where this department is processing.
data.category	integer id (TicketCategory)	*	Category of this ticket.
data.priority	integer id (TicketPriority)	*	Priority of this ticket.
data.workflow	integer id (TicketWorkflow)	*	Workflow entity.
data.product	integer id (Product)	*	Product about which this ticket.
data.person	integer id (Person)	*	Person created this ticket.
data.person_email	string representation (PersonEmail)	*	Person's email.
data.agent	integer id (Person)	*	Agent assigned.
data.agent_team	integer id (AgentTeam)	*	Agent team where this ticket is processing.
data.organization	integer id (Organization)	*	Organization team where this ticket is processing.
data.linked_chat	integer id (ChatConversation)	*	ChatConversation where this ticket is discussed.
data.sent_to_address	array	*	Addresses where ticket was send.
data.email_account	integer id (EmailAccount)	*	Email account used to gather the ticket.
data.email_account_address	string	*	Email account address used to gather the ticket.
data.creation_system	string	*	How this ticket appears.
data.creation_system_option	string	*	Option used by creation system.
data.ticket_hash	string	*	Unique hash.
data.status	string	<=20170400	Legacy ticket status.
data.hidden_status	string	<=20170400	Legacy ticket hidden status.
data.ticket_status	string	*	Ticket status.
data.is_hold	boolean	*	Is this on hold?
data.labels[]	array of strings	*	String array of labels.
data.urgency	integer	*	How urgent this ticket?
data.feedback_rating	integer	*	Its rating based on feedback votes.
data.date_feedback_rating	DateTime	*	When the rating was calculated.
data.date_created	DateTime	*	When the ticket was created.
data.date_resolved	DateTime	*	When the ticket was resolved.
data.date_archived	DateTime	*	And archived at last.
data.date_first_agent_assign	DateTime	*	When it was assigned to agent at the very first time.
data.date_first_agent_reply	DateTime	*	When it was first time replied.
data.date_last_agent_reply	DateTime	*	And when it was replied the last time.
data.date_last_user_reply	DateTime	*	And the date user replied here last time.
data.date_agent_waiting	DateTime	*	Time when agent started to wait user.
data.date_user_waiting	DateTime	*	And the time when user started to wait agent.
data.date_status	DateTime	*	When status was changed.
data.total_user_waiting	integer	*	How much user was waited?
data.total_to_first_reply	integer	*	Total waiting before first reply.
data.total_user_waiting_wh	integer	*	Total user waiting in working hours.
data.total_to_first_reply_wh	integer	*	Total waiting before first reply in working hour.
data.locked_by_agent	integer id (Person)	*	An agent who locked the ticket.
data.date_locked	DateTime	*	Date time when ticket was locked.
data.date_on_hold	DateTime	*	Datetime when ticket was set on hold.
data.has_attachments	boolean	*	Does this ticket has attachments?
data.subject	string	*	Ticket subject.
data.original_subject	string	*	Original subject given by creator.
data.properties	array	*	Array of properties.
data.problems[]	array of integer ids (Problem)	*	An array of associated problems.
data.count_agent_replies	integer	*	Count of all replies made by agents.
data.count_user_replies	integer	*	Count of all replies made by user.
data.worst_sla_status	string	*	Well, this is worst SLA status.
data.waiting_times	array	*	An array of waiting times.
data.ticket_slas[]	array of integer ids (TicketSla)	*	All ticket SLAS.
data.fields[]	dynamically declared custom fields (ticket)	*	Custom ticket fields.
data.contextual_fields	custom handler result for (custom_per_data)	*	Contextual ticket fields (per user/org fields).
data.children[]	array of integer ids (Ticket)	*	Ticket children.
data.siblings[]	array of integer ids (Ticket)	*	Ticket siblings.
data.cc[]	array of integer ids (Person)	*	User should be acknowledged about this ticket.
data.star	string	*	Person star color.
data.ticket_layout	custom handler result for (raw)	*
data.ticket_excerpt	custom handler result for (raw)	*
data.ticket_agent_errors	custom handler result for (raw)	*
data.ticket_user_errors	custom handler result for (raw)	*
data.ticket_permissions	custom handler result for (raw)	*
data.access_code	string	*	Access code.
data.followers	string	*	Followers of that ticket as a comma-separated list of names.

Status Code	Description
200	Returns the modified resource
400	We will return this in case your request was malformed

GET /api/v2/tickets/{id}/view CRUD

Ticket view_print and pdf

Applicable api modes

signed

Api tags for this endpoint

tickets.tickets.view

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer\|string	The id\|ref of the resource

Status Code	Description
200	Returns the requested resource
400	We will return this in case your request was malformed

GET /api/v2/tickets/{parentId}/attachments CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_attachments.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (TicketAttachment)	*
data[][blob]	object (Blob)	*	Actual attachment.
data[][blob][sys_name]	string	*	A unique system name for the blob.
data[][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][blob][file_url]	string	*	The HTTP link to download the file.
data[][blob][authcode]	string	*
data[][blob][blob_hash]	string	*
data[][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][blob][date_created]	DateTime	*
data[][blob][is_temp]	boolean	*
data[][blob][source_ref]	string	*
data[][blob][labels][]	array of objects (LabelBlob)	*
data[][blob][labels][][blob]	object (Blob)	*
data[][message]	integer id (TicketMessage)	*	Message - holder of this attachment.
data[][id]	integer	*	The unique ID.
data[][ticket]	integer id (Ticket)	*	Ticket this attachment belongs to.
data[][person]	integer id (Person)	*	Who created the attachment.
data[][is_agent_note]	boolean	*	True if this attachmen just a note.
data[][is_inline]	boolean	*	Is this attachment is embed in message.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

GET /api/v2/tickets/{parentId}/cc CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_cc.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (Person)	*
data[][id]	integer	*	The unique ID of person.
data[][primary_email]	string representation (PersonEmail)	*	Emails belong to user.
data[][first_name]	string	*	The users name (best guess from other sources etc).
data[][last_name]	string	*	The users name (best guess from other sources etc).
data[][title_prefix]	string	*	The users title.
data[][name]	string	*	The users name (best guess from other sources etc).
data[][display_name]	string	*	Person name.
data[][is_agent]	boolean	*	True if person is agent.
data[][avatar]	object (Avatar)	*	Person`s avatar.
data[][avatar][default_url_pattern]	string	*	Default pattern used if there is no custom one.
data[][avatar][url_pattern]	string	*	Url pattern for avatar gathering.
data[][avatar][base_gravatar_url]	string	*	Url to gravatar.
data[][online]	boolean	*	Is user online?
data[][online_for_chat]	boolean	*	Is user online for chat?
data[][last_seen]	DateTime	*	Date when user was last seen online.
data[][agent_data]	object (AgentData)	*	Agent data.
data[][agent_data][extension_number]	integer	*
data[][agent_data][available_status]	string	*
data[][agent_data][agent_calls_enabled]	boolean	*
data[][agent_data][agent_chat_enabled]	boolean	*
data[][agent_data][agent_can_use_forwarding]	boolean	*
data[][agent_data][forwarding_number]	string	*
data[][agent_data][forwarding_ring_timeout]	integer	*
data[][agent_data][forwarding_number_type]	string	*
data[][agent_data][forwarding_logged_out]	boolean	*
data[][agent_data][work_status_enabled]	boolean	*
data[][agent_data][work_status_managed_after]	DateTime	*
data[][agent_data][login_status]	string	*
data[][was_agent]	boolean	*	Was this person an agent?
data[][can_agent]	boolean	*	Is person allowed to use agent interface.
data[][can_admin]	boolean	*	Is person allowed to use admin interface.
data[][can_billing]	boolean	*	Is person allowed to use billing interface.
data[][can_reports]	boolean	*	Is person allowed to use reports interface.
data[][picture_blob]	integer id (Blob)	*	The user`s profile picture.
data[][disable_picture]	boolean	*	True if user`s picture disabled.
data[][gravatar_url]	string	*	The URL to the users gravatar if any.
data[][is_contact]	boolean	*	Is this person a contact?
data[][disable_autoresponses]	boolean	*	Are autoresponses disabled?
data[][disable_autoresponses_log]	string	*	Disabled autoresponses log.
data[][is_confirmed]	boolean	*	Has person confirmed their email?
data[][is_deleted]	boolean	*	Is the user deleted?
data[][is_disabled]	boolean	*	Is the user disabled?
data[][creation_system]	string	*	The way person was created.
data[][override_display_name]	string	*	Overrides the display name of an person in the user interface (agents only).
data[][display_contact]	string	*	Person name and email address.
data[][summary]	string	*	The summary field as filled in by agents.
data[][language]	integer id (Language)	*	Default person`s language.
data[][organization]	integer id (Organization)	*	The person`s organization.
data[][organization_members][]	array of integer ids (OrganizationMember)	*	Organizations the person is member of.
data[][organization_position]	string	*	The persons position at the organization.
data[][organization_manager]	boolean	*	True if the person is a manager of their organization.
data[][timezone]	string	*	The timezone associated with this user.
data[][date_created]	DateTime	*	The date the user was inserted into the system.
data[][date_last_login]	DateTime	*	The date the user was logged in last time.
data[][browser]	string	*	The browser person was used last time.
data[][all_user_groups][]	array of integer ids (Usergroup)	*	Usergroups the user belongs to including through connections like org groups.
data[][user_groups][]	array of integer ids (Usergroup)	*	Usergroups the user belongs to.
data[][agent_groups][]	array of integer ids (Usergroup)	*	Usergroups the user belongs to.
data[][labels][]	array of objects (label)	*	Labels associated with this user.
data[][emails][]	array of string representations (PersonEmail)	*	Emails belong to user.
data[][phone_numbers][]	array of objects (PersonPhoneNumber)	*	Phone numbers belong to user.
data[][phone_numbers][][number]	string	*	The number, stored in E.164 string format, ie. +19021111111.
data[][phone_numbers][][label]	string	*	A human-defined (optional) label to describe what this phone number is.
data[][phone_numbers][][extension]	string	*	An extension for the number - optional.
data[][phone_numbers][][person]	integer id (Person)	*
data[][tickets_count]	integer	*	Overall tickets count assigned to user.
data[][chats_count]	integer	*	Overall count of chats user participating.
data[][fields][]	dynamically declared custom fields (person)	*	Custom persons data.
data[][contextual_options]	custom handler result for (contextual_options)	*	Contextual person options.
data[][contact_data]	array	*	Contacts for this user.
data[][teams][]	array of integer ids (AgentTeam)	*	Agent teams.
data[][primary_team]	integer id (AgentTeam)	*	Primary agent team.
data[][brands][]	array of integer ids (Brand)	*	Brands.
data[][preferences]	array	*	Prefs.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/tickets/{parentId}/cc CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_cc.post

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Required?
person[id]	string	false
person[name]	string	false
person[email]	string	false
person[fieldId]	string	false
person[key]	string	false

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID of person.
data.primary_email	string representation (PersonEmail)	*	Emails belong to user.
data.first_name	string	*	The users name (best guess from other sources etc).
data.last_name	string	*	The users name (best guess from other sources etc).
data.title_prefix	string	*	The users title.
data.name	string	*	The users name (best guess from other sources etc).
data.display_name	string	*	Person name.
data.is_agent	boolean	*	True if person is agent.
data.avatar	object (Avatar)	*	Person`s avatar.
data.avatar[default_url_pattern]	string	*	Default pattern used if there is no custom one.
data.avatar[url_pattern]	string	*	Url pattern for avatar gathering.
data.avatar[base_gravatar_url]	string	*	Url to gravatar.
data.online	boolean	*	Is user online?
data.online_for_chat	boolean	*	Is user online for chat?
data.last_seen	DateTime	*	Date when user was last seen online.
data.agent_data	object (AgentData)	*	Agent data.
data.agent_data[extension_number]	integer	*
data.agent_data[available_status]	string	*
data.agent_data[agent_calls_enabled]	boolean	*
data.agent_data[agent_chat_enabled]	boolean	*
data.agent_data[agent_can_use_forwarding]	boolean	*
data.agent_data[forwarding_number]	string	*
data.agent_data[forwarding_ring_timeout]	integer	*
data.agent_data[forwarding_number_type]	string	*
data.agent_data[forwarding_logged_out]	boolean	*
data.agent_data[work_status_enabled]	boolean	*
data.agent_data[work_status_managed_after]	DateTime	*
data.agent_data[login_status]	string	*
data.agent_data[extensionNumber]		*
data.agent_data[voicemailAsset]		*
data.agent_data[availableStatus]		*
data.agent_data[forwardingNumber]		*
data.agent_data[loginStatus]		*
data.was_agent	boolean	*	Was this person an agent?
data.can_agent	boolean	*	Is person allowed to use agent interface.
data.can_admin	boolean	*	Is person allowed to use admin interface.
data.can_billing	boolean	*	Is person allowed to use billing interface.
data.can_reports	boolean	*	Is person allowed to use reports interface.
data.picture_blob	integer id (Blob)	*	The user`s profile picture.
data.disable_picture	boolean	*	True if user`s picture disabled.
data.gravatar_url	string	*	The URL to the users gravatar if any.
data.is_contact	boolean	*	Is this person a contact?
data.disable_autoresponses	boolean	*	Are autoresponses disabled?
data.disable_autoresponses_log	string	*	Disabled autoresponses log.
data.is_confirmed	boolean	*	Has person confirmed their email?
data.is_deleted	boolean	*	Is the user deleted?
data.is_disabled	boolean	*	Is the user disabled?
data.creation_system	string	*	The way person was created.
data.override_display_name	string	*	Overrides the display name of an person in the user interface (agents only).
data.display_contact	string	*	Person name and email address.
data.summary	string	*	The summary field as filled in by agents.
data.language	integer id (Language)	*	Default person`s language.
data.organization	integer id (Organization)	*	The person`s organization.
data.organization_members[]	array of integer ids (OrganizationMember)	*	Organizations the person is member of.
data.organization_position	string	*	The persons position at the organization.
data.organization_manager	boolean	*	True if the person is a manager of their organization.
data.timezone	string	*	The timezone associated with this user.
data.date_created	DateTime	*	The date the user was inserted into the system.
data.date_last_login	DateTime	*	The date the user was logged in last time.
data.browser	string	*	The browser person was used last time.
data.all_user_groups[]	array of integer ids (Usergroup)	*	Usergroups the user belongs to including through connections like org groups.
data.user_groups[]	array of integer ids (Usergroup)	*	Usergroups the user belongs to.
data.agent_groups[]	array of integer ids (Usergroup)	*	Usergroups the user belongs to.
data.labels[]	array of objects (label)	*	Labels associated with this user.
data.emails[]	array of string representations (PersonEmail)	*	Emails belong to user.
data.phone_numbers[]	array of objects (PersonPhoneNumber)	*	Phone numbers belong to user.
data.phone_numbers[][number]	string	*	The number, stored in E.164 string format, ie. +19021111111.
data.phone_numbers[][label]	string	*	A human-defined (optional) label to describe what this phone number is.
data.phone_numbers[][extension]	string	*	An extension for the number - optional.
data.phone_numbers[][person]	integer id (Person)	*
data.tickets_count	integer	*	Overall tickets count assigned to user.
data.chats_count	integer	*	Overall count of chats user participating.
data.fields[]	dynamically declared custom fields (person)	*	Custom persons data.
data.contextual_options	custom handler result for (contextual_options)	*	Contextual person options.
data.contact_data	array	*	Contacts for this user.
data.teams[]	array of integer ids (AgentTeam)	*	Agent teams.
data.primary_team	integer id (AgentTeam)	*	Primary agent team.
data.brands[]	array of integer ids (Brand)	*	Brands.
data.preferences	array	*	Prefs.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

DELETE /api/v2/tickets/{parentId}/cc/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_cc.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/tickets/{parentId}/cc/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_cc.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID of person.
data.primary_email	string representation (PersonEmail)	*	Emails belong to user.
data.first_name	string	*	The users name (best guess from other sources etc).
data.last_name	string	*	The users name (best guess from other sources etc).
data.title_prefix	string	*	The users title.
data.name	string	*	The users name (best guess from other sources etc).
data.display_name	string	*	Person name.
data.is_agent	boolean	*	True if person is agent.
data.avatar	object (Avatar)	*	Person`s avatar.
data.avatar[default_url_pattern]	string	*	Default pattern used if there is no custom one.
data.avatar[url_pattern]	string	*	Url pattern for avatar gathering.
data.avatar[base_gravatar_url]	string	*	Url to gravatar.
data.online	boolean	*	Is user online?
data.online_for_chat	boolean	*	Is user online for chat?
data.last_seen	DateTime	*	Date when user was last seen online.
data.agent_data	object (AgentData)	*	Agent data.
data.agent_data[extension_number]	integer	*
data.agent_data[available_status]	string	*
data.agent_data[agent_calls_enabled]	boolean	*
data.agent_data[agent_chat_enabled]	boolean	*
data.agent_data[agent_can_use_forwarding]	boolean	*
data.agent_data[forwarding_number]	string	*
data.agent_data[forwarding_ring_timeout]	integer	*
data.agent_data[forwarding_number_type]	string	*
data.agent_data[forwarding_logged_out]	boolean	*
data.agent_data[work_status_enabled]	boolean	*
data.agent_data[work_status_managed_after]	DateTime	*
data.agent_data[login_status]	string	*
data.agent_data[extensionNumber]		*
data.agent_data[voicemailAsset]		*
data.agent_data[availableStatus]		*
data.agent_data[forwardingNumber]		*
data.agent_data[loginStatus]		*
data.was_agent	boolean	*	Was this person an agent?
data.can_agent	boolean	*	Is person allowed to use agent interface.
data.can_admin	boolean	*	Is person allowed to use admin interface.
data.can_billing	boolean	*	Is person allowed to use billing interface.
data.can_reports	boolean	*	Is person allowed to use reports interface.
data.picture_blob	integer id (Blob)	*	The user`s profile picture.
data.disable_picture	boolean	*	True if user`s picture disabled.
data.gravatar_url	string	*	The URL to the users gravatar if any.
data.is_contact	boolean	*	Is this person a contact?
data.disable_autoresponses	boolean	*	Are autoresponses disabled?
data.disable_autoresponses_log	string	*	Disabled autoresponses log.
data.is_confirmed	boolean	*	Has person confirmed their email?
data.is_deleted	boolean	*	Is the user deleted?
data.is_disabled	boolean	*	Is the user disabled?
data.creation_system	string	*	The way person was created.
data.override_display_name	string	*	Overrides the display name of an person in the user interface (agents only).
data.display_contact	string	*	Person name and email address.
data.summary	string	*	The summary field as filled in by agents.
data.language	integer id (Language)	*	Default person`s language.
data.organization	integer id (Organization)	*	The person`s organization.
data.organization_members[]	array of integer ids (OrganizationMember)	*	Organizations the person is member of.
data.organization_position	string	*	The persons position at the organization.
data.organization_manager	boolean	*	True if the person is a manager of their organization.
data.timezone	string	*	The timezone associated with this user.
data.date_created	DateTime	*	The date the user was inserted into the system.
data.date_last_login	DateTime	*	The date the user was logged in last time.
data.browser	string	*	The browser person was used last time.
data.all_user_groups[]	array of integer ids (Usergroup)	*	Usergroups the user belongs to including through connections like org groups.
data.user_groups[]	array of integer ids (Usergroup)	*	Usergroups the user belongs to.
data.agent_groups[]	array of integer ids (Usergroup)	*	Usergroups the user belongs to.
data.labels[]	array of objects (label)	*	Labels associated with this user.
data.emails[]	array of string representations (PersonEmail)	*	Emails belong to user.
data.phone_numbers[]	array of objects (PersonPhoneNumber)	*	Phone numbers belong to user.
data.phone_numbers[][number]	string	*	The number, stored in E.164 string format, ie. +19021111111.
data.phone_numbers[][label]	string	*	A human-defined (optional) label to describe what this phone number is.
data.phone_numbers[][extension]	string	*	An extension for the number - optional.
data.phone_numbers[][person]	integer id (Person)	*
data.tickets_count	integer	*	Overall tickets count assigned to user.
data.chats_count	integer	*	Overall count of chats user participating.
data.fields[]	dynamically declared custom fields (person)	*	Custom persons data.
data.contextual_options	custom handler result for (contextual_options)	*	Contextual person options.
data.contact_data	array	*	Contacts for this user.
data.teams[]	array of integer ids (AgentTeam)	*	Agent teams.
data.primary_team	integer id (AgentTeam)	*	Primary agent team.
data.brands[]	array of integer ids (Brand)	*	Brands.
data.preferences	array	*	Prefs.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

GET /api/v2/tickets/{parentId}/charges CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_charges.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (TicketCharge)	*
data[][id]	integer	*
data[][charge_time]	integer	*
data[][amount]	float	*
data[][date_created]	DateTime	*
data[][ticket]	object (Ticket)	*
data[][ticket][id]	integer	*
data[][ticket][ref]	string	*
data[][ticket][auth]	string	*
data[][ticket][parent_ticket]	object (Ticket)	*	Parent ticket.
data[][ticket][children_tickets][]	array of objects (Ticket)	*
data[][ticket][language]	object (Language)	*	The language the ticket is in.
data[][ticket][language][id]	integer	*	The unique ID.
data[][ticket][language][sys_name]	string	*	The unique sys name assigned to the language.
data[][ticket][language][title]	string	*	Title of the language.
data[][ticket][language][title_local]	string	*	Title of the language.
data[][ticket][language][base_filepath]	string	*	The base filepath for default phrases for this lang.
data[][ticket][language][locale]	string	*	The locale code.
data[][ticket][language][flag_image]	string	*	String path to image.
data[][ticket][language][is_rtl]	boolean	*	True if this is a right-to-left language.
data[][ticket][language][has_user]	boolean	*	True if has user.
data[][ticket][language][has_agent]	boolean	*	True if has agent.
data[][ticket][language][has_admin]	boolean	*	True if has admin.
data[][ticket][language][plural_categories][]	array of strings	*
data[][ticket][language][plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data[][ticket][language][flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`
data[][ticket][brand]	object (Brand)	*
data[][ticket][brand][id]	integer	*	The unique ID.
data[][ticket][brand][name]	string	*	The brand name.
data[][ticket][brand][slug]	string	*
data[][ticket][brand][url]	string	*	The brand url.
data[][ticket][brand][theme_set]	object (ThemeSet)	*
data[][ticket][brand][theme_set][id]	integer	*
data[][ticket][brand][theme_set][theme_id]	string	*
data[][ticket][brand][theme_set][title]	string	*
data[][ticket][brand][edit_theme_set]	object (ThemeSet)	*
data[][ticket][brand][departments][]	array of objects (Department)	*
data[][ticket][brand][departments][][id]	integer	*
data[][ticket][brand][departments][][parent]	object (Department)	*
data[][ticket][brand][departments][][children][]	array of objects (Department)	*
data[][ticket][brand][departments][][title]	string	*
data[][ticket][brand][departments][][user_title]	string	*
data[][ticket][brand][departments][][is_tickets_enabled]	boolean	*
data[][ticket][brand][departments][][is_chat_enabled]	boolean	*
data[][ticket][brand][departments][][display_order]	integer	*
data[][ticket][brand][departments][][avatar]	object (Blob)	*
data[][ticket][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data[][ticket][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][ticket][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][ticket][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][ticket][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][ticket][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data[][ticket][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data[][ticket][brand][departments][][avatar][authcode]	string	*
data[][ticket][brand][departments][][avatar][blob_hash]	string	*
data[][ticket][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][ticket][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][ticket][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][ticket][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][ticket][brand][departments][][avatar][date_created]	DateTime	*
data[][ticket][brand][departments][][avatar][is_temp]	boolean	*
data[][ticket][brand][departments][][avatar][source_ref]	string	*
data[][ticket][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data[][ticket][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data[][ticket][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][ticket][brand][departments][][brands][]	array of objects (Brand)	*
data[][ticket][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data[][ticket][brand][departments][][permissions][][department]	integer id (Department)	*
data[][ticket][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][ticket][brand][departments][][permissions][][name]	string	*	The name of the permission.
data[][ticket][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][ticket][brand][departments][][permissions][][is_active]	boolean	*
data[][ticket][brand][departments][][chat_queue]	object (UserChatQueue)	*
data[][ticket][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data[][ticket][brand][departments][][chat_queue][name]	string	*
data[][ticket][brand][departments][][chat_queue][routing_model]	string	*
data[][ticket][brand][departments][][chat_queue][answer_timeout]	integer	*
data[][ticket][brand][departments][][chat_queue][is_all_agents]	boolean	*
data[][ticket][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data[][ticket][brand][departments][][chat_queue][max_queue_size]	integer	*
data[][ticket][brand][theme_sets][]	array of objects (ThemeSet)	*
data[][ticket][department]	object (Department)	*
data[][ticket][department][id]	integer	*
data[][ticket][department][parent]	object (Department)	*
data[][ticket][department][children][]	array of objects (Department)	*
data[][ticket][department][title]	string	*
data[][ticket][department][user_title]	string	*
data[][ticket][department][is_tickets_enabled]	boolean	*
data[][ticket][department][is_chat_enabled]	boolean	*
data[][ticket][department][display_order]	integer	*
data[][ticket][department][avatar]	object (Blob)	*
data[][ticket][department][avatar][sys_name]	string	*	A unique system name for the blob.
data[][ticket][department][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][ticket][department][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][ticket][department][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][ticket][department][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][ticket][department][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data[][ticket][department][avatar][file_url]	string	*	The HTTP link to download the file.
data[][ticket][department][avatar][authcode]	string	*
data[][ticket][department][avatar][blob_hash]	string	*
data[][ticket][department][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][ticket][department][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][ticket][department][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][ticket][department][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][ticket][department][avatar][date_created]	DateTime	*
data[][ticket][department][avatar][is_temp]	boolean	*
data[][ticket][department][avatar][source_ref]	string	*
data[][ticket][department][avatar][labels][]	array of objects (LabelBlob)	*
data[][ticket][department][avatar][labels][][blob]	object (Blob)	*
data[][ticket][department][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][ticket][department][brands][]	array of objects (Brand)	*
data[][ticket][department][permissions][]	array of objects (DepartmentPermission)	*
data[][ticket][department][permissions][][department]	integer id (Department)	*
data[][ticket][department][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][ticket][department][permissions][][name]	string	*	The name of the permission.
data[][ticket][department][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][ticket][department][permissions][][is_active]	boolean	*
data[][ticket][department][chat_queue]	object (UserChatQueue)	*
data[][ticket][department][chat_queue][id]	integer	*	The unique ID.
data[][ticket][department][chat_queue][name]	string	*
data[][ticket][department][chat_queue][routing_model]	string	*
data[][ticket][department][chat_queue][answer_timeout]	integer	*
data[][ticket][department][chat_queue][is_all_agents]	boolean	*
data[][ticket][department][chat_queue][departments][]	array of objects (Department)	*
data[][ticket][department][chat_queue][max_queue_size]	integer	*
data[][ticket][category]	object (TicketCategory)	*
data[][ticket][category][id]	integer	*	The unique ID.
data[][ticket][category][parent]	integer id (TicketCategory)	*	This category parent.
data[][ticket][category][title]	string	*	Category title.
data[][ticket][category][display_order]	integer	*	Obviously it's display order for lists.
data[][ticket][priority]	object (TicketPriority)	*
data[][ticket][priority][id]	integer	*	The unique ID.
data[][ticket][priority][title]	string	*	Priority title.
data[][ticket][priority][priority]	integer	*	The priority itself.
data[][ticket][workflow]	object (TicketWorkflow)	*
data[][ticket][workflow][id]	integer	*	The unique ID.
data[][ticket][workflow][title]	string	*	Workflow title.
data[][ticket][workflow][display_order]	integer	*	Workflow display order.
data[][ticket][product]	object (Product)	*
data[][ticket][product][parent]	integer id (Product)	*	Parent of the product.
data[][ticket][person]	object (Person)	*
data[][ticket][person_email]	object (PersonEmail)	*
data[][ticket][person_email][id]	integer	*	The unique ID.
data[][ticket][person_email][person]	integer id (Person)	*	Person owner of email.
data[][ticket][person_email][email]	string	*	The email address.
data[][ticket][person_email][email_domain]	string	*	The email address domain.
data[][ticket][person_email][is_validated]	boolean	*	True if validation passed.
data[][ticket][person_email][date_created]	DateTime	*	The original time the email was created.
data[][ticket][agent]	object (Person)	*
data[][ticket][agent_team]	object (AgentTeam)	*
data[][ticket][agent_team][id]	integer	*	The unique ID.
data[][ticket][agent_team][name]	string	*	The name of agent team.
data[][ticket][agent_team][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][ticket][organization]	object (Organization)	*
data[][ticket][organization][id]	integer	*	The unique ID.
data[][ticket][organization][picture_blob]	object (Blob)	*	The org picture.
data[][ticket][organization][picture_blob][sys_name]	string	*	A unique system name for the blob.
data[][ticket][organization][picture_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][ticket][organization][picture_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][ticket][organization][picture_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][ticket][organization][picture_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][ticket][organization][picture_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][ticket][organization][picture_blob][file_url]	string	*	The HTTP link to download the file.
data[][ticket][organization][picture_blob][authcode]	string	*
data[][ticket][organization][picture_blob][blob_hash]	string	*
data[][ticket][organization][picture_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][ticket][organization][picture_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][ticket][organization][picture_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][ticket][organization][picture_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][ticket][organization][picture_blob][date_created]	DateTime	*
data[][ticket][organization][picture_blob][is_temp]	boolean	*
data[][ticket][organization][picture_blob][source_ref]	string	*
data[][ticket][organization][picture_blob][labels][]	array of objects (LabelBlob)	*
data[][ticket][organization][picture_blob][labels][][blob]	object (Blob)	*
data[][ticket][organization][icon_property]	object (IconProperty)	*
data[][ticket][organization][icon_property][urn]	string	*
data[][ticket][organization][icon_property][options]	array	*
data[][ticket][organization][name]	string	*	The organization name.
data[][ticket][organization][summary]	string	*	The summary field as filled in by agents.
data[][ticket][organization][importance]	integer	*	The org importance.
data[][ticket][organization][custom_data][]	array of objects (CustomDataOrganization)	*
data[][ticket][organization][custom_data][][organization]	object (Organization)	*
data[][ticket][organization][custom_data][][field]	object (CustomDefOrganization)	*
data[][ticket][organization][custom_data][][field][parent]	object (CustomDefOrganization)	*	Field`s parent.
data[][ticket][organization][custom_data][][field][children][]	array of objects (CustomDefOrganization)	*	Field children.
data[][ticket][organization][custom_data][][root_field]	object (CustomDefOrganization)	*
data[][ticket][organization][usergroups][]	array of objects (Usergroup)	*	Usergroups the user belongs to.
data[][ticket][organization][usergroups][][id]	integer	*	The unique ID, DB-generated.
data[][ticket][organization][usergroups][][title]	string	*	Title of the usergroup.
data[][ticket][organization][usergroups][][note]	string	*	A note or description about the usergroup.
data[][ticket][organization][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data[][ticket][organization][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data[][ticket][organization][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data[][ticket][organization][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data[][ticket][organization][usergroups][][permissions][][id]	integer	*	The unique ID.
data[][ticket][organization][usergroups][][permissions][][name]	string	*	The name of the permission.
data[][ticket][organization][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][ticket][organization][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data[][ticket][organization][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data[][ticket][organization][usergroups][][department_permissions][][department]	integer id (Department)	*
data[][ticket][organization][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][ticket][organization][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data[][ticket][organization][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][ticket][organization][usergroups][][department_permissions][][is_active]	boolean	*
data[][ticket][organization][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data[][ticket][organization][auto_cc_people][]	array of objects (Person)	*	Users who are set to automatically be added to tickets and other org things.
data[][ticket][organization][labels][]	array of objects (LabelOrganization)	*
data[][ticket][organization][labels][][organization]	object (Organization)	*
data[][ticket][organization][contact_data][]	array of objects (OrganizationContactData)	*
data[][ticket][organization][emails][]	array of objects (OrganizationEmail)	*
data[][ticket][organization][emails][][id]	integer	*	The unique log id.
data[][ticket][organization][emails][][organization]	object (Organization)	*
data[][ticket][organization][emails][][email]	string	*
data[][ticket][organization][emails][][date_created]	DateTime	*
data[][ticket][organization][email_domains][]	array of objects (OrganizationEmailDomain)	*
data[][ticket][organization][email_domains][][domain]	string	*	The email domain.
data[][ticket][organization][email_domains][][organization]	object (Organization)	*	The users organization.
data[][ticket][organization][date_created]	DateTime	*	The date the org was inserted into the system.
data[][ticket][organization][members][]	array of objects (Person)	*
data[][ticket][organization][parent]	object (Organization)	*
data[][ticket][organization][children][]	array of objects (Organization)	*
data[][ticket][organization][tickets][]	array of objects (Ticket)	*
data[][ticket][organization][organization_members][]	array of objects (OrganizationMember)	*
data[][ticket][organization][organization_members][][id]	integer	*
data[][ticket][organization][organization_members][][person]	integer id (Person)	*
data[][ticket][organization][organization_members][][organization]	integer id (Organization)	*
data[][ticket][organization][organization_members][][is_manager]	boolean	*
data[][ticket][organization][organization_members][][position]	string	*
data[][ticket][organization][organization_members][][created_at]	DateTime	*
data[][ticket][organization][organization_members][][updated_at]	DateTime	*
data[][ticket][linked_chat]	object (ChatConversation)	*
data[][ticket][linked_chat][id]	integer	*	The unique id of chat conversation.
data[][ticket][linked_chat][department]	object (Department)	*	Department which chat was assigned.
data[][ticket][linked_chat][brand]	object (Brand)	*	Department which chat was assigned.
data[][ticket][linked_chat][task_id]	integer	*
data[][ticket][linked_chat][ticket]	object (Ticket)	*
data[][ticket][linked_chat][labels][]	array of objects (LabelChatConversation)	*
data[][ticket][linked_chat][labels][][chat]	object (ChatConversation)	*
data[][ticket][linked_chat][subject]	string	*	Subject of the chat conversation.
data[][ticket][linked_chat][status]	string	*	Status of the chat conversation.
data[][ticket][linked_chat][agent]	object (Person)	*	If this is a user conversation, this is the agent assigned.
data[][ticket][linked_chat][agent_team]	object (AgentTeam)	*	If this is a team chat, the team it is.
data[][ticket][linked_chat][person]	object (Person)	*	If this is a user conversation, this is the user who started the chat.
data[][ticket][linked_chat][session]	object (Session)	*	If this is a user convo, this is the users session.
data[][ticket][linked_chat][session][id]	integer	*	The unique ID.
data[][ticket][linked_chat][session][auth]	string	*	The authcode for the session to verify an id.
data[][ticket][linked_chat][session][interface]	string	*	The Interface the session is for.
data[][ticket][linked_chat][session][person]	object (Person)	*
data[][ticket][linked_chat][session][user_agent]	string	*	The users user agent string.
data[][ticket][linked_chat][session][visitor_id]	string	*
data[][ticket][linked_chat][session][ip_address]	string	*	The users IP address.
data[][ticket][linked_chat][session][data]	string	*
data[][ticket][linked_chat][session][is_person]	boolean	*
data[][ticket][linked_chat][session][is_bot]	boolean	*
data[][ticket][linked_chat][session][is_helpdesk]	boolean	*
data[][ticket][linked_chat][session][active_status]	string	*	(Agents) Status (available or away).
data[][ticket][linked_chat][session][is_chat_available]	boolean	*	(Agents) Wehn status is available, if they are available for chat.
data[][ticket][linked_chat][session][date_created]	DateTime	*
data[][ticket][linked_chat][session][date_last]	DateTime	*
data[][ticket][linked_chat][session][date_last_page]	DateTime	*
data[][ticket][linked_chat][visitor_id]	string	*
data[][ticket][linked_chat][person_name]	string	*	User chat: The users name, if they arent a person.
data[][ticket][linked_chat][person_email]	string	*	User chat: The users email, if they aren`t a person.
data[][ticket][linked_chat][participants][]	array of objects (Person)	*
data[][ticket][linked_chat][messages][]	array of objects (ChatMessage)	*
data[][ticket][linked_chat][messages][][id]	integer	*	The unique ID.
data[][ticket][linked_chat][messages][][author_id]	integer	*	Author id (legacy).
data[][ticket][linked_chat][messages][][author_type]	string	*	Author type (legacy).
data[][ticket][linked_chat][messages][][conversation_id]	integer	*	Conversation id (legacy).
data[][ticket][linked_chat][messages][][author]	integer id (Person)	*	Person who created the message.
data[][ticket][linked_chat][messages][][content]	string	*	The message.
data[][ticket][linked_chat][messages][][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data[][ticket][linked_chat][messages][][is_user]	boolean	*	Is this an user's message? (send from the widget).
data[][ticket][linked_chat][messages][][is_html]	boolean	*	Is the content an HTML message?
data[][ticket][linked_chat][messages][][metadata]	array	*	Additional data.
data[][ticket][linked_chat][messages][][date_created]	DateTime	*	Date message was created.
data[][ticket][linked_chat][messages][][date_received]	DateTime	*	Date message was received.
data[][ticket][linked_chat][custom_data][]	array of objects (CustomDataChat)	*
data[][ticket][linked_chat][custom_data][][conversation]	object (ChatConversation)	*	The conversation the message belongs to.
data[][ticket][linked_chat][custom_data][][field]	object (CustomDefChat)	*
data[][ticket][linked_chat][custom_data][][field][parent]	object (CustomDefChat)	*
data[][ticket][linked_chat][custom_data][][field][children][]	array of objects (CustomDefChat)	*	Field children.
data[][ticket][linked_chat][custom_data][][root_field]	object (CustomDefChat)	*
data[][ticket][linked_chat][rating_response_time]	integer	*
data[][ticket][linked_chat][rating_overall]	integer	*
data[][ticket][linked_chat][rating_comment]	string	*
data[][ticket][linked_chat][is_agent]	boolean	*	Is this an agent chat.
data[][ticket][linked_chat][is_window]	boolean	*	If the chat is popped out into a window. This is used to make sure the JS widget on pages doesn't load again.
data[][ticket][linked_chat][date_created]	DateTime	*	Date when chat was started.
data[][ticket][linked_chat][date_user_waiting]	DateTime	*	Since when the user has started waiting (i.e., time the assignment was 0).
data[][ticket][linked_chat][date_assigned]	DateTime	*
data[][ticket][linked_chat][date_agent_typing]	DateTime	*	Date when agent typed last time.
data[][ticket][linked_chat][date_first_agent_message]	DateTime	*
data[][ticket][linked_chat][date_ended]	DateTime	*	Date when chat was ended.
data[][ticket][linked_chat][total_to_ended]	integer	*
data[][ticket][linked_chat][ended_by]	string	*	Who ended the chat.
data[][ticket][linked_chat][should_send_transcript]	boolean	*	True if transcript should be send.
data[][ticket][linked_chat][date_transcript_sent]	DateTime	*	Date when transcript was sent.
data[][ticket][linked_chat][email_validation_code]	string	*
data[][ticket][linked_chat][email_validated]	boolean	*
data[][ticket][linked_chat][access_token]	string	*
data[][ticket][attachments][]	array of objects (TicketAttachment)	*
data[][ticket][attachments][][id]	integer	*	The unique ID.
data[][ticket][attachments][][ticket]	integer id (Ticket)	*	Ticket this attachment belongs to.
data[][ticket][attachments][][person]	integer id (Person)	*	Who created the attachment.
data[][ticket][attachments][][blob]	object (Blob)	*	Actual attachment.
data[][ticket][attachments][][blob][sys_name]	string	*	A unique system name for the blob.
data[][ticket][attachments][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][ticket][attachments][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][ticket][attachments][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][ticket][attachments][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][ticket][attachments][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][ticket][attachments][][blob][file_url]	string	*	The HTTP link to download the file.
data[][ticket][attachments][][blob][authcode]	string	*
data[][ticket][attachments][][blob][blob_hash]	string	*
data[][ticket][attachments][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][ticket][attachments][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][ticket][attachments][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][ticket][attachments][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][ticket][attachments][][blob][date_created]	DateTime	*
data[][ticket][attachments][][blob][is_temp]	boolean	*
data[][ticket][attachments][][blob][source_ref]	string	*
data[][ticket][attachments][][blob][labels][]	array of objects (LabelBlob)	*
data[][ticket][attachments][][blob][labels][][blob]	object (Blob)	*
data[][ticket][attachments][][message]	integer id (TicketMessage)	*	Message - holder of this attachment.
data[][ticket][attachments][][is_agent_note]	boolean	*	True if this attachmen just a note.
data[][ticket][attachments][][is_inline]	boolean	*	Is this attachment is embed in message.
data[][ticket][access_codes][]	array of objects (TicketAccessCode)	*
data[][ticket][access_codes][][id]	integer	*
data[][ticket][access_codes][][ticket]	object (Ticket)	*
data[][ticket][access_codes][][person]	object (Person)	*
data[][ticket][access_codes][][auth]	string	*
data[][ticket][messages][]	array of objects (TicketMessage)	*
data[][ticket][messages][][id]	integer	*	The unique id of message.
data[][ticket][messages][][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data[][ticket][messages][][person]	object (Person)	*	Person this message was sent by.
data[][ticket][messages][][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data[][ticket][messages][][email_source][id]	integer	*
data[][ticket][messages][][email_source][uuid]	string	*
data[][ticket][messages][][email_source][blob]	object (Blob)	*
data[][ticket][messages][][email_source][blob][sys_name]	string	*	A unique system name for the blob.
data[][ticket][messages][][email_source][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][ticket][messages][][email_source][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][ticket][messages][][email_source][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][ticket][messages][][email_source][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][ticket][messages][][email_source][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][ticket][messages][][email_source][blob][file_url]	string	*	The HTTP link to download the file.
data[][ticket][messages][][email_source][blob][authcode]	string	*
data[][ticket][messages][][email_source][blob][blob_hash]	string	*
data[][ticket][messages][][email_source][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][ticket][messages][][email_source][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][ticket][messages][][email_source][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][ticket][messages][][email_source][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][ticket][messages][][email_source][blob][date_created]	DateTime	*
data[][ticket][messages][][email_source][blob][is_temp]	boolean	*
data[][ticket][messages][][email_source][blob][source_ref]	string	*
data[][ticket][messages][][email_source][blob][labels][]	array of objects (LabelBlob)	*
data[][ticket][messages][][email_source][blob][labels][][blob]	object (Blob)	*
data[][ticket][messages][][email_source][object_type]	string	*	The type of object this is attached to (should be the table name of the super type, eg: tickets, people, organizations). This typically is not set until after the email is processed (ie the status is 'processed').
data[][ticket][messages][][email_source][object_id]	integer	*	The ID of the object this is attached to.
data[][ticket][messages][][email_source][from_email]	string	*
data[][ticket][messages][][email_source][status]	string	*	The current status of the message: - inserted: Only inserted - processing: Currently processing - complete: Fully processed - error: Tried to process but there was some kind of error (see error_code).
data[][ticket][messages][][email_source][date_status]	DateTime	*
data[][ticket][messages][][email_source][error_code]	string	*	When status is error, this is the code that describes the error.
data[][ticket][messages][][email_source][date_created]	DateTime	*
data[][ticket][messages][][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data[][ticket][messages][][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data[][ticket][messages][][snippet_use_logs][][id]	integer	*	The unique ID.
data[][ticket][messages][][snippet_use_logs][][snippet]	object (SnippetV2)	*	Snippet used.
data[][ticket][messages][][snippet_use_logs][][snippet][id]	integer	*
data[][ticket][messages][][snippet_use_logs][][snippet][title]	string	*
data[][ticket][messages][][snippet_use_logs][][snippet][author]	object (Person)	*
data[][ticket][messages][][snippet_use_logs][][snippet][is_private]	boolean	*
data[][ticket][messages][][snippet_use_logs][][snippet][avatar]	object (Blob)	*
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][sys_name]	string	*	A unique system name for the blob.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][file_url]	string	*	The HTTP link to download the file.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][authcode]	string	*
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][blob_hash]	string	*
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][date_created]	DateTime	*
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][is_temp]	boolean	*
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][source_ref]	string	*
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][labels][]	array of objects (LabelBlob)	*
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][labels][][blob]	object (Blob)	*
data[][ticket][messages][][snippet_use_logs][][snippet][status]	string	*
data[][ticket][messages][][snippet_use_logs][][snippet][shortcut_codes]	array	*
data[][ticket][messages][][snippet_use_logs][][snippet][inline_translations]	array	*
data[][ticket][messages][][snippet_use_logs][][snippet][translations][]	array of objects (SnippetV2Translation)	*
data[][ticket][messages][][snippet_use_logs][][snippet][translations][][id]	integer	*	The unique ID.
data[][ticket][messages][][snippet_use_logs][][snippet][translations][][snippet]	object (SnippetV2)	*	Snippet translated.
data[][ticket][messages][][snippet_use_logs][][snippet][translations][][language]	object (Language)	*
data[][ticket][messages][][snippet_use_logs][][snippet][translations][][content]	array	*	Snippet content.
data[][ticket][messages][][snippet_use_logs][][snippet][translations][][blobs][]	array of objects (Blob)	*
data[][ticket][messages][][snippet_use_logs][][snippet][categories][]	array of objects (SnippetV2Category)	*
data[][ticket][messages][][snippet_use_logs][][snippet][categories][][id]	integer	*
data[][ticket][messages][][snippet_use_logs][][snippet][categories][][title]	string	*
data[][ticket][messages][][snippet_use_logs][][snippet][categories][][is_global]	boolean	*
data[][ticket][messages][][snippet_use_logs][][snippet][categories][][display_order]	integer	*
data[][ticket][messages][][snippet_use_logs][][snippet][categories][][parent]	object (SnippetV2Category)	*
data[][ticket][messages][][snippet_use_logs][][snippet][categories][][agent_teams][]	array of objects (AgentTeam)	*
data[][ticket][messages][][snippet_use_logs][][snippet][display_order]	integer	*
data[][ticket][messages][][snippet_use_logs][][snippet][date_created]	DateTime	*
data[][ticket][messages][][snippet_use_logs][][ticket_message]	object (TicketMessage)	*	Ticket Message where the snippet was used.
data[][ticket][messages][][snippet_use_logs][][chat_message]	object (ChatMessage)	*	Chat Message where the snippet was used.
data[][ticket][messages][][snippet_use_logs][][chat_message][id]	integer	*	The unique ID.
data[][ticket][messages][][snippet_use_logs][][chat_message][author_id]	integer	*	Author id (legacy).
data[][ticket][messages][][snippet_use_logs][][chat_message][author_type]	string	*	Author type (legacy).
data[][ticket][messages][][snippet_use_logs][][chat_message][conversation_id]	integer	*	Conversation id (legacy).
data[][ticket][messages][][snippet_use_logs][][chat_message][author]	integer id (Person)	*	Person who created the message.
data[][ticket][messages][][snippet_use_logs][][chat_message][content]	string	*	The message.
data[][ticket][messages][][snippet_use_logs][][chat_message][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data[][ticket][messages][][snippet_use_logs][][chat_message][is_user]	boolean	*	Is this an user's message? (send from the widget).
data[][ticket][messages][][snippet_use_logs][][chat_message][is_html]	boolean	*	Is the content an HTML message?
data[][ticket][messages][][snippet_use_logs][][chat_message][metadata]	array	*	Additional data.
data[][ticket][messages][][snippet_use_logs][][chat_message][date_created]	DateTime	*	Date message was created.
data[][ticket][messages][][snippet_use_logs][][chat_message][date_received]	DateTime	*	Date message was received.
data[][ticket][messages][][snippet_use_logs][][language]	object (Language)	*	Snippet translated.
data[][ticket][messages][][snippet_use_logs][][person]	object (Person)	*
data[][ticket][messages][][snippet_use_logs][][rating]	integer	*
data[][ticket][messages][][snippet_use_logs][][rating_person]	object (Person)	*
data[][ticket][messages][][snippet_use_logs][][rating_message]	string	*
data[][ticket][messages][][snippet_use_logs][][date_created]	DateTime	*
data[][ticket][messages][][date_created]	DateTime	*	Date when message was created.
data[][ticket][messages][][is_agent_note]	boolean	*	Is this message agent note?
data[][ticket][messages][][is_hidden]	boolean	*	Is this message hidden?
data[][ticket][messages][][creation_system]	string	*	How this message was created.
data[][ticket][messages][][ip_address]	string	*	An ip address from which message was sent.
data[][ticket][messages][][visitor_id]	string	*	Unique ID of visitor left this message.
data[][ticket][messages][][hostname]	string	*	Host from which message was left.
data[][ticket][messages][][geo_country]	string	*	Country message is from (deprecated).
data[][ticket][messages][][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data[][ticket][messages][][message_hash]	string	*	An unique hash of message.
data[][ticket][messages][][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data[][ticket][messages][][primary_translation][id]	integer	*
data[][ticket][messages][][primary_translation][ticket]	object (Ticket)	*
data[][ticket][messages][][primary_translation][ticket_message]	object (TicketMessage)	*
data[][ticket][messages][][primary_translation][from_lang_code]	string	*
data[][ticket][messages][][primary_translation][lang_code]	string	*
data[][ticket][messages][][primary_translation][message]	string	*
data[][ticket][messages][][primary_translation][date_created]	DateTime	*
data[][ticket][messages][][message]	string	*	The message, will be in HTML!
data[][ticket][messages][][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data[][ticket][messages][][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data[][ticket][messages][][message_source]	string	*	The message source.
data[][ticket][messages][][message_source_type]	string	*	The message source type.
data[][ticket][messages][][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data[][ticket][messages][][lang_code]	string	*	The set/detected lang code.
data[][ticket][messages][][email_message_id][]	array of objects (TicketMessageEmailId)	*
data[][ticket][messages][][email_message_id][][id]	integer	*
data[][ticket][messages][][email_message_id][][message]	object (TicketMessage)	*
data[][ticket][messages][][email_message_id][][email_id]	string	*
data[][ticket][messages][][ticket_feedback][]	array of objects (TicketFeedback)	*
data[][ticket][messages][][ticket_feedback][][id]	integer	*
data[][ticket][messages][][ticket_feedback][][ticket]	object (Ticket)	*
data[][ticket][messages][][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data[][ticket][messages][][ticket_feedback][][person]	object (Person)	*
data[][ticket][messages][][ticket_feedback][][rating]	integer	*
data[][ticket][messages][][ticket_feedback][][message]	string	*
data[][ticket][messages][][ticket_feedback][][date_created]	DateTime	*
data[][ticket][messages][][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data[][ticket][messages][][ticket_message_forwards][][id]	integer	*
data[][ticket][messages][][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data[][ticket][messages][][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data[][ticket][messages][][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data[][ticket][messages][][ticket_message_forwards][][subject]	string	*
data[][ticket][messages][][ticket_message_forwards][][from_email]	string	*
data[][ticket][messages][][ticket_message_forwards][][tos]	array	*
data[][ticket][messages][][ticket_message_forwards][][ccs]	array	*
data[][ticket][messages][][ticket_message_forwards][][bccs]	array	*
data[][ticket][messages][][ticket_message_forwards][][message]	string	*
data[][ticket][messages][][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data[][ticket][messages][][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data[][ticket][messages][][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][ticket][messages][][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][ticket][messages][][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][ticket][messages][][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][ticket][messages][][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data[][ticket][messages][][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data[][ticket][messages][][ticket_message_forwards][][blobs][][authcode]	string	*
data[][ticket][messages][][ticket_message_forwards][][blobs][][blob_hash]	string	*
data[][ticket][messages][][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][ticket][messages][][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][ticket][messages][][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][ticket][messages][][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][ticket][messages][][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data[][ticket][messages][][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data[][ticket][messages][][ticket_message_forwards][][blobs][][source_ref]	string	*
data[][ticket][messages][][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data[][ticket][messages][][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data[][ticket][messages][][ticket_message_forwards][][date_created]	DateTime	*
data[][ticket][messages][][channel_message]	object (TicketMessageChannelMessage)	*
data[][ticket][messages][][channel_message][id]	integer	*	@var int The unique id of message.
data[][ticket][messages][][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data[][ticket][messages][][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data[][ticket][messages][][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data[][ticket][messages][][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data[][ticket][messages][][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data[][ticket][messages][][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data[][ticket][messages][][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data[][ticket][messages][][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data[][ticket][messages][][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data[][ticket][sms_messages][]	array of objects (TicketSms)	*
data[][ticket][sms_messages][][id]	integer	*
data[][ticket][sms_messages][][ticket]	object (Ticket)	*
data[][ticket][sms_messages][][person]	object (Person)	*
data[][ticket][sms_messages][][sms_account]	object (SmsAccount)	*
data[][ticket][sms_messages][][sms_account][id]	integer	*	The unique ID.
data[][ticket][sms_messages][][sms_account][type]	string	*
data[][ticket][sms_messages][][sms_account][params]	array	*
data[][ticket][sms_messages][][sms_account][identifier]	string	*
data[][ticket][sms_messages][][sms_account][is_enabled]	boolean	*
data[][ticket][sms_messages][][sms_account][is_connected]	boolean	*
data[][ticket][sms_messages][][sms_account][is_tested]	boolean	*
data[][ticket][sms_messages][][sms_account][test_code]	string	*
data[][ticket][sms_messages][][job]	object (Job)	*
data[][ticket][sms_messages][][job][id]	integer	*	The unique job id.
data[][ticket][sms_messages][][job][type]	string	*	The job type, used by the Job Router to find the right Job Processor.
data[][ticket][sms_messages][][job][status]	string	*	The status of the job.
data[][ticket][sms_messages][][job][status_code]	string	*	Any code to further classify the status.
data[][ticket][sms_messages][][job][date_touch]	DateTime	*	Date the last time a process "touched" this ticket.
data[][ticket][sms_messages][][job][date_created]	DateTime	*	Date this job entered the "jobs" table.
data[][ticket][sms_messages][][job][date_last_try]	DateTime	*	Last time we processed this job.
data[][ticket][sms_messages][][job][date_next_try]	DateTime	*	If this DateTime is in the future, it won't be selected for execution.
data[][ticket][sms_messages][][job][num_tries]	integer	*	The number of times this job has been executed Job Processor (usually indicated failures if > 1).
data[][ticket][sms_messages][][job][log_summary]	string	*	A human readable summary of the job's execution.
data[][ticket][sms_messages][][job][log]	string	*	A more verbose log.
data[][ticket][sms_messages][][job][data]	array	*	An array of data, or payload, that the job processor needs to execute this job (stored in the db as json). This MUST always be an array, even if its an empty array
data[][ticket][sms_messages][][job][original_job]	integer	*	Null unless the job was created as a retry - if so, the originating job ID is stored here so we can query it later. Note: You MUST specify the originating job, do not create a linked list of failed jobs.
data[][ticket][sms_messages][][date_created]	DateTime	*
data[][ticket][sms_messages][][from_number]	string	*	Permanent record of the phone number that sent this SMS. (Won't change even if Person changes their phone number).
data[][ticket][sms_messages][][to_number]	string	*	Permanent record of the phone number that this SMS was sent to.
data[][ticket][sms_messages][][message]	string	*	The SMS message.
data[][ticket][sms_messages][][direction]	string	*	Just a system flag for reporting.
data[][ticket][topic_links][]	array of objects (TicketCommunityTopicLink)	*
data[][ticket][topic_links][][id]	integer	*	The unique filter ID.
data[][ticket][topic_links][][ticket]	integer id (Ticket)	*
data[][ticket][topic_links][][topic]	integer id (CommunityTopic)	*
data[][ticket][topic_links][][person]	integer id (Person)	*
data[][ticket][topic_links][][date_created]	DateTime	*
data[][ticket][custom_data][]	array of objects (CustomDataTicket)	*
data[][ticket][custom_data][][ticket]	object (Ticket)	*
data[][ticket][custom_data][][field]	object (CustomDefTicket)	*
data[][ticket][custom_data][][field][parent]	object (CustomDefTicket)	*
data[][ticket][custom_data][][field][children][]	array of objects (CustomDefTicket)	*	Field children.
data[][ticket][custom_data][][root_field]	object (CustomDefTicket)	*
data[][ticket][labels][]	array of objects (LabelTicket)	*
data[][ticket][labels][][ticket]	object (Ticket)	*
data[][ticket][sent_to_address]	string	*	The email address the ticket was sent to if it came in via a gateway. This is a full string (e.g., including CC's) of the original.
data[][ticket][email_account]	object (EmailAccount)	*	The gateway this ticket originated from.
data[][ticket][email_account][id]	integer	*
data[][ticket][email_account][account_type]	string	*
data[][ticket][email_account][is_enabled]	boolean	*
data[][ticket][email_account][address]	string	*
data[][ticket][email_account][cert_blob]	object (Blob)	*
data[][ticket][email_account][cert_blob][sys_name]	string	*	A unique system name for the blob.
data[][ticket][email_account][cert_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][ticket][email_account][cert_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][ticket][email_account][cert_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][ticket][email_account][cert_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][ticket][email_account][cert_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][ticket][email_account][cert_blob][file_url]	string	*	The HTTP link to download the file.
data[][ticket][email_account][cert_blob][authcode]	string	*
data[][ticket][email_account][cert_blob][blob_hash]	string	*
data[][ticket][email_account][cert_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][ticket][email_account][cert_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][ticket][email_account][cert_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][ticket][email_account][cert_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][ticket][email_account][cert_blob][date_created]	DateTime	*
data[][ticket][email_account][cert_blob][is_temp]	boolean	*
data[][ticket][email_account][cert_blob][source_ref]	string	*
data[][ticket][email_account][cert_blob][labels][]	array of objects (LabelBlob)	*
data[][ticket][email_account][cert_blob][labels][][blob]	object (Blob)	*
data[][ticket][email_account][key_blob]	object (Blob)	*
data[][ticket][email_account_address]	string	*	The email address (from list of to/cc) that matched with the email account.
data[][ticket][creation_system]	string	*
data[][ticket][creation_system_option]	string	*	Optional information about the creation system. For example, source URL the ticket came from.
data[][ticket][ticket_hash]	string	*
data[][ticket][status]	string	*
data[][ticket][ticket_status]	object (TicketStatus)	*
data[][ticket][ticket_status][id]	integer	*
data[][ticket][ticket_status][status_type]	string	*
data[][ticket][ticket_status][status_code]	string	*
data[][ticket][ticket_status][sys_id]	string	*
data[][ticket][ticket_status][title]	string	*
data[][ticket][ticket_status][display_order]	integer	*
data[][ticket][ticket_status][pending_waiting_time_mode]	string	*	Where to count time spending in pending status. Check PENDING_WAITING_TIME_MODE_ constants
data[][ticket][ticket_status][children][]	array of objects (TicketStatus)	*
data[][ticket][ticket_status][options]	array	*
data[][ticket][urgency]	integer	*
data[][ticket][feedback_rating]	integer	*
data[][ticket][date_feedback_rating]	DateTime	*
data[][ticket][date_created]	DateTime	*
data[][ticket][date_resolved]	DateTime	*
data[][ticket][date_archived]	DateTime	*
data[][ticket][date_first_agent_assign]	DateTime	*
data[][ticket][date_first_agent_reply]	DateTime	*
data[][ticket][date_last_agent_reply]	DateTime	*
data[][ticket][date_last_user_reply]	DateTime	*
data[][ticket][date_agent_waiting]	DateTime	*
data[][ticket][date_user_waiting]	DateTime	*
data[][ticket][date_status]	DateTime	*
data[][ticket][date_on_hold]	DateTime	*
data[][ticket][total_user_waiting]	integer	*
data[][ticket][total_to_first_reply]	integer	*
data[][ticket][total_user_waiting_wh_start]	DateTime	*
data[][ticket][total_user_waiting_wh]	integer	*
data[][ticket][total_to_first_reply_wh]	integer	*
data[][ticket][locked_by_agent]	object (Person)	*
data[][ticket][date_locked]	DateTime	*
data[][ticket][has_attachments]	boolean	*
data[][ticket][subject]	string	*
data[][ticket][original_subject]	string	*
data[][ticket][properties]	array	*
data[][ticket][count_agent_replies]	integer	*
data[][ticket][count_user_replies]	integer	*
data[][ticket][worst_sla_status]	string	*
data[][ticket][waiting_times]	array	*	Used to track ticket status changes and how much time ticket was in status Add new item every time status changed This is optimisation over TicketLog.
data[][ticket][participants][]	array of objects (TicketParticipant)	*
data[][ticket][participants][][id]	integer	*
data[][ticket][participants][][ticket]	object (Ticket)	*
data[][ticket][participants][][person]	object (Person)	*
data[][ticket][participants][][access_code]	object (TicketAccessCode)	*
data[][ticket][participants][][person_email]	object (PersonEmail)	*
data[][ticket][participants][][default_on]	boolean	*	Default checkbox status of the user.
data[][ticket][charges][]	array of objects (TicketCharge)	*
data[][ticket][charges][][id]	integer	*
data[][ticket][charges][][charge_time]	integer	*
data[][ticket][charges][][amount]	float	*
data[][ticket][charges][][date_created]	DateTime	*
data[][ticket][charges][][ticket]	object (Ticket)	*
data[][ticket][charges][][person]	object (Person)	*
data[][ticket][charges][][organization]	object (Organization)	*
data[][ticket][charges][][agent]	object (Person)	*
data[][ticket][charges][][custom_data][]	array of objects (CustomDataBilling)	*
data[][ticket][charges][][custom_data][][ticket_charge]	object (TicketCharge)	*
data[][ticket][charges][][custom_data][][field]	object (CustomDefBilling)	*
data[][ticket][charges][][custom_data][][field][parent]	object (CustomDefBilling)	*
data[][ticket][charges][][custom_data][][field][children][]	array of objects (CustomDefBilling)	*	Field children.
data[][ticket][charges][][custom_data][][root_field]	object (CustomDefBilling)	*
data[][ticket][ticket_slas][]	array of objects (TicketSla)	*
data[][ticket][ticket_slas][][id]	integer	*	The unique ID.
data[][ticket][ticket_slas][][sla_status]	string	*	The SLA status.
data[][ticket][ticket_slas][][warn_date]	DateTime	*	The SLA warn date.
data[][ticket][ticket_slas][][fail_date]	DateTime	*	The SLA fail date.
data[][ticket][ticket_slas][][is_completed]	boolean	*	Is the SLA completed?
data[][ticket][ticket_slas][][is_completed_set]	boolean	*	Completed by automated action.
data[][ticket][ticket_slas][][completed_time_taken]	integer	*	Time taken.
data[][ticket][ticket_slas][][ticket]	integer id (Ticket)	*	Ticket.
data[][ticket][ticket_slas][][sla]	integer id (Sla)	*	SLA.
data[][ticket][ticket_slas][][date_applied]	DateTime	*	time and date when SLA was applied to the ticket.
data[][ticket][ticket_slas][][date_completed]	DateTime	*	time when SLA status became OK.
data[][ticket][jira_issues][]	array of objects (JiraIssue)	*	linked jira issues.
data[][ticket][jira_issues][][id]	integer	*	The unique ID.
data[][ticket][jira_issues][][ticket]	object (Ticket)	*	The associated DeskPRO ticket.
data[][ticket][jira_issues][][issue_id]	integer	*
data[][ticket][jira_issues][][status_id]	integer	*
data[][ticket][jira_issues][][created]	DateTime	*	Export time.
data[][ticket][problems][]	array of objects (Problem)	*
data[][ticket][problems][][id]	integer	*	The unique ID.
data[][ticket][problems][][title]	string	*	Problem title.
data[][ticket][problems][][creator]	integer id (Person)	*	Person who created the problem.
data[][ticket][problems][][created]	DateTime	*	Date when the problem was created.
data[][ticket][problems][][is_open]	boolean	*	Is problem still has no solution?
data[][ticket][problems][][tickets][]	array of integer ids (Ticket)	*	Tickets associated with problem.
data[][ticket][stars][]	array of objects (TicketFlagged)	*
data[][ticket][stars][][ticket]	object (Ticket)	*
data[][ticket][stars][][person_id]	integer	*
data[][ticket][stars][][color]	string	*
data[][ticket][follow_ups][]	array of objects (TicketFollowUp)	*
data[][ticket][follow_ups][][id]	integer	*	The unique ID.
data[][ticket][follow_ups][][person]	integer id (Person)	*
data[][ticket][follow_ups][][actions]	array	*
data[][ticket][follow_ups][][cancel_if_user_reply]	boolean	*
data[][ticket][follow_ups][][cancel_if_agent_reply]	boolean	*
data[][ticket][follow_ups][][status]	string	*
data[][ticket][follow_ups][][date_created]	DateTime	*
data[][ticket][follow_ups][][date_to_run]	DateTime	*
data[][ticket][follow_ups][][date_did_run]	DateTime	*
data[][ticket][logs][]	array of objects (TicketLog)	*
data[][ticket][logs][][id]	integer	*
data[][ticket][logs][][parent]	object (TicketLog)	*
data[][ticket][logs][][ticket]	object (Ticket)	*
data[][ticket][logs][][person]	object (Person)	*
data[][ticket][logs][][action_type]	string	*
data[][ticket][logs][][id_object]	integer	*	If the log involves a specific thing in a ticket (eg a message that was moved), then that is this id.
data[][ticket][logs][][id_before]	integer	*	The ID of the previous entity changed, or any other numeric value.
data[][ticket][logs][][id_after]	integer	*	The ID of the new entity, or any other numeric value.
data[][ticket][logs][][trigger_id]	integer	*	If the change was caused by a trigger, the trigger id. Note this is the integer ID (not a FK relation) so the record is kept even if the trigger itself is deleted.
data[][ticket][logs][][escalation_id]	integer	*	If the change was caused by an escalation Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data[][ticket][logs][][macro_id]	integer	*	If the change was caused by an v2 macro Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data[][ticket][logs][][sla]	object (Sla)	*	If the change was caused by an SLA, the SLA.
data[][ticket][logs][][sla][id]	integer	*	The unique ID.
data[][ticket][logs][][sla][title]	string	*	SLA title.
data[][ticket][logs][][sla][sla_type]	string	*	Type of SLA - first_response, resolution, waiting_time.
data[][ticket][logs][][sla][active_time]	string	*	Whether active all the time (all) or during work hours only (work_hours) or use the default ticket-wide settings (default).
data[][ticket][logs][][sla][work_start]	integer	*	When the work day starts. This is stored as the number of seconds after 00:00:00.
data[][ticket][logs][][sla][work_end]	integer	*	When the work day ends. This is stored as the number of seconds after 00:00:00.
data[][ticket][logs][][sla][work_days]	array	*	Array of work days, stored with keys corresponding to day numbers. Values are true. 0 = Sunday, 6 = Saturday (same as PHP, easy to convert to MySQL which is 1 = Sunday, 7 = Saturday).
data[][ticket][logs][][sla][work_timezone]	string	*	Timezone for work hours/days to be considered in.
data[][ticket][logs][][sla][work_holidays]	array	*	List of work holidays.
data[][ticket][logs][][sla][apply_type]	string	*	Controls how the SLA is applied to tickets: all, terms, terms_before_triggers, manual.
data[][ticket][logs][][sla][apply_terms]	object (TriggerTerms)	*	Conditions to apply.
data[][ticket][logs][][sla][apply_terms][version]	integer	*	Terms version.
data[][ticket][logs][][sla][apply_terms][terms]	array	*	Terms themselves.
data[][ticket][logs][][sla][trigger_terms]	object (TriggerTerms)	*	Conditions to consider sla completed.
data[][ticket][logs][][sla][warn_time]	integer	*	Warn time integer.
data[][ticket][logs][][sla][warn_time_unit]	string	*	And it's unit (see warn time).
data[][ticket][logs][][sla][warn_actions]	object (TriggerActions)	*	How to warn about SLA will fail.
data[][ticket][logs][][sla][warn_actions][version]	integer	*	Actions version.
data[][ticket][logs][][sla][warn_actions][actions]	array	*	Actions array representation.
data[][ticket][logs][][sla][fail_time]	integer	*	Fail time integer.
data[][ticket][logs][][sla][fail_time_unit]	string	*	And it's measuring unit (see fail_time).
data[][ticket][logs][][sla][fail_actions]	object (TriggerActions)	*	What to do if SLA failed.
data[][ticket][logs][][sla][exclude_ticket_statuses]	array	*	This SLA will not apply while tickets are in these pending statuses.
data[][ticket][logs][][sla_status]	string	*
data[][ticket][logs][][details]	array	*
data[][ticket][logs][][date_created]	DateTime	*
data[][ticket][chats][]	array of objects (ChatConversation)	*
data[][ticket][created_with_channel]	string	*
data[][ticket][last_channel_used]	string	*
data[][ticket][channels]	array	*
data[][ticket][pending_articles][]	array of objects (ArticlePendingCreate)	*
data[][ticket][pending_articles][][id]	integer	*
data[][ticket][pending_articles][][person]	integer id (Person)	*
data[][ticket][pending_articles][][assigned_person]	integer id (Person)	*
data[][ticket][pending_articles][][ticket]	integer id (Ticket)	*
data[][ticket][pending_articles][][message]	integer id (TicketMessage)	*
data[][ticket][pending_articles][][comment]	string	*
data[][ticket][pending_articles][][date_created]	DateTime	*
data[][ticket][summary]	object (TicketSummary)	*
data[][ticket][summary][id]	integer	*
data[][ticket][summary][ticket]	object (Ticket)	*
data[][ticket][summary][summary]	string	*
data[][ticket][summary][summary_input]	string	*
data[][ticket][summary][date_created]	DateTime	*
data[][person]	object (Person)	*
data[][organization]	object (Organization)	*
data[][organization][id]	integer	*	The unique ID.
data[][organization][picture_blob]	object (Blob)	*	The org picture.
data[][organization][picture_blob][sys_name]	string	*	A unique system name for the blob.
data[][organization][picture_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][organization][picture_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][organization][picture_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][organization][picture_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][organization][picture_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][organization][picture_blob][file_url]	string	*	The HTTP link to download the file.
data[][organization][picture_blob][authcode]	string	*
data[][organization][picture_blob][blob_hash]	string	*
data[][organization][picture_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][organization][picture_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][organization][picture_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][organization][picture_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][organization][picture_blob][date_created]	DateTime	*
data[][organization][picture_blob][is_temp]	boolean	*
data[][organization][picture_blob][source_ref]	string	*
data[][organization][picture_blob][labels][]	array of objects (LabelBlob)	*
data[][organization][picture_blob][labels][][blob]	object (Blob)	*
data[][organization][icon_property]	object (IconProperty)	*
data[][organization][icon_property][urn]	string	*
data[][organization][icon_property][options]	array	*
data[][organization][name]	string	*	The organization name.
data[][organization][summary]	string	*	The summary field as filled in by agents.
data[][organization][importance]	integer	*	The org importance.
data[][organization][custom_data][]	array of objects (CustomDataOrganization)	*
data[][organization][custom_data][][organization]	object (Organization)	*
data[][organization][custom_data][][field]	object (CustomDefOrganization)	*
data[][organization][custom_data][][field][parent]	object (CustomDefOrganization)	*	Field`s parent.
data[][organization][custom_data][][field][children][]	array of objects (CustomDefOrganization)	*	Field children.
data[][organization][custom_data][][root_field]	object (CustomDefOrganization)	*
data[][organization][usergroups][]	array of objects (Usergroup)	*	Usergroups the user belongs to.
data[][organization][usergroups][][id]	integer	*	The unique ID, DB-generated.
data[][organization][usergroups][][title]	string	*	Title of the usergroup.
data[][organization][usergroups][][note]	string	*	A note or description about the usergroup.
data[][organization][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data[][organization][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data[][organization][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data[][organization][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data[][organization][usergroups][][permissions][][id]	integer	*	The unique ID.
data[][organization][usergroups][][permissions][][name]	string	*	The name of the permission.
data[][organization][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][organization][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data[][organization][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data[][organization][usergroups][][department_permissions][][department]	integer id (Department)	*
data[][organization][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][organization][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data[][organization][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][organization][usergroups][][department_permissions][][is_active]	boolean	*
data[][organization][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data[][organization][auto_cc_people][]	array of objects (Person)	*	Users who are set to automatically be added to tickets and other org things.
data[][organization][labels][]	array of objects (LabelOrganization)	*
data[][organization][labels][][organization]	object (Organization)	*
data[][organization][contact_data][]	array of objects (OrganizationContactData)	*
data[][organization][emails][]	array of objects (OrganizationEmail)	*
data[][organization][emails][][id]	integer	*	The unique log id.
data[][organization][emails][][organization]	object (Organization)	*
data[][organization][emails][][email]	string	*
data[][organization][emails][][date_created]	DateTime	*
data[][organization][email_domains][]	array of objects (OrganizationEmailDomain)	*
data[][organization][email_domains][][domain]	string	*	The email domain.
data[][organization][email_domains][][organization]	object (Organization)	*	The users organization.
data[][organization][date_created]	DateTime	*	The date the org was inserted into the system.
data[][organization][members][]	array of objects (Person)	*
data[][organization][parent]	object (Organization)	*
data[][organization][children][]	array of objects (Organization)	*
data[][organization][tickets][]	array of objects (Ticket)	*
data[][organization][organization_members][]	array of objects (OrganizationMember)	*
data[][organization][organization_members][][id]	integer	*
data[][organization][organization_members][][person]	integer id (Person)	*
data[][organization][organization_members][][organization]	integer id (Organization)	*
data[][organization][organization_members][][is_manager]	boolean	*
data[][organization][organization_members][][position]	string	*
data[][organization][organization_members][][created_at]	DateTime	*
data[][organization][organization_members][][updated_at]	DateTime	*
data[][agent]	object (Person)	*
data[][custom_data][]	array of objects (CustomDataBilling)	*
data[][custom_data][][ticket_charge]	object (TicketCharge)	*
data[][custom_data][][ticket_charge][id]	integer	*
data[][custom_data][][ticket_charge][charge_time]	integer	*
data[][custom_data][][ticket_charge][amount]	float	*
data[][custom_data][][ticket_charge][date_created]	DateTime	*
data[][custom_data][][ticket_charge][ticket]	object (Ticket)	*
data[][custom_data][][ticket_charge][person]	object (Person)	*
data[][custom_data][][ticket_charge][organization]	object (Organization)	*
data[][custom_data][][ticket_charge][agent]	object (Person)	*
data[][custom_data][][ticket_charge][custom_data][]	array of objects (CustomDataBilling)	*
data[][custom_data][][field]	object (CustomDefBilling)	*
data[][custom_data][][field][parent]	object (CustomDefBilling)	*
data[][custom_data][][field][children][]	array of objects (CustomDefBilling)	*	Field children.
data[][custom_data][][root_field]	object (CustomDefBilling)	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/tickets/{parentId}/charges CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_charges.post

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Required?	Format
charge_time	integer	true
amount	float	true
date_created	string	false
comment	string	true
fields[1][mode]	string	false
fields[1][criteria]	string	false
fields[1][data]	string	true
fields[2][mode]	string	false
fields[2][criteria]	string	false
fields[2][data]	string	true
fields[3][mode]	string	false
fields[3][criteria]	string	false
fields[3][data]	choice	true
fields[7][mode]	string	false
fields[7][criteria]	string	false
fields[7][data]	boolean	true
fields[8][mode]	string	false
fields[8][criteria]	string	false
fields[8][data]	date	true	yyyy-MM-dd
fields[9][mode]	string	false
fields[9][criteria]	string	false
fields[9][data]	datetime	true	yyyy-MM-dd'T'HH:mm:ss

Parameter	Type	Versions	Description
data.id	integer	*
data.charge_time	integer	*
data.amount	float	*
data.date_created	DateTime	*
data.ticket	object (Ticket)	*
data.ticket[id]	integer	*
data.ticket[ref]	string	*
data.ticket[auth]	string	*
data.ticket[parent_ticket]	object (Ticket)	*	Parent ticket.
data.ticket[children_tickets][]	array of objects (Ticket)	*
data.ticket[language]	object (Language)	*	The language the ticket is in.
data.ticket[language][id]	integer	*	The unique ID.
data.ticket[language][sys_name]	string	*	The unique sys name assigned to the language.
data.ticket[language][title]	string	*	Title of the language.
data.ticket[language][title_local]	string	*	Title of the language.
data.ticket[language][base_filepath]	string	*	The base filepath for default phrases for this lang.
data.ticket[language][locale]	string	*	The locale code.
data.ticket[language][flag_image]	string	*	String path to image.
data.ticket[language][is_rtl]	boolean	*	True if this is a right-to-left language.
data.ticket[language][has_user]	boolean	*	True if has user.
data.ticket[language][has_agent]	boolean	*	True if has agent.
data.ticket[language][has_admin]	boolean	*	True if has admin.
data.ticket[language][plural_categories][]	array of strings	*
data.ticket[language][plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data.ticket[language][flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`
data.ticket[brand]	object (Brand)	*
data.ticket[brand][id]	integer	*	The unique ID.
data.ticket[brand][name]	string	*	The brand name.
data.ticket[brand][slug]	string	*
data.ticket[brand][url]	string	*	The brand url.
data.ticket[brand][theme_set]	object (ThemeSet)	*
data.ticket[brand][theme_set][id]	integer	*
data.ticket[brand][theme_set][theme_id]	string	*
data.ticket[brand][theme_set][title]	string	*
data.ticket[brand][theme_set][options]		*
data.ticket[brand][edit_theme_set]	object (ThemeSet)	*
data.ticket[brand][departments][]	array of objects (Department)	*
data.ticket[brand][departments][][id]	integer	*
data.ticket[brand][departments][][parent]	object (Department)	*
data.ticket[brand][departments][][children][]	array of objects (Department)	*
data.ticket[brand][departments][][title]	string	*
data.ticket[brand][departments][][user_title]	string	*
data.ticket[brand][departments][][is_tickets_enabled]	boolean	*
data.ticket[brand][departments][][is_chat_enabled]	boolean	*
data.ticket[brand][departments][][display_order]	integer	*
data.ticket[brand][departments][][avatar]	object (Blob)	*
data.ticket[brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.ticket[brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.ticket[brand][departments][][avatar][authcode]	string	*
data.ticket[brand][departments][][avatar][blob_hash]	string	*
data.ticket[brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[brand][departments][][avatar][date_created]	DateTime	*
data.ticket[brand][departments][][avatar][is_temp]	boolean	*
data.ticket[brand][departments][][avatar][source_ref]	string	*
data.ticket[brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.ticket[brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.ticket[brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.ticket[brand][departments][][brands][]	array of objects (Brand)	*
data.ticket[brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.ticket[brand][departments][][permissions][][department]	integer id (Department)	*
data.ticket[brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.ticket[brand][departments][][permissions][][name]	string	*	The name of the permission.
data.ticket[brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.ticket[brand][departments][][permissions][][is_active]	boolean	*
data.ticket[brand][departments][][chat_queue]	object (UserChatQueue)	*
data.ticket[brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.ticket[brand][departments][][chat_queue][name]	string	*
data.ticket[brand][departments][][chat_queue][routing_model]	string	*
data.ticket[brand][departments][][chat_queue][answer_timeout]	integer	*
data.ticket[brand][departments][][chat_queue][is_all_agents]	boolean	*
data.ticket[brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.ticket[brand][departments][][chat_queue][max_queue_size]	integer	*
data.ticket[brand][departments][][chat_queue][routingModel]		*
data.ticket[brand][theme_sets][]	array of objects (ThemeSet)	*
data.ticket[department]	object (Department)	*
data.ticket[department][id]	integer	*
data.ticket[department][parent]	object (Department)	*
data.ticket[department][children][]	array of objects (Department)	*
data.ticket[department][title]	string	*
data.ticket[department][user_title]	string	*
data.ticket[department][is_tickets_enabled]	boolean	*
data.ticket[department][is_chat_enabled]	boolean	*
data.ticket[department][display_order]	integer	*
data.ticket[department][avatar]	object (Blob)	*
data.ticket[department][avatar][sys_name]	string	*	A unique system name for the blob.
data.ticket[department][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[department][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[department][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[department][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[department][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[department][avatar][file_url]	string	*	The HTTP link to download the file.
data.ticket[department][avatar][authcode]	string	*
data.ticket[department][avatar][blob_hash]	string	*
data.ticket[department][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[department][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[department][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[department][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[department][avatar][date_created]	DateTime	*
data.ticket[department][avatar][is_temp]	boolean	*
data.ticket[department][avatar][source_ref]	string	*
data.ticket[department][avatar][labels][]	array of objects (LabelBlob)	*
data.ticket[department][avatar][labels][][blob]	object (Blob)	*
data.ticket[department][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.ticket[department][brands][]	array of objects (Brand)	*
data.ticket[department][permissions][]	array of objects (DepartmentPermission)	*
data.ticket[department][permissions][][department]	integer id (Department)	*
data.ticket[department][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.ticket[department][permissions][][name]	string	*	The name of the permission.
data.ticket[department][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.ticket[department][permissions][][is_active]	boolean	*
data.ticket[department][chat_queue]	object (UserChatQueue)	*
data.ticket[department][chat_queue][id]	integer	*	The unique ID.
data.ticket[department][chat_queue][name]	string	*
data.ticket[department][chat_queue][routing_model]	string	*
data.ticket[department][chat_queue][answer_timeout]	integer	*
data.ticket[department][chat_queue][is_all_agents]	boolean	*
data.ticket[department][chat_queue][departments][]	array of objects (Department)	*
data.ticket[department][chat_queue][max_queue_size]	integer	*
data.ticket[category]	object (TicketCategory)	*
data.ticket[category][id]	integer	*	The unique ID.
data.ticket[category][parent]	integer id (TicketCategory)	*	This category parent.
data.ticket[category][title]	string	*	Category title.
data.ticket[category][display_order]	integer	*	Obviously it's display order for lists.
data.ticket[priority]	object (TicketPriority)	*
data.ticket[priority][id]	integer	*	The unique ID.
data.ticket[priority][title]	string	*	Priority title.
data.ticket[priority][priority]	integer	*	The priority itself.
data.ticket[workflow]	object (TicketWorkflow)	*
data.ticket[workflow][id]	integer	*	The unique ID.
data.ticket[workflow][title]	string	*	Workflow title.
data.ticket[workflow][display_order]	integer	*	Workflow display order.
data.ticket[product]	object (Product)	*
data.ticket[product][parent]	integer id (Product)	*	Parent of the product.
data.ticket[product][title]		*
data.ticket[person]	object (Person)	*
data.ticket[person_email]	object (PersonEmail)	*
data.ticket[person_email][id]	integer	*	The unique ID.
data.ticket[person_email][person]	integer id (Person)	*	Person owner of email.
data.ticket[person_email][email]	string	*	The email address.
data.ticket[person_email][email_domain]	string	*	The email address domain.
data.ticket[person_email][is_validated]	boolean	*	True if validation passed.
data.ticket[person_email][date_created]	DateTime	*	The original time the email was created.
data.ticket[agent]	object (Person)	*
data.ticket[agent_team]	object (AgentTeam)	*
data.ticket[agent_team][id]	integer	*	The unique ID.
data.ticket[agent_team][name]	string	*	The name of agent team.
data.ticket[agent_team][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.ticket[agent_team][members]		*
data.ticket[organization]	object (Organization)	*
data.ticket[organization][id]	integer	*	The unique ID.
data.ticket[organization][picture_blob]	object (Blob)	*	The org picture.
data.ticket[organization][picture_blob][sys_name]	string	*	A unique system name for the blob.
data.ticket[organization][picture_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[organization][picture_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[organization][picture_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[organization][picture_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[organization][picture_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[organization][picture_blob][file_url]	string	*	The HTTP link to download the file.
data.ticket[organization][picture_blob][authcode]	string	*
data.ticket[organization][picture_blob][blob_hash]	string	*
data.ticket[organization][picture_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[organization][picture_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[organization][picture_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[organization][picture_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[organization][picture_blob][date_created]	DateTime	*
data.ticket[organization][picture_blob][is_temp]	boolean	*
data.ticket[organization][picture_blob][source_ref]	string	*
data.ticket[organization][picture_blob][labels][]	array of objects (LabelBlob)	*
data.ticket[organization][picture_blob][labels][][blob]	object (Blob)	*
data.ticket[organization][icon_property]	object (IconProperty)	*
data.ticket[organization][icon_property][urn]	string	*
data.ticket[organization][icon_property][options]	array	*
data.ticket[organization][name]	string	*	The organization name.
data.ticket[organization][summary]	string	*	The summary field as filled in by agents.
data.ticket[organization][importance]	integer	*	The org importance.
data.ticket[organization][custom_data][]	array of objects (CustomDataOrganization)	*
data.ticket[organization][custom_data][][organization]	object (Organization)	*
data.ticket[organization][custom_data][][field]	object (CustomDefOrganization)	*
data.ticket[organization][custom_data][][field][parent]	object (CustomDefOrganization)	*	Field`s parent.
data.ticket[organization][custom_data][][field][children][]	array of objects (CustomDefOrganization)	*	Field children.
data.ticket[organization][custom_data][][field][title]		*
data.ticket[organization][custom_data][][root_field]	object (CustomDefOrganization)	*
data.ticket[organization][usergroups][]	array of objects (Usergroup)	*	Usergroups the user belongs to.
data.ticket[organization][usergroups][][id]	integer	*	The unique ID, DB-generated.
data.ticket[organization][usergroups][][title]	string	*	Title of the usergroup.
data.ticket[organization][usergroups][][note]	string	*	A note or description about the usergroup.
data.ticket[organization][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.ticket[organization][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.ticket[organization][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.ticket[organization][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.ticket[organization][usergroups][][permissions][][id]	integer	*	The unique ID.
data.ticket[organization][usergroups][][permissions][][name]	string	*	The name of the permission.
data.ticket[organization][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.ticket[organization][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.ticket[organization][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.ticket[organization][usergroups][][department_permissions][][department]	integer id (Department)	*
data.ticket[organization][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.ticket[organization][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.ticket[organization][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.ticket[organization][usergroups][][department_permissions][][is_active]	boolean	*
data.ticket[organization][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.ticket[organization][auto_cc_people][]	array of objects (Person)	*	Users who are set to automatically be added to tickets and other org things.
data.ticket[organization][labels][]	array of objects (LabelOrganization)	*
data.ticket[organization][labels][][organization]	object (Organization)	*
data.ticket[organization][contact_data][]	array of objects (OrganizationContactData)	*
data.ticket[organization][contact_data][][organization]		*
data.ticket[organization][contact_data][][contact_type]		*
data.ticket[organization][contact_data][][comment]		*
data.ticket[organization][contact_data][][field_1]		*
data.ticket[organization][contact_data][][field_2]		*
data.ticket[organization][contact_data][][field_3]		*
data.ticket[organization][contact_data][][field_5]		*
data.ticket[organization][contact_data][][field_9]		*
data.ticket[organization][emails][]	array of objects (OrganizationEmail)	*
data.ticket[organization][emails][][id]	integer	*	The unique log id.
data.ticket[organization][emails][][organization]	object (Organization)	*
data.ticket[organization][emails][][email]	string	*
data.ticket[organization][emails][][date_created]	DateTime	*
data.ticket[organization][email_domains][]	array of objects (OrganizationEmailDomain)	*
data.ticket[organization][email_domains][][domain]	string	*	The email domain.
data.ticket[organization][email_domains][][organization]	object (Organization)	*	The users organization.
data.ticket[organization][date_created]	DateTime	*	The date the org was inserted into the system.
data.ticket[organization][members][]	array of objects (Person)	*
data.ticket[organization][parent]	object (Organization)	*
data.ticket[organization][children][]	array of objects (Organization)	*
data.ticket[organization][tickets][]	array of objects (Ticket)	*
data.ticket[organization][organization_members][]	array of objects (OrganizationMember)	*
data.ticket[organization][organization_members][][id]	integer	*
data.ticket[organization][organization_members][][person]	integer id (Person)	*
data.ticket[organization][organization_members][][organization]	integer id (Organization)	*
data.ticket[organization][organization_members][][is_manager]	boolean	*
data.ticket[organization][organization_members][][position]	string	*
data.ticket[organization][organization_members][][created_at]	DateTime	*
data.ticket[organization][organization_members][][updated_at]	DateTime	*
data.ticket[organization][publicUsergroups]		*
data.ticket[linked_chat]	object (ChatConversation)	*
data.ticket[linked_chat][id]	integer	*	The unique id of chat conversation.
data.ticket[linked_chat][department]	object (Department)	*	Department which chat was assigned.
data.ticket[linked_chat][brand]	object (Brand)	*	Department which chat was assigned.
data.ticket[linked_chat][task_id]	integer	*
data.ticket[linked_chat][ticket]	object (Ticket)	*
data.ticket[linked_chat][labels][]	array of objects (LabelChatConversation)	*
data.ticket[linked_chat][labels][][chat]	object (ChatConversation)	*
data.ticket[linked_chat][subject]	string	*	Subject of the chat conversation.
data.ticket[linked_chat][status]	string	*	Status of the chat conversation.
data.ticket[linked_chat][agent]	object (Person)	*	If this is a user conversation, this is the agent assigned.
data.ticket[linked_chat][agent_team]	object (AgentTeam)	*	If this is a team chat, the team it is.
data.ticket[linked_chat][person]	object (Person)	*	If this is a user conversation, this is the user who started the chat.
data.ticket[linked_chat][session]	object (Session)	*	If this is a user convo, this is the users session.
data.ticket[linked_chat][session][id]	integer	*	The unique ID.
data.ticket[linked_chat][session][auth]	string	*	The authcode for the session to verify an id.
data.ticket[linked_chat][session][interface]	string	*	The Interface the session is for.
data.ticket[linked_chat][session][person]	object (Person)	*
data.ticket[linked_chat][session][user_agent]	string	*	The users user agent string.
data.ticket[linked_chat][session][visitor_id]	string	*
data.ticket[linked_chat][session][ip_address]	string	*	The users IP address.
data.ticket[linked_chat][session][data]	string	*
data.ticket[linked_chat][session][is_person]	boolean	*
data.ticket[linked_chat][session][is_bot]	boolean	*
data.ticket[linked_chat][session][is_helpdesk]	boolean	*
data.ticket[linked_chat][session][active_status]	string	*	(Agents) Status (available or away).
data.ticket[linked_chat][session][is_chat_available]	boolean	*	(Agents) Wehn status is available, if they are available for chat.
data.ticket[linked_chat][session][date_created]	DateTime	*
data.ticket[linked_chat][session][date_last]	DateTime	*
data.ticket[linked_chat][session][date_last_page]	DateTime	*
data.ticket[linked_chat][visitor_id]	string	*
data.ticket[linked_chat][person_name]	string	*	User chat: The users name, if they arent a person.
data.ticket[linked_chat][person_email]	string	*	User chat: The users email, if they aren`t a person.
data.ticket[linked_chat][participants][]	array of objects (Person)	*
data.ticket[linked_chat][messages][]	array of objects (ChatMessage)	*
data.ticket[linked_chat][messages][][id]	integer	*	The unique ID.
data.ticket[linked_chat][messages][][author_id]	integer	*	Author id (legacy).
data.ticket[linked_chat][messages][][author_type]	string	*	Author type (legacy).
data.ticket[linked_chat][messages][][conversation_id]	integer	*	Conversation id (legacy).
data.ticket[linked_chat][messages][][author]	integer id (Person)	*	Person who created the message.
data.ticket[linked_chat][messages][][content]	string	*	The message.
data.ticket[linked_chat][messages][][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.ticket[linked_chat][messages][][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.ticket[linked_chat][messages][][is_html]	boolean	*	Is the content an HTML message?
data.ticket[linked_chat][messages][][metadata]	array	*	Additional data.
data.ticket[linked_chat][messages][][date_created]	DateTime	*	Date message was created.
data.ticket[linked_chat][messages][][date_received]	DateTime	*	Date message was received.
data.ticket[linked_chat][custom_data][]	array of objects (CustomDataChat)	*
data.ticket[linked_chat][custom_data][][conversation]	object (ChatConversation)	*	The conversation the message belongs to.
data.ticket[linked_chat][custom_data][][field]	object (CustomDefChat)	*
data.ticket[linked_chat][custom_data][][field][parent]	object (CustomDefChat)	*
data.ticket[linked_chat][custom_data][][field][children][]	array of objects (CustomDefChat)	*	Field children.
data.ticket[linked_chat][custom_data][][field][title]		*
data.ticket[linked_chat][custom_data][][root_field]	object (CustomDefChat)	*
data.ticket[linked_chat][rating_response_time]	integer	*
data.ticket[linked_chat][rating_overall]	integer	*
data.ticket[linked_chat][rating_comment]	string	*
data.ticket[linked_chat][is_agent]	boolean	*	Is this an agent chat.
data.ticket[linked_chat][is_window]	boolean	*	If the chat is popped out into a window. This is used to make sure the JS widget on pages doesn't load again.
data.ticket[linked_chat][date_created]	DateTime	*	Date when chat was started.
data.ticket[linked_chat][date_user_waiting]	DateTime	*	Since when the user has started waiting (i.e., time the assignment was 0).
data.ticket[linked_chat][date_assigned]	DateTime	*
data.ticket[linked_chat][date_agent_typing]	DateTime	*	Date when agent typed last time.
data.ticket[linked_chat][date_first_agent_message]	DateTime	*
data.ticket[linked_chat][date_ended]	DateTime	*	Date when chat was ended.
data.ticket[linked_chat][total_to_ended]	integer	*
data.ticket[linked_chat][ended_by]	string	*	Who ended the chat.
data.ticket[linked_chat][should_send_transcript]	boolean	*	True if transcript should be send.
data.ticket[linked_chat][date_transcript_sent]	DateTime	*	Date when transcript was sent.
data.ticket[linked_chat][email_validation_code]	string	*
data.ticket[linked_chat][email_validated]	boolean	*
data.ticket[linked_chat][access_token]	string	*
data.ticket[attachments][]	array of objects (TicketAttachment)	*
data.ticket[attachments][][id]	integer	*	The unique ID.
data.ticket[attachments][][ticket]	integer id (Ticket)	*	Ticket this attachment belongs to.
data.ticket[attachments][][person]	integer id (Person)	*	Who created the attachment.
data.ticket[attachments][][blob]	object (Blob)	*	Actual attachment.
data.ticket[attachments][][blob][sys_name]	string	*	A unique system name for the blob.
data.ticket[attachments][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[attachments][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[attachments][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[attachments][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[attachments][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[attachments][][blob][file_url]	string	*	The HTTP link to download the file.
data.ticket[attachments][][blob][authcode]	string	*
data.ticket[attachments][][blob][blob_hash]	string	*
data.ticket[attachments][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[attachments][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[attachments][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[attachments][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[attachments][][blob][date_created]	DateTime	*
data.ticket[attachments][][blob][is_temp]	boolean	*
data.ticket[attachments][][blob][source_ref]	string	*
data.ticket[attachments][][blob][labels][]	array of objects (LabelBlob)	*
data.ticket[attachments][][blob][labels][][blob]	object (Blob)	*
data.ticket[attachments][][message]	integer id (TicketMessage)	*	Message - holder of this attachment.
data.ticket[attachments][][is_agent_note]	boolean	*	True if this attachmen just a note.
data.ticket[attachments][][is_inline]	boolean	*	Is this attachment is embed in message.
data.ticket[access_codes][]	array of objects (TicketAccessCode)	*
data.ticket[access_codes][][id]	integer	*
data.ticket[access_codes][][ticket]	object (Ticket)	*
data.ticket[access_codes][][person]	object (Person)	*
data.ticket[access_codes][][auth]	string	*
data.ticket[messages][]	array of objects (TicketMessage)	*
data.ticket[messages][][id]	integer	*	The unique id of message.
data.ticket[messages][][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data.ticket[messages][][person]	object (Person)	*	Person this message was sent by.
data.ticket[messages][][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data.ticket[messages][][email_source][id]	integer	*
data.ticket[messages][][email_source][uuid]	string	*
data.ticket[messages][][email_source][blob]	object (Blob)	*
data.ticket[messages][][email_source][blob][sys_name]	string	*	A unique system name for the blob.
data.ticket[messages][][email_source][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[messages][][email_source][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[messages][][email_source][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[messages][][email_source][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[messages][][email_source][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[messages][][email_source][blob][file_url]	string	*	The HTTP link to download the file.
data.ticket[messages][][email_source][blob][authcode]	string	*
data.ticket[messages][][email_source][blob][blob_hash]	string	*
data.ticket[messages][][email_source][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[messages][][email_source][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[messages][][email_source][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[messages][][email_source][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[messages][][email_source][blob][date_created]	DateTime	*
data.ticket[messages][][email_source][blob][is_temp]	boolean	*
data.ticket[messages][][email_source][blob][source_ref]	string	*
data.ticket[messages][][email_source][blob][labels][]	array of objects (LabelBlob)	*
data.ticket[messages][][email_source][blob][labels][][blob]	object (Blob)	*
data.ticket[messages][][email_source][object_type]	string	*	The type of object this is attached to (should be the table name of the super type, eg: tickets, people, organizations). This typically is not set until after the email is processed (ie the status is 'processed').
data.ticket[messages][][email_source][object_id]	integer	*	The ID of the object this is attached to.
data.ticket[messages][][email_source][from_email]	string	*
data.ticket[messages][][email_source][status]	string	*	The current status of the message: - inserted: Only inserted - processing: Currently processing - complete: Fully processed - error: Tried to process but there was some kind of error (see error_code).
data.ticket[messages][][email_source][date_status]	DateTime	*
data.ticket[messages][][email_source][error_code]	string	*	When status is error, this is the code that describes the error.
data.ticket[messages][][email_source][date_created]	DateTime	*
data.ticket[messages][][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.ticket[messages][][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.ticket[messages][][snippet_use_logs][][id]	integer	*	The unique ID.
data.ticket[messages][][snippet_use_logs][][snippet]	object (SnippetV2)	*	Snippet used.
data.ticket[messages][][snippet_use_logs][][snippet][id]	integer	*
data.ticket[messages][][snippet_use_logs][][snippet][title]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][author]	object (Person)	*
data.ticket[messages][][snippet_use_logs][][snippet][is_private]	boolean	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar]	object (Blob)	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][sys_name]	string	*	A unique system name for the blob.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][file_url]	string	*	The HTTP link to download the file.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][authcode]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][blob_hash]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][date_created]	DateTime	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][is_temp]	boolean	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][source_ref]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][labels][]	array of objects (LabelBlob)	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][labels][][blob]	object (Blob)	*
data.ticket[messages][][snippet_use_logs][][snippet][status]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][shortcut_codes]	array	*
data.ticket[messages][][snippet_use_logs][][snippet][inline_translations]	array	*
data.ticket[messages][][snippet_use_logs][][snippet][translations][]	array of objects (SnippetV2Translation)	*
data.ticket[messages][][snippet_use_logs][][snippet][translations][][id]	integer	*	The unique ID.
data.ticket[messages][][snippet_use_logs][][snippet][translations][][snippet]	object (SnippetV2)	*	Snippet translated.
data.ticket[messages][][snippet_use_logs][][snippet][translations][][language]	object (Language)	*
data.ticket[messages][][snippet_use_logs][][snippet][translations][][content]	array	*	Snippet content.
data.ticket[messages][][snippet_use_logs][][snippet][translations][][blobs][]	array of objects (Blob)	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][]	array of objects (SnippetV2Category)	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][id]	integer	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][title]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][is_global]	boolean	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][display_order]	integer	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][parent]	object (SnippetV2Category)	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][agent_teams][]	array of objects (AgentTeam)	*
data.ticket[messages][][snippet_use_logs][][snippet][display_order]	integer	*
data.ticket[messages][][snippet_use_logs][][snippet][date_created]	DateTime	*
data.ticket[messages][][snippet_use_logs][][ticket_message]	object (TicketMessage)	*	Ticket Message where the snippet was used.
data.ticket[messages][][snippet_use_logs][][chat_message]	object (ChatMessage)	*	Chat Message where the snippet was used.
data.ticket[messages][][snippet_use_logs][][chat_message][id]	integer	*	The unique ID.
data.ticket[messages][][snippet_use_logs][][chat_message][author_id]	integer	*	Author id (legacy).
data.ticket[messages][][snippet_use_logs][][chat_message][author_type]	string	*	Author type (legacy).
data.ticket[messages][][snippet_use_logs][][chat_message][conversation_id]	integer	*	Conversation id (legacy).
data.ticket[messages][][snippet_use_logs][][chat_message][author]	integer id (Person)	*	Person who created the message.
data.ticket[messages][][snippet_use_logs][][chat_message][content]	string	*	The message.
data.ticket[messages][][snippet_use_logs][][chat_message][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.ticket[messages][][snippet_use_logs][][chat_message][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.ticket[messages][][snippet_use_logs][][chat_message][is_html]	boolean	*	Is the content an HTML message?
data.ticket[messages][][snippet_use_logs][][chat_message][metadata]	array	*	Additional data.
data.ticket[messages][][snippet_use_logs][][chat_message][date_created]	DateTime	*	Date message was created.
data.ticket[messages][][snippet_use_logs][][chat_message][date_received]	DateTime	*	Date message was received.
data.ticket[messages][][snippet_use_logs][][language]	object (Language)	*	Snippet translated.
data.ticket[messages][][snippet_use_logs][][person]	object (Person)	*
data.ticket[messages][][snippet_use_logs][][rating]	integer	*
data.ticket[messages][][snippet_use_logs][][rating_person]	object (Person)	*
data.ticket[messages][][snippet_use_logs][][rating_message]	string	*
data.ticket[messages][][snippet_use_logs][][date_created]	DateTime	*
data.ticket[messages][][date_created]	DateTime	*	Date when message was created.
data.ticket[messages][][is_agent_note]	boolean	*	Is this message agent note?
data.ticket[messages][][is_hidden]	boolean	*	Is this message hidden?
data.ticket[messages][][creation_system]	string	*	How this message was created.
data.ticket[messages][][ip_address]	string	*	An ip address from which message was sent.
data.ticket[messages][][visitor_id]	string	*	Unique ID of visitor left this message.
data.ticket[messages][][hostname]	string	*	Host from which message was left.
data.ticket[messages][][geo_country]	string	*	Country message is from (deprecated).
data.ticket[messages][][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.ticket[messages][][message_hash]	string	*	An unique hash of message.
data.ticket[messages][][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.ticket[messages][][primary_translation][id]	integer	*
data.ticket[messages][][primary_translation][ticket]	object (Ticket)	*
data.ticket[messages][][primary_translation][ticket_message]	object (TicketMessage)	*
data.ticket[messages][][primary_translation][from_lang_code]	string	*
data.ticket[messages][][primary_translation][lang_code]	string	*
data.ticket[messages][][primary_translation][message]	string	*
data.ticket[messages][][primary_translation][date_created]	DateTime	*
data.ticket[messages][][message]	string	*	The message, will be in HTML!
data.ticket[messages][][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.ticket[messages][][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.ticket[messages][][message_source]	string	*	The message source.
data.ticket[messages][][message_source_type]	string	*	The message source type.
data.ticket[messages][][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.ticket[messages][][lang_code]	string	*	The set/detected lang code.
data.ticket[messages][][email_message_id][]	array of objects (TicketMessageEmailId)	*
data.ticket[messages][][email_message_id][][id]	integer	*
data.ticket[messages][][email_message_id][][message]	object (TicketMessage)	*
data.ticket[messages][][email_message_id][][email_id]	string	*
data.ticket[messages][][ticket_feedback][]	array of objects (TicketFeedback)	*
data.ticket[messages][][ticket_feedback][][id]	integer	*
data.ticket[messages][][ticket_feedback][][ticket]	object (Ticket)	*
data.ticket[messages][][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data.ticket[messages][][ticket_feedback][][person]	object (Person)	*
data.ticket[messages][][ticket_feedback][][rating]	integer	*
data.ticket[messages][][ticket_feedback][][message]	string	*
data.ticket[messages][][ticket_feedback][][date_created]	DateTime	*
data.ticket[messages][][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data.ticket[messages][][ticket_message_forwards][][id]	integer	*
data.ticket[messages][][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data.ticket[messages][][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data.ticket[messages][][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data.ticket[messages][][ticket_message_forwards][][subject]	string	*
data.ticket[messages][][ticket_message_forwards][][from_email]	string	*
data.ticket[messages][][ticket_message_forwards][][tos]	array	*
data.ticket[messages][][ticket_message_forwards][][ccs]	array	*
data.ticket[messages][][ticket_message_forwards][][bccs]	array	*
data.ticket[messages][][ticket_message_forwards][][message]	string	*
data.ticket[messages][][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data.ticket[messages][][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data.ticket[messages][][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[messages][][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[messages][][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[messages][][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[messages][][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[messages][][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data.ticket[messages][][ticket_message_forwards][][blobs][][authcode]	string	*
data.ticket[messages][][ticket_message_forwards][][blobs][][blob_hash]	string	*
data.ticket[messages][][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[messages][][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[messages][][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[messages][][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[messages][][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data.ticket[messages][][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data.ticket[messages][][ticket_message_forwards][][blobs][][source_ref]	string	*
data.ticket[messages][][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data.ticket[messages][][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data.ticket[messages][][ticket_message_forwards][][date_created]	DateTime	*
data.ticket[messages][][channel_message]	object (TicketMessageChannelMessage)	*
data.ticket[messages][][channel_message][id]	integer	*	@var int The unique id of message.
data.ticket[messages][][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data.ticket[messages][][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data.ticket[messages][][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data.ticket[messages][][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data.ticket[messages][][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data.ticket[messages][][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data.ticket[messages][][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data.ticket[messages][][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data.ticket[messages][][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data.ticket[sms_messages][]	array of objects (TicketSms)	*
data.ticket[sms_messages][][id]	integer	*
data.ticket[sms_messages][][ticket]	object (Ticket)	*
data.ticket[sms_messages][][person]	object (Person)	*
data.ticket[sms_messages][][sms_account]	object (SmsAccount)	*
data.ticket[sms_messages][][sms_account][id]	integer	*	The unique ID.
data.ticket[sms_messages][][sms_account][type]	string	*
data.ticket[sms_messages][][sms_account][params]	array	*
data.ticket[sms_messages][][sms_account][identifier]	string	*
data.ticket[sms_messages][][sms_account][is_enabled]	boolean	*
data.ticket[sms_messages][][sms_account][is_connected]	boolean	*
data.ticket[sms_messages][][sms_account][is_tested]	boolean	*
data.ticket[sms_messages][][sms_account][test_code]	string	*
data.ticket[sms_messages][][job]	object (Job)	*
data.ticket[sms_messages][][job][id]	integer	*	The unique job id.
data.ticket[sms_messages][][job][type]	string	*	The job type, used by the Job Router to find the right Job Processor.
data.ticket[sms_messages][][job][status]	string	*	The status of the job.
data.ticket[sms_messages][][job][status_code]	string	*	Any code to further classify the status.
data.ticket[sms_messages][][job][date_touch]	DateTime	*	Date the last time a process "touched" this ticket.
data.ticket[sms_messages][][job][date_created]	DateTime	*	Date this job entered the "jobs" table.
data.ticket[sms_messages][][job][date_last_try]	DateTime	*	Last time we processed this job.
data.ticket[sms_messages][][job][date_next_try]	DateTime	*	If this DateTime is in the future, it won't be selected for execution.
data.ticket[sms_messages][][job][num_tries]	integer	*	The number of times this job has been executed Job Processor (usually indicated failures if > 1).
data.ticket[sms_messages][][job][log_summary]	string	*	A human readable summary of the job's execution.
data.ticket[sms_messages][][job][log]	string	*	A more verbose log.
data.ticket[sms_messages][][job][data]	array	*	An array of data, or payload, that the job processor needs to execute this job (stored in the db as json). This MUST always be an array, even if its an empty array
data.ticket[sms_messages][][job][original_job]	integer	*	Null unless the job was created as a retry - if so, the originating job ID is stored here so we can query it later. Note: You MUST specify the originating job, do not create a linked list of failed jobs.
data.ticket[sms_messages][][date_created]	DateTime	*
data.ticket[sms_messages][][from_number]	string	*	Permanent record of the phone number that sent this SMS. (Won't change even if Person changes their phone number).
data.ticket[sms_messages][][to_number]	string	*	Permanent record of the phone number that this SMS was sent to.
data.ticket[sms_messages][][message]	string	*	The SMS message.
data.ticket[sms_messages][][direction]	string	*	Just a system flag for reporting.
data.ticket[topic_links][]	array of objects (TicketCommunityTopicLink)	*
data.ticket[topic_links][][id]	integer	*	The unique filter ID.
data.ticket[topic_links][][ticket]	integer id (Ticket)	*
data.ticket[topic_links][][topic]	integer id (CommunityTopic)	*
data.ticket[topic_links][][person]	integer id (Person)	*
data.ticket[topic_links][][date_created]	DateTime	*
data.ticket[custom_data][]	array of objects (CustomDataTicket)	*
data.ticket[custom_data][][ticket]	object (Ticket)	*
data.ticket[custom_data][][field]	object (CustomDefTicket)	*
data.ticket[custom_data][][field][parent]	object (CustomDefTicket)	*
data.ticket[custom_data][][field][children][]	array of objects (CustomDefTicket)	*	Field children.
data.ticket[custom_data][][field][title]		*
data.ticket[custom_data][][root_field]	object (CustomDefTicket)	*
data.ticket[labels][]	array of objects (LabelTicket)	*
data.ticket[labels][][ticket]	object (Ticket)	*
data.ticket[sent_to_address]	string	*	The email address the ticket was sent to if it came in via a gateway. This is a full string (e.g., including CC's) of the original.
data.ticket[email_account]	object (EmailAccount)	*	The gateway this ticket originated from.
data.ticket[email_account][id]	integer	*
data.ticket[email_account][account_type]	string	*
data.ticket[email_account][is_enabled]	boolean	*
data.ticket[email_account][address]	string	*
data.ticket[email_account][cert_blob]	object (Blob)	*
data.ticket[email_account][cert_blob][sys_name]	string	*	A unique system name for the blob.
data.ticket[email_account][cert_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[email_account][cert_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[email_account][cert_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[email_account][cert_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[email_account][cert_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[email_account][cert_blob][file_url]	string	*	The HTTP link to download the file.
data.ticket[email_account][cert_blob][authcode]	string	*
data.ticket[email_account][cert_blob][blob_hash]	string	*
data.ticket[email_account][cert_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[email_account][cert_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[email_account][cert_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[email_account][cert_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[email_account][cert_blob][date_created]	DateTime	*
data.ticket[email_account][cert_blob][is_temp]	boolean	*
data.ticket[email_account][cert_blob][source_ref]	string	*
data.ticket[email_account][cert_blob][labels][]	array of objects (LabelBlob)	*
data.ticket[email_account][cert_blob][labels][][blob]	object (Blob)	*
data.ticket[email_account][key_blob]	object (Blob)	*
data.ticket[email_account_address]	string	*	The email address (from list of to/cc) that matched with the email account.
data.ticket[creation_system]	string	*
data.ticket[creation_system_option]	string	*	Optional information about the creation system. For example, source URL the ticket came from.
data.ticket[ticket_hash]	string	*
data.ticket[status]	string	*
data.ticket[ticket_status]	object (TicketStatus)	*
data.ticket[ticket_status][id]	integer	*
data.ticket[ticket_status][status_type]	string	*
data.ticket[ticket_status][status_code]	string	*
data.ticket[ticket_status][sys_id]	string	*
data.ticket[ticket_status][title]	string	*
data.ticket[ticket_status][display_order]	integer	*
data.ticket[ticket_status][pending_waiting_time_mode]	string	*	Where to count time spending in pending status. Check PENDING_WAITING_TIME_MODE_ constants
data.ticket[ticket_status][children][]	array of objects (TicketStatus)	*
data.ticket[ticket_status][options]	array	*
data.ticket[ticket_status][statusType]		*
data.ticket[ticket_status][displayOrder]	integer	*
data.ticket[urgency]	integer	*
data.ticket[feedback_rating]	integer	*
data.ticket[date_feedback_rating]	DateTime	*
data.ticket[date_created]	DateTime	*
data.ticket[date_resolved]	DateTime	*
data.ticket[date_archived]	DateTime	*
data.ticket[date_first_agent_assign]	DateTime	*
data.ticket[date_first_agent_reply]	DateTime	*
data.ticket[date_last_agent_reply]	DateTime	*
data.ticket[date_last_user_reply]	DateTime	*
data.ticket[date_agent_waiting]	DateTime	*
data.ticket[date_user_waiting]	DateTime	*
data.ticket[date_status]	DateTime	*
data.ticket[date_on_hold]	DateTime	*
data.ticket[total_user_waiting]	integer	*
data.ticket[total_to_first_reply]	integer	*
data.ticket[total_user_waiting_wh_start]	DateTime	*
data.ticket[total_user_waiting_wh]	integer	*
data.ticket[total_to_first_reply_wh]	integer	*
data.ticket[locked_by_agent]	object (Person)	*
data.ticket[date_locked]	DateTime	*
data.ticket[has_attachments]	boolean	*
data.ticket[subject]	string	*
data.ticket[original_subject]	string	*
data.ticket[properties]	array	*
data.ticket[count_agent_replies]	integer	*
data.ticket[count_user_replies]	integer	*
data.ticket[worst_sla_status]	string	*
data.ticket[waiting_times]	array	*	Used to track ticket status changes and how much time ticket was in status Add new item every time status changed This is optimisation over TicketLog.
data.ticket[participants][]	array of objects (TicketParticipant)	*
data.ticket[participants][][id]	integer	*
data.ticket[participants][][ticket]	object (Ticket)	*
data.ticket[participants][][person]	object (Person)	*
data.ticket[participants][][access_code]	object (TicketAccessCode)	*
data.ticket[participants][][person_email]	object (PersonEmail)	*
data.ticket[participants][][default_on]	boolean	*	Default checkbox status of the user.
data.ticket[charges][]	array of objects (TicketCharge)	*
data.ticket[charges][][id]	integer	*
data.ticket[charges][][charge_time]	integer	*
data.ticket[charges][][amount]	float	*
data.ticket[charges][][date_created]	DateTime	*
data.ticket[charges][][ticket]	object (Ticket)	*
data.ticket[charges][][person]	object (Person)	*
data.ticket[charges][][organization]	object (Organization)	*
data.ticket[charges][][agent]	object (Person)	*
data.ticket[charges][][custom_data][]	array of objects (CustomDataBilling)	*
data.ticket[charges][][custom_data][][ticket_charge]	object (TicketCharge)	*
data.ticket[charges][][custom_data][][field]	object (CustomDefBilling)	*
data.ticket[charges][][custom_data][][field][parent]	object (CustomDefBilling)	*
data.ticket[charges][][custom_data][][field][children][]	array of objects (CustomDefBilling)	*	Field children.
data.ticket[charges][][custom_data][][field][title]		*
data.ticket[charges][][custom_data][][root_field]	object (CustomDefBilling)	*
data.ticket[ticket_slas][]	array of objects (TicketSla)	*
data.ticket[ticket_slas][][id]	integer	*	The unique ID.
data.ticket[ticket_slas][][sla_status]	string	*	The SLA status.
data.ticket[ticket_slas][][warn_date]	DateTime	*	The SLA warn date.
data.ticket[ticket_slas][][fail_date]	DateTime	*	The SLA fail date.
data.ticket[ticket_slas][][is_completed]	boolean	*	Is the SLA completed?
data.ticket[ticket_slas][][is_completed_set]	boolean	*	Completed by automated action.
data.ticket[ticket_slas][][completed_time_taken]	integer	*	Time taken.
data.ticket[ticket_slas][][ticket]	integer id (Ticket)	*	Ticket.
data.ticket[ticket_slas][][sla]	integer id (Sla)	*	SLA.
data.ticket[ticket_slas][][date_applied]	DateTime	*	time and date when SLA was applied to the ticket.
data.ticket[ticket_slas][][date_completed]	DateTime	*	time when SLA status became OK.
data.ticket[jira_issues][]	array of objects (JiraIssue)	*	linked jira issues.
data.ticket[jira_issues][][id]	integer	*	The unique ID.
data.ticket[jira_issues][][ticket]	object (Ticket)	*	The associated DeskPRO ticket.
data.ticket[jira_issues][][issue_id]	integer	*
data.ticket[jira_issues][][status_id]	integer	*
data.ticket[jira_issues][][created]	DateTime	*	Export time.
data.ticket[problems][]	array of objects (Problem)	*
data.ticket[problems][][id]	integer	*	The unique ID.
data.ticket[problems][][title]	string	*	Problem title.
data.ticket[problems][][creator]	integer id (Person)	*	Person who created the problem.
data.ticket[problems][][created]	DateTime	*	Date when the problem was created.
data.ticket[problems][][is_open]	boolean	*	Is problem still has no solution?
data.ticket[problems][][tickets][]	array of integer ids (Ticket)	*	Tickets associated with problem.
data.ticket[stars][]	array of objects (TicketFlagged)	*
data.ticket[stars][][ticket]	object (Ticket)	*
data.ticket[stars][][person_id]	integer	*
data.ticket[stars][][color]	string	*
data.ticket[follow_ups][]	array of objects (TicketFollowUp)	*
data.ticket[follow_ups][][id]	integer	*	The unique ID.
data.ticket[follow_ups][][person]	integer id (Person)	*
data.ticket[follow_ups][][actions]	array	*
data.ticket[follow_ups][][cancel_if_user_reply]	boolean	*
data.ticket[follow_ups][][cancel_if_agent_reply]	boolean	*
data.ticket[follow_ups][][status]	string	*
data.ticket[follow_ups][][date_created]	DateTime	*
data.ticket[follow_ups][][date_to_run]	DateTime	*
data.ticket[follow_ups][][date_did_run]	DateTime	*
data.ticket[follow_ups][][dateToRun]		*
data.ticket[logs][]	array of objects (TicketLog)	*
data.ticket[logs][][id]	integer	*
data.ticket[logs][][parent]	object (TicketLog)	*
data.ticket[logs][][ticket]	object (Ticket)	*
data.ticket[logs][][person]	object (Person)	*
data.ticket[logs][][action_type]	string	*
data.ticket[logs][][id_object]	integer	*	If the log involves a specific thing in a ticket (eg a message that was moved), then that is this id.
data.ticket[logs][][id_before]	integer	*	The ID of the previous entity changed, or any other numeric value.
data.ticket[logs][][id_after]	integer	*	The ID of the new entity, or any other numeric value.
data.ticket[logs][][trigger_id]	integer	*	If the change was caused by a trigger, the trigger id. Note this is the integer ID (not a FK relation) so the record is kept even if the trigger itself is deleted.
data.ticket[logs][][escalation_id]	integer	*	If the change was caused by an escalation Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.ticket[logs][][macro_id]	integer	*	If the change was caused by an v2 macro Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.ticket[logs][][sla]	object (Sla)	*	If the change was caused by an SLA, the SLA.
data.ticket[logs][][sla][id]	integer	*	The unique ID.
data.ticket[logs][][sla][title]	string	*	SLA title.
data.ticket[logs][][sla][sla_type]	string	*	Type of SLA - first_response, resolution, waiting_time.
data.ticket[logs][][sla][active_time]	string	*	Whether active all the time (all) or during work hours only (work_hours) or use the default ticket-wide settings (default).
data.ticket[logs][][sla][work_start]	integer	*	When the work day starts. This is stored as the number of seconds after 00:00:00.
data.ticket[logs][][sla][work_end]	integer	*	When the work day ends. This is stored as the number of seconds after 00:00:00.
data.ticket[logs][][sla][work_days]	array	*	Array of work days, stored with keys corresponding to day numbers. Values are true. 0 = Sunday, 6 = Saturday (same as PHP, easy to convert to MySQL which is 1 = Sunday, 7 = Saturday).
data.ticket[logs][][sla][work_timezone]	string	*	Timezone for work hours/days to be considered in.
data.ticket[logs][][sla][work_holidays]	array	*	List of work holidays.
data.ticket[logs][][sla][apply_type]	string	*	Controls how the SLA is applied to tickets: all, terms, terms_before_triggers, manual.
data.ticket[logs][][sla][apply_terms]	object (TriggerTerms)	*	Conditions to apply.
data.ticket[logs][][sla][apply_terms][version]	integer	*	Terms version.
data.ticket[logs][][sla][apply_terms][terms]	array	*	Terms themselves.
data.ticket[logs][][sla][trigger_terms]	object (TriggerTerms)	*	Conditions to consider sla completed.
data.ticket[logs][][sla][warn_time]	integer	*	Warn time integer.
data.ticket[logs][][sla][warn_time_unit]	string	*	And it's unit (see warn time).
data.ticket[logs][][sla][warn_actions]	object (TriggerActions)	*	How to warn about SLA will fail.
data.ticket[logs][][sla][warn_actions][version]	integer	*	Actions version.
data.ticket[logs][][sla][warn_actions][actions]	array	*	Actions array representation.
data.ticket[logs][][sla][fail_time]	integer	*	Fail time integer.
data.ticket[logs][][sla][fail_time_unit]	string	*	And it's measuring unit (see fail_time).
data.ticket[logs][][sla][fail_actions]	object (TriggerActions)	*	What to do if SLA failed.
data.ticket[logs][][sla][exclude_ticket_statuses]	array	*	This SLA will not apply while tickets are in these pending statuses.
data.ticket[logs][][sla_status]	string	*
data.ticket[logs][][details]	array	*
data.ticket[logs][][date_created]	DateTime	*
data.ticket[chats][]	array of objects (ChatConversation)	*
data.ticket[created_with_channel]	string	*
data.ticket[last_channel_used]	string	*
data.ticket[channels]	array	*
data.ticket[pending_articles][]	array of objects (ArticlePendingCreate)	*
data.ticket[pending_articles][][id]	integer	*
data.ticket[pending_articles][][person]	integer id (Person)	*
data.ticket[pending_articles][][assigned_person]	integer id (Person)	*
data.ticket[pending_articles][][ticket]	integer id (Ticket)	*
data.ticket[pending_articles][][message]	integer id (TicketMessage)	*
data.ticket[pending_articles][][comment]	string	*
data.ticket[pending_articles][][date_created]	DateTime	*
data.ticket[summary]	object (TicketSummary)	*
data.ticket[summary][id]	integer	*
data.ticket[summary][ticket]	object (Ticket)	*
data.ticket[summary][summary]	string	*
data.ticket[summary][summary_input]	string	*
data.ticket[summary][date_created]	DateTime	*
data.person	object (Person)	*
data.person[emails]		*
data.person[labels]		*
data.person[teams]		*
data.person[primary_team]		*
data.person[agentData]		*
data.person[publicUsergroups]		*
data.person[publicAgentgroups]		*
data.organization	object (Organization)	*
data.organization[id]	integer	*	The unique ID.
data.organization[picture_blob]	object (Blob)	*	The org picture.
data.organization[picture_blob][sys_name]	string	*	A unique system name for the blob.
data.organization[picture_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.organization[picture_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.organization[picture_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.organization[picture_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.organization[picture_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.organization[picture_blob][file_url]	string	*	The HTTP link to download the file.
data.organization[picture_blob][authcode]	string	*
data.organization[picture_blob][blob_hash]	string	*
data.organization[picture_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.organization[picture_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.organization[picture_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.organization[picture_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.organization[picture_blob][date_created]	DateTime	*
data.organization[picture_blob][is_temp]	boolean	*
data.organization[picture_blob][source_ref]	string	*
data.organization[picture_blob][labels][]	array of objects (LabelBlob)	*
data.organization[picture_blob][labels][][blob]	object (Blob)	*
data.organization[icon_property]	object (IconProperty)	*
data.organization[icon_property][urn]	string	*
data.organization[icon_property][options]	array	*
data.organization[name]	string	*	The organization name.
data.organization[summary]	string	*	The summary field as filled in by agents.
data.organization[importance]	integer	*	The org importance.
data.organization[custom_data][]	array of objects (CustomDataOrganization)	*
data.organization[custom_data][][organization]	object (Organization)	*
data.organization[custom_data][][field]	object (CustomDefOrganization)	*
data.organization[custom_data][][field][parent]	object (CustomDefOrganization)	*	Field`s parent.
data.organization[custom_data][][field][children][]	array of objects (CustomDefOrganization)	*	Field children.
data.organization[custom_data][][field][title]		*
data.organization[custom_data][][root_field]	object (CustomDefOrganization)	*
data.organization[usergroups][]	array of objects (Usergroup)	*	Usergroups the user belongs to.
data.organization[usergroups][][id]	integer	*	The unique ID, DB-generated.
data.organization[usergroups][][title]	string	*	Title of the usergroup.
data.organization[usergroups][][note]	string	*	A note or description about the usergroup.
data.organization[usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.organization[usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.organization[usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.organization[usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.organization[usergroups][][permissions][][id]	integer	*	The unique ID.
data.organization[usergroups][][permissions][][name]	string	*	The name of the permission.
data.organization[usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.organization[usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.organization[usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.organization[usergroups][][department_permissions][][department]	integer id (Department)	*
data.organization[usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.organization[usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.organization[usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.organization[usergroups][][department_permissions][][is_active]	boolean	*
data.organization[usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.organization[auto_cc_people][]	array of objects (Person)	*	Users who are set to automatically be added to tickets and other org things.
data.organization[labels][]	array of objects (LabelOrganization)	*
data.organization[labels][][organization]	object (Organization)	*
data.organization[contact_data][]	array of objects (OrganizationContactData)	*
data.organization[contact_data][][organization]		*
data.organization[contact_data][][contact_type]		*
data.organization[contact_data][][comment]		*
data.organization[contact_data][][field_1]		*
data.organization[contact_data][][field_2]		*
data.organization[contact_data][][field_3]		*
data.organization[contact_data][][field_5]		*
data.organization[contact_data][][field_9]		*
data.organization[emails][]	array of objects (OrganizationEmail)	*
data.organization[emails][][id]	integer	*	The unique log id.
data.organization[emails][][organization]	object (Organization)	*
data.organization[emails][][email]	string	*
data.organization[emails][][date_created]	DateTime	*
data.organization[email_domains][]	array of objects (OrganizationEmailDomain)	*
data.organization[email_domains][][domain]	string	*	The email domain.
data.organization[email_domains][][organization]	object (Organization)	*	The users organization.
data.organization[date_created]	DateTime	*	The date the org was inserted into the system.
data.organization[members][]	array of objects (Person)	*
data.organization[parent]	object (Organization)	*
data.organization[children][]	array of objects (Organization)	*
data.organization[tickets][]	array of objects (Ticket)	*
data.organization[organization_members][]	array of objects (OrganizationMember)	*
data.organization[organization_members][][id]	integer	*
data.organization[organization_members][][person]	integer id (Person)	*
data.organization[organization_members][][organization]	integer id (Organization)	*
data.organization[organization_members][][is_manager]	boolean	*
data.organization[organization_members][][position]	string	*
data.organization[organization_members][][created_at]	DateTime	*
data.organization[organization_members][][updated_at]	DateTime	*
data.organization[publicUsergroups]		*
data.agent	object (Person)	*
data.custom_data[]	array of objects (CustomDataBilling)	*
data.custom_data[][ticket_charge]	object (TicketCharge)	*
data.custom_data[][ticket_charge][id]	integer	*
data.custom_data[][ticket_charge][charge_time]	integer	*
data.custom_data[][ticket_charge][amount]	float	*
data.custom_data[][ticket_charge][date_created]	DateTime	*
data.custom_data[][ticket_charge][ticket]	object (Ticket)	*
data.custom_data[][ticket_charge][person]	object (Person)	*
data.custom_data[][ticket_charge][organization]	object (Organization)	*
data.custom_data[][ticket_charge][agent]	object (Person)	*
data.custom_data[][ticket_charge][custom_data][]	array of objects (CustomDataBilling)	*
data.custom_data[][field]	object (CustomDefBilling)	*
data.custom_data[][field][parent]	object (CustomDefBilling)	*
data.custom_data[][field][children][]	array of objects (CustomDefBilling)	*	Field children.
data.custom_data[][field][title]		*
data.custom_data[][root_field]	object (CustomDefBilling)	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/tickets/{parentId}/charges/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_charges.count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

GET /api/v2/tickets/{parentId}/charges/total CRUD

Get ticket charges total amounts

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_charges.get_total

Requirements
Status Codes

Name	Requirement	Type	Description
parentId

Status Code	Description
400	We will return this in case your request was malformed

DELETE /api/v2/tickets/{parentId}/charges/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_charges.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/tickets/{parentId}/charges/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_charges.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Versions	Description
data.id	integer	*
data.charge_time	integer	*
data.amount	float	*
data.date_created	DateTime	*
data.ticket	object (Ticket)	*
data.ticket[id]	integer	*
data.ticket[ref]	string	*
data.ticket[auth]	string	*
data.ticket[parent_ticket]	object (Ticket)	*	Parent ticket.
data.ticket[children_tickets][]	array of objects (Ticket)	*
data.ticket[language]	object (Language)	*	The language the ticket is in.
data.ticket[language][id]	integer	*	The unique ID.
data.ticket[language][sys_name]	string	*	The unique sys name assigned to the language.
data.ticket[language][title]	string	*	Title of the language.
data.ticket[language][title_local]	string	*	Title of the language.
data.ticket[language][base_filepath]	string	*	The base filepath for default phrases for this lang.
data.ticket[language][locale]	string	*	The locale code.
data.ticket[language][flag_image]	string	*	String path to image.
data.ticket[language][is_rtl]	boolean	*	True if this is a right-to-left language.
data.ticket[language][has_user]	boolean	*	True if has user.
data.ticket[language][has_agent]	boolean	*	True if has agent.
data.ticket[language][has_admin]	boolean	*	True if has admin.
data.ticket[language][plural_categories][]	array of strings	*
data.ticket[language][plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data.ticket[language][flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`
data.ticket[brand]	object (Brand)	*
data.ticket[brand][id]	integer	*	The unique ID.
data.ticket[brand][name]	string	*	The brand name.
data.ticket[brand][slug]	string	*
data.ticket[brand][url]	string	*	The brand url.
data.ticket[brand][theme_set]	object (ThemeSet)	*
data.ticket[brand][theme_set][id]	integer	*
data.ticket[brand][theme_set][theme_id]	string	*
data.ticket[brand][theme_set][title]	string	*
data.ticket[brand][theme_set][options]		*
data.ticket[brand][edit_theme_set]	object (ThemeSet)	*
data.ticket[brand][departments][]	array of objects (Department)	*
data.ticket[brand][departments][][id]	integer	*
data.ticket[brand][departments][][parent]	object (Department)	*
data.ticket[brand][departments][][children][]	array of objects (Department)	*
data.ticket[brand][departments][][title]	string	*
data.ticket[brand][departments][][user_title]	string	*
data.ticket[brand][departments][][is_tickets_enabled]	boolean	*
data.ticket[brand][departments][][is_chat_enabled]	boolean	*
data.ticket[brand][departments][][display_order]	integer	*
data.ticket[brand][departments][][avatar]	object (Blob)	*
data.ticket[brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.ticket[brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.ticket[brand][departments][][avatar][authcode]	string	*
data.ticket[brand][departments][][avatar][blob_hash]	string	*
data.ticket[brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[brand][departments][][avatar][date_created]	DateTime	*
data.ticket[brand][departments][][avatar][is_temp]	boolean	*
data.ticket[brand][departments][][avatar][source_ref]	string	*
data.ticket[brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.ticket[brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.ticket[brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.ticket[brand][departments][][brands][]	array of objects (Brand)	*
data.ticket[brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.ticket[brand][departments][][permissions][][department]	integer id (Department)	*
data.ticket[brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.ticket[brand][departments][][permissions][][name]	string	*	The name of the permission.
data.ticket[brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.ticket[brand][departments][][permissions][][is_active]	boolean	*
data.ticket[brand][departments][][chat_queue]	object (UserChatQueue)	*
data.ticket[brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.ticket[brand][departments][][chat_queue][name]	string	*
data.ticket[brand][departments][][chat_queue][routing_model]	string	*
data.ticket[brand][departments][][chat_queue][answer_timeout]	integer	*
data.ticket[brand][departments][][chat_queue][is_all_agents]	boolean	*
data.ticket[brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.ticket[brand][departments][][chat_queue][max_queue_size]	integer	*
data.ticket[brand][departments][][chat_queue][routingModel]		*
data.ticket[brand][theme_sets][]	array of objects (ThemeSet)	*
data.ticket[department]	object (Department)	*
data.ticket[department][id]	integer	*
data.ticket[department][parent]	object (Department)	*
data.ticket[department][children][]	array of objects (Department)	*
data.ticket[department][title]	string	*
data.ticket[department][user_title]	string	*
data.ticket[department][is_tickets_enabled]	boolean	*
data.ticket[department][is_chat_enabled]	boolean	*
data.ticket[department][display_order]	integer	*
data.ticket[department][avatar]	object (Blob)	*
data.ticket[department][avatar][sys_name]	string	*	A unique system name for the blob.
data.ticket[department][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[department][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[department][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[department][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[department][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[department][avatar][file_url]	string	*	The HTTP link to download the file.
data.ticket[department][avatar][authcode]	string	*
data.ticket[department][avatar][blob_hash]	string	*
data.ticket[department][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[department][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[department][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[department][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[department][avatar][date_created]	DateTime	*
data.ticket[department][avatar][is_temp]	boolean	*
data.ticket[department][avatar][source_ref]	string	*
data.ticket[department][avatar][labels][]	array of objects (LabelBlob)	*
data.ticket[department][avatar][labels][][blob]	object (Blob)	*
data.ticket[department][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.ticket[department][brands][]	array of objects (Brand)	*
data.ticket[department][permissions][]	array of objects (DepartmentPermission)	*
data.ticket[department][permissions][][department]	integer id (Department)	*
data.ticket[department][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.ticket[department][permissions][][name]	string	*	The name of the permission.
data.ticket[department][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.ticket[department][permissions][][is_active]	boolean	*
data.ticket[department][chat_queue]	object (UserChatQueue)	*
data.ticket[department][chat_queue][id]	integer	*	The unique ID.
data.ticket[department][chat_queue][name]	string	*
data.ticket[department][chat_queue][routing_model]	string	*
data.ticket[department][chat_queue][answer_timeout]	integer	*
data.ticket[department][chat_queue][is_all_agents]	boolean	*
data.ticket[department][chat_queue][departments][]	array of objects (Department)	*
data.ticket[department][chat_queue][max_queue_size]	integer	*
data.ticket[category]	object (TicketCategory)	*
data.ticket[category][id]	integer	*	The unique ID.
data.ticket[category][parent]	integer id (TicketCategory)	*	This category parent.
data.ticket[category][title]	string	*	Category title.
data.ticket[category][display_order]	integer	*	Obviously it's display order for lists.
data.ticket[priority]	object (TicketPriority)	*
data.ticket[priority][id]	integer	*	The unique ID.
data.ticket[priority][title]	string	*	Priority title.
data.ticket[priority][priority]	integer	*	The priority itself.
data.ticket[workflow]	object (TicketWorkflow)	*
data.ticket[workflow][id]	integer	*	The unique ID.
data.ticket[workflow][title]	string	*	Workflow title.
data.ticket[workflow][display_order]	integer	*	Workflow display order.
data.ticket[product]	object (Product)	*
data.ticket[product][parent]	integer id (Product)	*	Parent of the product.
data.ticket[product][title]		*
data.ticket[person]	object (Person)	*
data.ticket[person_email]	object (PersonEmail)	*
data.ticket[person_email][id]	integer	*	The unique ID.
data.ticket[person_email][person]	integer id (Person)	*	Person owner of email.
data.ticket[person_email][email]	string	*	The email address.
data.ticket[person_email][email_domain]	string	*	The email address domain.
data.ticket[person_email][is_validated]	boolean	*	True if validation passed.
data.ticket[person_email][date_created]	DateTime	*	The original time the email was created.
data.ticket[agent]	object (Person)	*
data.ticket[agent_team]	object (AgentTeam)	*
data.ticket[agent_team][id]	integer	*	The unique ID.
data.ticket[agent_team][name]	string	*	The name of agent team.
data.ticket[agent_team][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.ticket[agent_team][members]		*
data.ticket[organization]	object (Organization)	*
data.ticket[organization][id]	integer	*	The unique ID.
data.ticket[organization][picture_blob]	object (Blob)	*	The org picture.
data.ticket[organization][picture_blob][sys_name]	string	*	A unique system name for the blob.
data.ticket[organization][picture_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[organization][picture_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[organization][picture_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[organization][picture_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[organization][picture_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[organization][picture_blob][file_url]	string	*	The HTTP link to download the file.
data.ticket[organization][picture_blob][authcode]	string	*
data.ticket[organization][picture_blob][blob_hash]	string	*
data.ticket[organization][picture_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[organization][picture_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[organization][picture_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[organization][picture_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[organization][picture_blob][date_created]	DateTime	*
data.ticket[organization][picture_blob][is_temp]	boolean	*
data.ticket[organization][picture_blob][source_ref]	string	*
data.ticket[organization][picture_blob][labels][]	array of objects (LabelBlob)	*
data.ticket[organization][picture_blob][labels][][blob]	object (Blob)	*
data.ticket[organization][icon_property]	object (IconProperty)	*
data.ticket[organization][icon_property][urn]	string	*
data.ticket[organization][icon_property][options]	array	*
data.ticket[organization][name]	string	*	The organization name.
data.ticket[organization][summary]	string	*	The summary field as filled in by agents.
data.ticket[organization][importance]	integer	*	The org importance.
data.ticket[organization][custom_data][]	array of objects (CustomDataOrganization)	*
data.ticket[organization][custom_data][][organization]	object (Organization)	*
data.ticket[organization][custom_data][][field]	object (CustomDefOrganization)	*
data.ticket[organization][custom_data][][field][parent]	object (CustomDefOrganization)	*	Field`s parent.
data.ticket[organization][custom_data][][field][children][]	array of objects (CustomDefOrganization)	*	Field children.
data.ticket[organization][custom_data][][field][title]		*
data.ticket[organization][custom_data][][root_field]	object (CustomDefOrganization)	*
data.ticket[organization][usergroups][]	array of objects (Usergroup)	*	Usergroups the user belongs to.
data.ticket[organization][usergroups][][id]	integer	*	The unique ID, DB-generated.
data.ticket[organization][usergroups][][title]	string	*	Title of the usergroup.
data.ticket[organization][usergroups][][note]	string	*	A note or description about the usergroup.
data.ticket[organization][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.ticket[organization][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.ticket[organization][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.ticket[organization][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.ticket[organization][usergroups][][permissions][][id]	integer	*	The unique ID.
data.ticket[organization][usergroups][][permissions][][name]	string	*	The name of the permission.
data.ticket[organization][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.ticket[organization][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.ticket[organization][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.ticket[organization][usergroups][][department_permissions][][department]	integer id (Department)	*
data.ticket[organization][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.ticket[organization][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.ticket[organization][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.ticket[organization][usergroups][][department_permissions][][is_active]	boolean	*
data.ticket[organization][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.ticket[organization][auto_cc_people][]	array of objects (Person)	*	Users who are set to automatically be added to tickets and other org things.
data.ticket[organization][labels][]	array of objects (LabelOrganization)	*
data.ticket[organization][labels][][organization]	object (Organization)	*
data.ticket[organization][contact_data][]	array of objects (OrganizationContactData)	*
data.ticket[organization][contact_data][][organization]		*
data.ticket[organization][contact_data][][contact_type]		*
data.ticket[organization][contact_data][][comment]		*
data.ticket[organization][contact_data][][field_1]		*
data.ticket[organization][contact_data][][field_2]		*
data.ticket[organization][contact_data][][field_3]		*
data.ticket[organization][contact_data][][field_5]		*
data.ticket[organization][contact_data][][field_9]		*
data.ticket[organization][emails][]	array of objects (OrganizationEmail)	*
data.ticket[organization][emails][][id]	integer	*	The unique log id.
data.ticket[organization][emails][][organization]	object (Organization)	*
data.ticket[organization][emails][][email]	string	*
data.ticket[organization][emails][][date_created]	DateTime	*
data.ticket[organization][email_domains][]	array of objects (OrganizationEmailDomain)	*
data.ticket[organization][email_domains][][domain]	string	*	The email domain.
data.ticket[organization][email_domains][][organization]	object (Organization)	*	The users organization.
data.ticket[organization][date_created]	DateTime	*	The date the org was inserted into the system.
data.ticket[organization][members][]	array of objects (Person)	*
data.ticket[organization][parent]	object (Organization)	*
data.ticket[organization][children][]	array of objects (Organization)	*
data.ticket[organization][tickets][]	array of objects (Ticket)	*
data.ticket[organization][organization_members][]	array of objects (OrganizationMember)	*
data.ticket[organization][organization_members][][id]	integer	*
data.ticket[organization][organization_members][][person]	integer id (Person)	*
data.ticket[organization][organization_members][][organization]	integer id (Organization)	*
data.ticket[organization][organization_members][][is_manager]	boolean	*
data.ticket[organization][organization_members][][position]	string	*
data.ticket[organization][organization_members][][created_at]	DateTime	*
data.ticket[organization][organization_members][][updated_at]	DateTime	*
data.ticket[organization][publicUsergroups]		*
data.ticket[linked_chat]	object (ChatConversation)	*
data.ticket[linked_chat][id]	integer	*	The unique id of chat conversation.
data.ticket[linked_chat][department]	object (Department)	*	Department which chat was assigned.
data.ticket[linked_chat][brand]	object (Brand)	*	Department which chat was assigned.
data.ticket[linked_chat][task_id]	integer	*
data.ticket[linked_chat][ticket]	object (Ticket)	*
data.ticket[linked_chat][labels][]	array of objects (LabelChatConversation)	*
data.ticket[linked_chat][labels][][chat]	object (ChatConversation)	*
data.ticket[linked_chat][subject]	string	*	Subject of the chat conversation.
data.ticket[linked_chat][status]	string	*	Status of the chat conversation.
data.ticket[linked_chat][agent]	object (Person)	*	If this is a user conversation, this is the agent assigned.
data.ticket[linked_chat][agent_team]	object (AgentTeam)	*	If this is a team chat, the team it is.
data.ticket[linked_chat][person]	object (Person)	*	If this is a user conversation, this is the user who started the chat.
data.ticket[linked_chat][session]	object (Session)	*	If this is a user convo, this is the users session.
data.ticket[linked_chat][session][id]	integer	*	The unique ID.
data.ticket[linked_chat][session][auth]	string	*	The authcode for the session to verify an id.
data.ticket[linked_chat][session][interface]	string	*	The Interface the session is for.
data.ticket[linked_chat][session][person]	object (Person)	*
data.ticket[linked_chat][session][user_agent]	string	*	The users user agent string.
data.ticket[linked_chat][session][visitor_id]	string	*
data.ticket[linked_chat][session][ip_address]	string	*	The users IP address.
data.ticket[linked_chat][session][data]	string	*
data.ticket[linked_chat][session][is_person]	boolean	*
data.ticket[linked_chat][session][is_bot]	boolean	*
data.ticket[linked_chat][session][is_helpdesk]	boolean	*
data.ticket[linked_chat][session][active_status]	string	*	(Agents) Status (available or away).
data.ticket[linked_chat][session][is_chat_available]	boolean	*	(Agents) Wehn status is available, if they are available for chat.
data.ticket[linked_chat][session][date_created]	DateTime	*
data.ticket[linked_chat][session][date_last]	DateTime	*
data.ticket[linked_chat][session][date_last_page]	DateTime	*
data.ticket[linked_chat][visitor_id]	string	*
data.ticket[linked_chat][person_name]	string	*	User chat: The users name, if they arent a person.
data.ticket[linked_chat][person_email]	string	*	User chat: The users email, if they aren`t a person.
data.ticket[linked_chat][participants][]	array of objects (Person)	*
data.ticket[linked_chat][messages][]	array of objects (ChatMessage)	*
data.ticket[linked_chat][messages][][id]	integer	*	The unique ID.
data.ticket[linked_chat][messages][][author_id]	integer	*	Author id (legacy).
data.ticket[linked_chat][messages][][author_type]	string	*	Author type (legacy).
data.ticket[linked_chat][messages][][conversation_id]	integer	*	Conversation id (legacy).
data.ticket[linked_chat][messages][][author]	integer id (Person)	*	Person who created the message.
data.ticket[linked_chat][messages][][content]	string	*	The message.
data.ticket[linked_chat][messages][][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.ticket[linked_chat][messages][][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.ticket[linked_chat][messages][][is_html]	boolean	*	Is the content an HTML message?
data.ticket[linked_chat][messages][][metadata]	array	*	Additional data.
data.ticket[linked_chat][messages][][date_created]	DateTime	*	Date message was created.
data.ticket[linked_chat][messages][][date_received]	DateTime	*	Date message was received.
data.ticket[linked_chat][custom_data][]	array of objects (CustomDataChat)	*
data.ticket[linked_chat][custom_data][][conversation]	object (ChatConversation)	*	The conversation the message belongs to.
data.ticket[linked_chat][custom_data][][field]	object (CustomDefChat)	*
data.ticket[linked_chat][custom_data][][field][parent]	object (CustomDefChat)	*
data.ticket[linked_chat][custom_data][][field][children][]	array of objects (CustomDefChat)	*	Field children.
data.ticket[linked_chat][custom_data][][field][title]		*
data.ticket[linked_chat][custom_data][][root_field]	object (CustomDefChat)	*
data.ticket[linked_chat][rating_response_time]	integer	*
data.ticket[linked_chat][rating_overall]	integer	*
data.ticket[linked_chat][rating_comment]	string	*
data.ticket[linked_chat][is_agent]	boolean	*	Is this an agent chat.
data.ticket[linked_chat][is_window]	boolean	*	If the chat is popped out into a window. This is used to make sure the JS widget on pages doesn't load again.
data.ticket[linked_chat][date_created]	DateTime	*	Date when chat was started.
data.ticket[linked_chat][date_user_waiting]	DateTime	*	Since when the user has started waiting (i.e., time the assignment was 0).
data.ticket[linked_chat][date_assigned]	DateTime	*
data.ticket[linked_chat][date_agent_typing]	DateTime	*	Date when agent typed last time.
data.ticket[linked_chat][date_first_agent_message]	DateTime	*
data.ticket[linked_chat][date_ended]	DateTime	*	Date when chat was ended.
data.ticket[linked_chat][total_to_ended]	integer	*
data.ticket[linked_chat][ended_by]	string	*	Who ended the chat.
data.ticket[linked_chat][should_send_transcript]	boolean	*	True if transcript should be send.
data.ticket[linked_chat][date_transcript_sent]	DateTime	*	Date when transcript was sent.
data.ticket[linked_chat][email_validation_code]	string	*
data.ticket[linked_chat][email_validated]	boolean	*
data.ticket[linked_chat][access_token]	string	*
data.ticket[attachments][]	array of objects (TicketAttachment)	*
data.ticket[attachments][][id]	integer	*	The unique ID.
data.ticket[attachments][][ticket]	integer id (Ticket)	*	Ticket this attachment belongs to.
data.ticket[attachments][][person]	integer id (Person)	*	Who created the attachment.
data.ticket[attachments][][blob]	object (Blob)	*	Actual attachment.
data.ticket[attachments][][blob][sys_name]	string	*	A unique system name for the blob.
data.ticket[attachments][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[attachments][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[attachments][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[attachments][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[attachments][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[attachments][][blob][file_url]	string	*	The HTTP link to download the file.
data.ticket[attachments][][blob][authcode]	string	*
data.ticket[attachments][][blob][blob_hash]	string	*
data.ticket[attachments][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[attachments][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[attachments][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[attachments][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[attachments][][blob][date_created]	DateTime	*
data.ticket[attachments][][blob][is_temp]	boolean	*
data.ticket[attachments][][blob][source_ref]	string	*
data.ticket[attachments][][blob][labels][]	array of objects (LabelBlob)	*
data.ticket[attachments][][blob][labels][][blob]	object (Blob)	*
data.ticket[attachments][][message]	integer id (TicketMessage)	*	Message - holder of this attachment.
data.ticket[attachments][][is_agent_note]	boolean	*	True if this attachmen just a note.
data.ticket[attachments][][is_inline]	boolean	*	Is this attachment is embed in message.
data.ticket[access_codes][]	array of objects (TicketAccessCode)	*
data.ticket[access_codes][][id]	integer	*
data.ticket[access_codes][][ticket]	object (Ticket)	*
data.ticket[access_codes][][person]	object (Person)	*
data.ticket[access_codes][][auth]	string	*
data.ticket[messages][]	array of objects (TicketMessage)	*
data.ticket[messages][][id]	integer	*	The unique id of message.
data.ticket[messages][][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data.ticket[messages][][person]	object (Person)	*	Person this message was sent by.
data.ticket[messages][][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data.ticket[messages][][email_source][id]	integer	*
data.ticket[messages][][email_source][uuid]	string	*
data.ticket[messages][][email_source][blob]	object (Blob)	*
data.ticket[messages][][email_source][blob][sys_name]	string	*	A unique system name for the blob.
data.ticket[messages][][email_source][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[messages][][email_source][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[messages][][email_source][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[messages][][email_source][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[messages][][email_source][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[messages][][email_source][blob][file_url]	string	*	The HTTP link to download the file.
data.ticket[messages][][email_source][blob][authcode]	string	*
data.ticket[messages][][email_source][blob][blob_hash]	string	*
data.ticket[messages][][email_source][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[messages][][email_source][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[messages][][email_source][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[messages][][email_source][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[messages][][email_source][blob][date_created]	DateTime	*
data.ticket[messages][][email_source][blob][is_temp]	boolean	*
data.ticket[messages][][email_source][blob][source_ref]	string	*
data.ticket[messages][][email_source][blob][labels][]	array of objects (LabelBlob)	*
data.ticket[messages][][email_source][blob][labels][][blob]	object (Blob)	*
data.ticket[messages][][email_source][object_type]	string	*	The type of object this is attached to (should be the table name of the super type, eg: tickets, people, organizations). This typically is not set until after the email is processed (ie the status is 'processed').
data.ticket[messages][][email_source][object_id]	integer	*	The ID of the object this is attached to.
data.ticket[messages][][email_source][from_email]	string	*
data.ticket[messages][][email_source][status]	string	*	The current status of the message: - inserted: Only inserted - processing: Currently processing - complete: Fully processed - error: Tried to process but there was some kind of error (see error_code).
data.ticket[messages][][email_source][date_status]	DateTime	*
data.ticket[messages][][email_source][error_code]	string	*	When status is error, this is the code that describes the error.
data.ticket[messages][][email_source][date_created]	DateTime	*
data.ticket[messages][][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.ticket[messages][][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.ticket[messages][][snippet_use_logs][][id]	integer	*	The unique ID.
data.ticket[messages][][snippet_use_logs][][snippet]	object (SnippetV2)	*	Snippet used.
data.ticket[messages][][snippet_use_logs][][snippet][id]	integer	*
data.ticket[messages][][snippet_use_logs][][snippet][title]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][author]	object (Person)	*
data.ticket[messages][][snippet_use_logs][][snippet][is_private]	boolean	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar]	object (Blob)	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][sys_name]	string	*	A unique system name for the blob.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][file_url]	string	*	The HTTP link to download the file.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][authcode]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][blob_hash]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][date_created]	DateTime	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][is_temp]	boolean	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][source_ref]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][labels][]	array of objects (LabelBlob)	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][labels][][blob]	object (Blob)	*
data.ticket[messages][][snippet_use_logs][][snippet][status]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][shortcut_codes]	array	*
data.ticket[messages][][snippet_use_logs][][snippet][inline_translations]	array	*
data.ticket[messages][][snippet_use_logs][][snippet][translations][]	array of objects (SnippetV2Translation)	*
data.ticket[messages][][snippet_use_logs][][snippet][translations][][id]	integer	*	The unique ID.
data.ticket[messages][][snippet_use_logs][][snippet][translations][][snippet]	object (SnippetV2)	*	Snippet translated.
data.ticket[messages][][snippet_use_logs][][snippet][translations][][language]	object (Language)	*
data.ticket[messages][][snippet_use_logs][][snippet][translations][][content]	array	*	Snippet content.
data.ticket[messages][][snippet_use_logs][][snippet][translations][][blobs][]	array of objects (Blob)	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][]	array of objects (SnippetV2Category)	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][id]	integer	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][title]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][is_global]	boolean	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][display_order]	integer	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][parent]	object (SnippetV2Category)	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][agent_teams][]	array of objects (AgentTeam)	*
data.ticket[messages][][snippet_use_logs][][snippet][display_order]	integer	*
data.ticket[messages][][snippet_use_logs][][snippet][date_created]	DateTime	*
data.ticket[messages][][snippet_use_logs][][ticket_message]	object (TicketMessage)	*	Ticket Message where the snippet was used.
data.ticket[messages][][snippet_use_logs][][chat_message]	object (ChatMessage)	*	Chat Message where the snippet was used.
data.ticket[messages][][snippet_use_logs][][chat_message][id]	integer	*	The unique ID.
data.ticket[messages][][snippet_use_logs][][chat_message][author_id]	integer	*	Author id (legacy).
data.ticket[messages][][snippet_use_logs][][chat_message][author_type]	string	*	Author type (legacy).
data.ticket[messages][][snippet_use_logs][][chat_message][conversation_id]	integer	*	Conversation id (legacy).
data.ticket[messages][][snippet_use_logs][][chat_message][author]	integer id (Person)	*	Person who created the message.
data.ticket[messages][][snippet_use_logs][][chat_message][content]	string	*	The message.
data.ticket[messages][][snippet_use_logs][][chat_message][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.ticket[messages][][snippet_use_logs][][chat_message][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.ticket[messages][][snippet_use_logs][][chat_message][is_html]	boolean	*	Is the content an HTML message?
data.ticket[messages][][snippet_use_logs][][chat_message][metadata]	array	*	Additional data.
data.ticket[messages][][snippet_use_logs][][chat_message][date_created]	DateTime	*	Date message was created.
data.ticket[messages][][snippet_use_logs][][chat_message][date_received]	DateTime	*	Date message was received.
data.ticket[messages][][snippet_use_logs][][language]	object (Language)	*	Snippet translated.
data.ticket[messages][][snippet_use_logs][][person]	object (Person)	*
data.ticket[messages][][snippet_use_logs][][rating]	integer	*
data.ticket[messages][][snippet_use_logs][][rating_person]	object (Person)	*
data.ticket[messages][][snippet_use_logs][][rating_message]	string	*
data.ticket[messages][][snippet_use_logs][][date_created]	DateTime	*
data.ticket[messages][][date_created]	DateTime	*	Date when message was created.
data.ticket[messages][][is_agent_note]	boolean	*	Is this message agent note?
data.ticket[messages][][is_hidden]	boolean	*	Is this message hidden?
data.ticket[messages][][creation_system]	string	*	How this message was created.
data.ticket[messages][][ip_address]	string	*	An ip address from which message was sent.
data.ticket[messages][][visitor_id]	string	*	Unique ID of visitor left this message.
data.ticket[messages][][hostname]	string	*	Host from which message was left.
data.ticket[messages][][geo_country]	string	*	Country message is from (deprecated).
data.ticket[messages][][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.ticket[messages][][message_hash]	string	*	An unique hash of message.
data.ticket[messages][][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.ticket[messages][][primary_translation][id]	integer	*
data.ticket[messages][][primary_translation][ticket]	object (Ticket)	*
data.ticket[messages][][primary_translation][ticket_message]	object (TicketMessage)	*
data.ticket[messages][][primary_translation][from_lang_code]	string	*
data.ticket[messages][][primary_translation][lang_code]	string	*
data.ticket[messages][][primary_translation][message]	string	*
data.ticket[messages][][primary_translation][date_created]	DateTime	*
data.ticket[messages][][message]	string	*	The message, will be in HTML!
data.ticket[messages][][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.ticket[messages][][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.ticket[messages][][message_source]	string	*	The message source.
data.ticket[messages][][message_source_type]	string	*	The message source type.
data.ticket[messages][][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.ticket[messages][][lang_code]	string	*	The set/detected lang code.
data.ticket[messages][][email_message_id][]	array of objects (TicketMessageEmailId)	*
data.ticket[messages][][email_message_id][][id]	integer	*
data.ticket[messages][][email_message_id][][message]	object (TicketMessage)	*
data.ticket[messages][][email_message_id][][email_id]	string	*
data.ticket[messages][][ticket_feedback][]	array of objects (TicketFeedback)	*
data.ticket[messages][][ticket_feedback][][id]	integer	*
data.ticket[messages][][ticket_feedback][][ticket]	object (Ticket)	*
data.ticket[messages][][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data.ticket[messages][][ticket_feedback][][person]	object (Person)	*
data.ticket[messages][][ticket_feedback][][rating]	integer	*
data.ticket[messages][][ticket_feedback][][message]	string	*
data.ticket[messages][][ticket_feedback][][date_created]	DateTime	*
data.ticket[messages][][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data.ticket[messages][][ticket_message_forwards][][id]	integer	*
data.ticket[messages][][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data.ticket[messages][][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data.ticket[messages][][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data.ticket[messages][][ticket_message_forwards][][subject]	string	*
data.ticket[messages][][ticket_message_forwards][][from_email]	string	*
data.ticket[messages][][ticket_message_forwards][][tos]	array	*
data.ticket[messages][][ticket_message_forwards][][ccs]	array	*
data.ticket[messages][][ticket_message_forwards][][bccs]	array	*
data.ticket[messages][][ticket_message_forwards][][message]	string	*
data.ticket[messages][][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data.ticket[messages][][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data.ticket[messages][][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[messages][][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[messages][][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[messages][][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[messages][][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[messages][][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data.ticket[messages][][ticket_message_forwards][][blobs][][authcode]	string	*
data.ticket[messages][][ticket_message_forwards][][blobs][][blob_hash]	string	*
data.ticket[messages][][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[messages][][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[messages][][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[messages][][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[messages][][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data.ticket[messages][][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data.ticket[messages][][ticket_message_forwards][][blobs][][source_ref]	string	*
data.ticket[messages][][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data.ticket[messages][][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data.ticket[messages][][ticket_message_forwards][][date_created]	DateTime	*
data.ticket[messages][][channel_message]	object (TicketMessageChannelMessage)	*
data.ticket[messages][][channel_message][id]	integer	*	@var int The unique id of message.
data.ticket[messages][][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data.ticket[messages][][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data.ticket[messages][][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data.ticket[messages][][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data.ticket[messages][][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data.ticket[messages][][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data.ticket[messages][][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data.ticket[messages][][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data.ticket[messages][][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data.ticket[sms_messages][]	array of objects (TicketSms)	*
data.ticket[sms_messages][][id]	integer	*
data.ticket[sms_messages][][ticket]	object (Ticket)	*
data.ticket[sms_messages][][person]	object (Person)	*
data.ticket[sms_messages][][sms_account]	object (SmsAccount)	*
data.ticket[sms_messages][][sms_account][id]	integer	*	The unique ID.
data.ticket[sms_messages][][sms_account][type]	string	*
data.ticket[sms_messages][][sms_account][params]	array	*
data.ticket[sms_messages][][sms_account][identifier]	string	*
data.ticket[sms_messages][][sms_account][is_enabled]	boolean	*
data.ticket[sms_messages][][sms_account][is_connected]	boolean	*
data.ticket[sms_messages][][sms_account][is_tested]	boolean	*
data.ticket[sms_messages][][sms_account][test_code]	string	*
data.ticket[sms_messages][][job]	object (Job)	*
data.ticket[sms_messages][][job][id]	integer	*	The unique job id.
data.ticket[sms_messages][][job][type]	string	*	The job type, used by the Job Router to find the right Job Processor.
data.ticket[sms_messages][][job][status]	string	*	The status of the job.
data.ticket[sms_messages][][job][status_code]	string	*	Any code to further classify the status.
data.ticket[sms_messages][][job][date_touch]	DateTime	*	Date the last time a process "touched" this ticket.
data.ticket[sms_messages][][job][date_created]	DateTime	*	Date this job entered the "jobs" table.
data.ticket[sms_messages][][job][date_last_try]	DateTime	*	Last time we processed this job.
data.ticket[sms_messages][][job][date_next_try]	DateTime	*	If this DateTime is in the future, it won't be selected for execution.
data.ticket[sms_messages][][job][num_tries]	integer	*	The number of times this job has been executed Job Processor (usually indicated failures if > 1).
data.ticket[sms_messages][][job][log_summary]	string	*	A human readable summary of the job's execution.
data.ticket[sms_messages][][job][log]	string	*	A more verbose log.
data.ticket[sms_messages][][job][data]	array	*	An array of data, or payload, that the job processor needs to execute this job (stored in the db as json). This MUST always be an array, even if its an empty array
data.ticket[sms_messages][][job][original_job]	integer	*	Null unless the job was created as a retry - if so, the originating job ID is stored here so we can query it later. Note: You MUST specify the originating job, do not create a linked list of failed jobs.
data.ticket[sms_messages][][date_created]	DateTime	*
data.ticket[sms_messages][][from_number]	string	*	Permanent record of the phone number that sent this SMS. (Won't change even if Person changes their phone number).
data.ticket[sms_messages][][to_number]	string	*	Permanent record of the phone number that this SMS was sent to.
data.ticket[sms_messages][][message]	string	*	The SMS message.
data.ticket[sms_messages][][direction]	string	*	Just a system flag for reporting.
data.ticket[topic_links][]	array of objects (TicketCommunityTopicLink)	*
data.ticket[topic_links][][id]	integer	*	The unique filter ID.
data.ticket[topic_links][][ticket]	integer id (Ticket)	*
data.ticket[topic_links][][topic]	integer id (CommunityTopic)	*
data.ticket[topic_links][][person]	integer id (Person)	*
data.ticket[topic_links][][date_created]	DateTime	*
data.ticket[custom_data][]	array of objects (CustomDataTicket)	*
data.ticket[custom_data][][ticket]	object (Ticket)	*
data.ticket[custom_data][][field]	object (CustomDefTicket)	*
data.ticket[custom_data][][field][parent]	object (CustomDefTicket)	*
data.ticket[custom_data][][field][children][]	array of objects (CustomDefTicket)	*	Field children.
data.ticket[custom_data][][field][title]		*
data.ticket[custom_data][][root_field]	object (CustomDefTicket)	*
data.ticket[labels][]	array of objects (LabelTicket)	*
data.ticket[labels][][ticket]	object (Ticket)	*
data.ticket[sent_to_address]	string	*	The email address the ticket was sent to if it came in via a gateway. This is a full string (e.g., including CC's) of the original.
data.ticket[email_account]	object (EmailAccount)	*	The gateway this ticket originated from.
data.ticket[email_account][id]	integer	*
data.ticket[email_account][account_type]	string	*
data.ticket[email_account][is_enabled]	boolean	*
data.ticket[email_account][address]	string	*
data.ticket[email_account][cert_blob]	object (Blob)	*
data.ticket[email_account][cert_blob][sys_name]	string	*	A unique system name for the blob.
data.ticket[email_account][cert_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[email_account][cert_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[email_account][cert_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[email_account][cert_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[email_account][cert_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[email_account][cert_blob][file_url]	string	*	The HTTP link to download the file.
data.ticket[email_account][cert_blob][authcode]	string	*
data.ticket[email_account][cert_blob][blob_hash]	string	*
data.ticket[email_account][cert_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[email_account][cert_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[email_account][cert_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[email_account][cert_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[email_account][cert_blob][date_created]	DateTime	*
data.ticket[email_account][cert_blob][is_temp]	boolean	*
data.ticket[email_account][cert_blob][source_ref]	string	*
data.ticket[email_account][cert_blob][labels][]	array of objects (LabelBlob)	*
data.ticket[email_account][cert_blob][labels][][blob]	object (Blob)	*
data.ticket[email_account][key_blob]	object (Blob)	*
data.ticket[email_account_address]	string	*	The email address (from list of to/cc) that matched with the email account.
data.ticket[creation_system]	string	*
data.ticket[creation_system_option]	string	*	Optional information about the creation system. For example, source URL the ticket came from.
data.ticket[ticket_hash]	string	*
data.ticket[status]	string	*
data.ticket[ticket_status]	object (TicketStatus)	*
data.ticket[ticket_status][id]	integer	*
data.ticket[ticket_status][status_type]	string	*
data.ticket[ticket_status][status_code]	string	*
data.ticket[ticket_status][sys_id]	string	*
data.ticket[ticket_status][title]	string	*
data.ticket[ticket_status][display_order]	integer	*
data.ticket[ticket_status][pending_waiting_time_mode]	string	*	Where to count time spending in pending status. Check PENDING_WAITING_TIME_MODE_ constants
data.ticket[ticket_status][children][]	array of objects (TicketStatus)	*
data.ticket[ticket_status][options]	array	*
data.ticket[ticket_status][statusType]		*
data.ticket[ticket_status][displayOrder]	integer	*
data.ticket[urgency]	integer	*
data.ticket[feedback_rating]	integer	*
data.ticket[date_feedback_rating]	DateTime	*
data.ticket[date_created]	DateTime	*
data.ticket[date_resolved]	DateTime	*
data.ticket[date_archived]	DateTime	*
data.ticket[date_first_agent_assign]	DateTime	*
data.ticket[date_first_agent_reply]	DateTime	*
data.ticket[date_last_agent_reply]	DateTime	*
data.ticket[date_last_user_reply]	DateTime	*
data.ticket[date_agent_waiting]	DateTime	*
data.ticket[date_user_waiting]	DateTime	*
data.ticket[date_status]	DateTime	*
data.ticket[date_on_hold]	DateTime	*
data.ticket[total_user_waiting]	integer	*
data.ticket[total_to_first_reply]	integer	*
data.ticket[total_user_waiting_wh_start]	DateTime	*
data.ticket[total_user_waiting_wh]	integer	*
data.ticket[total_to_first_reply_wh]	integer	*
data.ticket[locked_by_agent]	object (Person)	*
data.ticket[date_locked]	DateTime	*
data.ticket[has_attachments]	boolean	*
data.ticket[subject]	string	*
data.ticket[original_subject]	string	*
data.ticket[properties]	array	*
data.ticket[count_agent_replies]	integer	*
data.ticket[count_user_replies]	integer	*
data.ticket[worst_sla_status]	string	*
data.ticket[waiting_times]	array	*	Used to track ticket status changes and how much time ticket was in status Add new item every time status changed This is optimisation over TicketLog.
data.ticket[participants][]	array of objects (TicketParticipant)	*
data.ticket[participants][][id]	integer	*
data.ticket[participants][][ticket]	object (Ticket)	*
data.ticket[participants][][person]	object (Person)	*
data.ticket[participants][][access_code]	object (TicketAccessCode)	*
data.ticket[participants][][person_email]	object (PersonEmail)	*
data.ticket[participants][][default_on]	boolean	*	Default checkbox status of the user.
data.ticket[charges][]	array of objects (TicketCharge)	*
data.ticket[charges][][id]	integer	*
data.ticket[charges][][charge_time]	integer	*
data.ticket[charges][][amount]	float	*
data.ticket[charges][][date_created]	DateTime	*
data.ticket[charges][][ticket]	object (Ticket)	*
data.ticket[charges][][person]	object (Person)	*
data.ticket[charges][][organization]	object (Organization)	*
data.ticket[charges][][agent]	object (Person)	*
data.ticket[charges][][custom_data][]	array of objects (CustomDataBilling)	*
data.ticket[charges][][custom_data][][ticket_charge]	object (TicketCharge)	*
data.ticket[charges][][custom_data][][field]	object (CustomDefBilling)	*
data.ticket[charges][][custom_data][][field][parent]	object (CustomDefBilling)	*
data.ticket[charges][][custom_data][][field][children][]	array of objects (CustomDefBilling)	*	Field children.
data.ticket[charges][][custom_data][][field][title]		*
data.ticket[charges][][custom_data][][root_field]	object (CustomDefBilling)	*
data.ticket[ticket_slas][]	array of objects (TicketSla)	*
data.ticket[ticket_slas][][id]	integer	*	The unique ID.
data.ticket[ticket_slas][][sla_status]	string	*	The SLA status.
data.ticket[ticket_slas][][warn_date]	DateTime	*	The SLA warn date.
data.ticket[ticket_slas][][fail_date]	DateTime	*	The SLA fail date.
data.ticket[ticket_slas][][is_completed]	boolean	*	Is the SLA completed?
data.ticket[ticket_slas][][is_completed_set]	boolean	*	Completed by automated action.
data.ticket[ticket_slas][][completed_time_taken]	integer	*	Time taken.
data.ticket[ticket_slas][][ticket]	integer id (Ticket)	*	Ticket.
data.ticket[ticket_slas][][sla]	integer id (Sla)	*	SLA.
data.ticket[ticket_slas][][date_applied]	DateTime	*	time and date when SLA was applied to the ticket.
data.ticket[ticket_slas][][date_completed]	DateTime	*	time when SLA status became OK.
data.ticket[jira_issues][]	array of objects (JiraIssue)	*	linked jira issues.
data.ticket[jira_issues][][id]	integer	*	The unique ID.
data.ticket[jira_issues][][ticket]	object (Ticket)	*	The associated DeskPRO ticket.
data.ticket[jira_issues][][issue_id]	integer	*
data.ticket[jira_issues][][status_id]	integer	*
data.ticket[jira_issues][][created]	DateTime	*	Export time.
data.ticket[problems][]	array of objects (Problem)	*
data.ticket[problems][][id]	integer	*	The unique ID.
data.ticket[problems][][title]	string	*	Problem title.
data.ticket[problems][][creator]	integer id (Person)	*	Person who created the problem.
data.ticket[problems][][created]	DateTime	*	Date when the problem was created.
data.ticket[problems][][is_open]	boolean	*	Is problem still has no solution?
data.ticket[problems][][tickets][]	array of integer ids (Ticket)	*	Tickets associated with problem.
data.ticket[stars][]	array of objects (TicketFlagged)	*
data.ticket[stars][][ticket]	object (Ticket)	*
data.ticket[stars][][person_id]	integer	*
data.ticket[stars][][color]	string	*
data.ticket[follow_ups][]	array of objects (TicketFollowUp)	*
data.ticket[follow_ups][][id]	integer	*	The unique ID.
data.ticket[follow_ups][][person]	integer id (Person)	*
data.ticket[follow_ups][][actions]	array	*
data.ticket[follow_ups][][cancel_if_user_reply]	boolean	*
data.ticket[follow_ups][][cancel_if_agent_reply]	boolean	*
data.ticket[follow_ups][][status]	string	*
data.ticket[follow_ups][][date_created]	DateTime	*
data.ticket[follow_ups][][date_to_run]	DateTime	*
data.ticket[follow_ups][][date_did_run]	DateTime	*
data.ticket[follow_ups][][dateToRun]		*
data.ticket[logs][]	array of objects (TicketLog)	*
data.ticket[logs][][id]	integer	*
data.ticket[logs][][parent]	object (TicketLog)	*
data.ticket[logs][][ticket]	object (Ticket)	*
data.ticket[logs][][person]	object (Person)	*
data.ticket[logs][][action_type]	string	*
data.ticket[logs][][id_object]	integer	*	If the log involves a specific thing in a ticket (eg a message that was moved), then that is this id.
data.ticket[logs][][id_before]	integer	*	The ID of the previous entity changed, or any other numeric value.
data.ticket[logs][][id_after]	integer	*	The ID of the new entity, or any other numeric value.
data.ticket[logs][][trigger_id]	integer	*	If the change was caused by a trigger, the trigger id. Note this is the integer ID (not a FK relation) so the record is kept even if the trigger itself is deleted.
data.ticket[logs][][escalation_id]	integer	*	If the change was caused by an escalation Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.ticket[logs][][macro_id]	integer	*	If the change was caused by an v2 macro Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.ticket[logs][][sla]	object (Sla)	*	If the change was caused by an SLA, the SLA.
data.ticket[logs][][sla][id]	integer	*	The unique ID.
data.ticket[logs][][sla][title]	string	*	SLA title.
data.ticket[logs][][sla][sla_type]	string	*	Type of SLA - first_response, resolution, waiting_time.
data.ticket[logs][][sla][active_time]	string	*	Whether active all the time (all) or during work hours only (work_hours) or use the default ticket-wide settings (default).
data.ticket[logs][][sla][work_start]	integer	*	When the work day starts. This is stored as the number of seconds after 00:00:00.
data.ticket[logs][][sla][work_end]	integer	*	When the work day ends. This is stored as the number of seconds after 00:00:00.
data.ticket[logs][][sla][work_days]	array	*	Array of work days, stored with keys corresponding to day numbers. Values are true. 0 = Sunday, 6 = Saturday (same as PHP, easy to convert to MySQL which is 1 = Sunday, 7 = Saturday).
data.ticket[logs][][sla][work_timezone]	string	*	Timezone for work hours/days to be considered in.
data.ticket[logs][][sla][work_holidays]	array	*	List of work holidays.
data.ticket[logs][][sla][apply_type]	string	*	Controls how the SLA is applied to tickets: all, terms, terms_before_triggers, manual.
data.ticket[logs][][sla][apply_terms]	object (TriggerTerms)	*	Conditions to apply.
data.ticket[logs][][sla][apply_terms][version]	integer	*	Terms version.
data.ticket[logs][][sla][apply_terms][terms]	array	*	Terms themselves.
data.ticket[logs][][sla][trigger_terms]	object (TriggerTerms)	*	Conditions to consider sla completed.
data.ticket[logs][][sla][warn_time]	integer	*	Warn time integer.
data.ticket[logs][][sla][warn_time_unit]	string	*	And it's unit (see warn time).
data.ticket[logs][][sla][warn_actions]	object (TriggerActions)	*	How to warn about SLA will fail.
data.ticket[logs][][sla][warn_actions][version]	integer	*	Actions version.
data.ticket[logs][][sla][warn_actions][actions]	array	*	Actions array representation.
data.ticket[logs][][sla][fail_time]	integer	*	Fail time integer.
data.ticket[logs][][sla][fail_time_unit]	string	*	And it's measuring unit (see fail_time).
data.ticket[logs][][sla][fail_actions]	object (TriggerActions)	*	What to do if SLA failed.
data.ticket[logs][][sla][exclude_ticket_statuses]	array	*	This SLA will not apply while tickets are in these pending statuses.
data.ticket[logs][][sla_status]	string	*
data.ticket[logs][][details]	array	*
data.ticket[logs][][date_created]	DateTime	*
data.ticket[chats][]	array of objects (ChatConversation)	*
data.ticket[created_with_channel]	string	*
data.ticket[last_channel_used]	string	*
data.ticket[channels]	array	*
data.ticket[pending_articles][]	array of objects (ArticlePendingCreate)	*
data.ticket[pending_articles][][id]	integer	*
data.ticket[pending_articles][][person]	integer id (Person)	*
data.ticket[pending_articles][][assigned_person]	integer id (Person)	*
data.ticket[pending_articles][][ticket]	integer id (Ticket)	*
data.ticket[pending_articles][][message]	integer id (TicketMessage)	*
data.ticket[pending_articles][][comment]	string	*
data.ticket[pending_articles][][date_created]	DateTime	*
data.ticket[summary]	object (TicketSummary)	*
data.ticket[summary][id]	integer	*
data.ticket[summary][ticket]	object (Ticket)	*
data.ticket[summary][summary]	string	*
data.ticket[summary][summary_input]	string	*
data.ticket[summary][date_created]	DateTime	*
data.person	object (Person)	*
data.person[emails]		*
data.person[labels]		*
data.person[teams]		*
data.person[primary_team]		*
data.person[agentData]		*
data.person[publicUsergroups]		*
data.person[publicAgentgroups]		*
data.organization	object (Organization)	*
data.organization[id]	integer	*	The unique ID.
data.organization[picture_blob]	object (Blob)	*	The org picture.
data.organization[picture_blob][sys_name]	string	*	A unique system name for the blob.
data.organization[picture_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.organization[picture_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.organization[picture_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.organization[picture_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.organization[picture_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.organization[picture_blob][file_url]	string	*	The HTTP link to download the file.
data.organization[picture_blob][authcode]	string	*
data.organization[picture_blob][blob_hash]	string	*
data.organization[picture_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.organization[picture_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.organization[picture_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.organization[picture_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.organization[picture_blob][date_created]	DateTime	*
data.organization[picture_blob][is_temp]	boolean	*
data.organization[picture_blob][source_ref]	string	*
data.organization[picture_blob][labels][]	array of objects (LabelBlob)	*
data.organization[picture_blob][labels][][blob]	object (Blob)	*
data.organization[icon_property]	object (IconProperty)	*
data.organization[icon_property][urn]	string	*
data.organization[icon_property][options]	array	*
data.organization[name]	string	*	The organization name.
data.organization[summary]	string	*	The summary field as filled in by agents.
data.organization[importance]	integer	*	The org importance.
data.organization[custom_data][]	array of objects (CustomDataOrganization)	*
data.organization[custom_data][][organization]	object (Organization)	*
data.organization[custom_data][][field]	object (CustomDefOrganization)	*
data.organization[custom_data][][field][parent]	object (CustomDefOrganization)	*	Field`s parent.
data.organization[custom_data][][field][children][]	array of objects (CustomDefOrganization)	*	Field children.
data.organization[custom_data][][field][title]		*
data.organization[custom_data][][root_field]	object (CustomDefOrganization)	*
data.organization[usergroups][]	array of objects (Usergroup)	*	Usergroups the user belongs to.
data.organization[usergroups][][id]	integer	*	The unique ID, DB-generated.
data.organization[usergroups][][title]	string	*	Title of the usergroup.
data.organization[usergroups][][note]	string	*	A note or description about the usergroup.
data.organization[usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.organization[usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.organization[usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.organization[usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.organization[usergroups][][permissions][][id]	integer	*	The unique ID.
data.organization[usergroups][][permissions][][name]	string	*	The name of the permission.
data.organization[usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.organization[usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.organization[usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.organization[usergroups][][department_permissions][][department]	integer id (Department)	*
data.organization[usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.organization[usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.organization[usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.organization[usergroups][][department_permissions][][is_active]	boolean	*
data.organization[usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.organization[auto_cc_people][]	array of objects (Person)	*	Users who are set to automatically be added to tickets and other org things.
data.organization[labels][]	array of objects (LabelOrganization)	*
data.organization[labels][][organization]	object (Organization)	*
data.organization[contact_data][]	array of objects (OrganizationContactData)	*
data.organization[contact_data][][organization]		*
data.organization[contact_data][][contact_type]		*
data.organization[contact_data][][comment]		*
data.organization[contact_data][][field_1]		*
data.organization[contact_data][][field_2]		*
data.organization[contact_data][][field_3]		*
data.organization[contact_data][][field_5]		*
data.organization[contact_data][][field_9]		*
data.organization[emails][]	array of objects (OrganizationEmail)	*
data.organization[emails][][id]	integer	*	The unique log id.
data.organization[emails][][organization]	object (Organization)	*
data.organization[emails][][email]	string	*
data.organization[emails][][date_created]	DateTime	*
data.organization[email_domains][]	array of objects (OrganizationEmailDomain)	*
data.organization[email_domains][][domain]	string	*	The email domain.
data.organization[email_domains][][organization]	object (Organization)	*	The users organization.
data.organization[date_created]	DateTime	*	The date the org was inserted into the system.
data.organization[members][]	array of objects (Person)	*
data.organization[parent]	object (Organization)	*
data.organization[children][]	array of objects (Organization)	*
data.organization[tickets][]	array of objects (Ticket)	*
data.organization[organization_members][]	array of objects (OrganizationMember)	*
data.organization[organization_members][][id]	integer	*
data.organization[organization_members][][person]	integer id (Person)	*
data.organization[organization_members][][organization]	integer id (Organization)	*
data.organization[organization_members][][is_manager]	boolean	*
data.organization[organization_members][][position]	string	*
data.organization[organization_members][][created_at]	DateTime	*
data.organization[organization_members][][updated_at]	DateTime	*
data.organization[publicUsergroups]		*
data.agent	object (Person)	*
data.custom_data[]	array of objects (CustomDataBilling)	*
data.custom_data[][ticket_charge]	object (TicketCharge)	*
data.custom_data[][ticket_charge][id]	integer	*
data.custom_data[][ticket_charge][charge_time]	integer	*
data.custom_data[][ticket_charge][amount]	float	*
data.custom_data[][ticket_charge][date_created]	DateTime	*
data.custom_data[][ticket_charge][ticket]	object (Ticket)	*
data.custom_data[][ticket_charge][person]	object (Person)	*
data.custom_data[][ticket_charge][organization]	object (Organization)	*
data.custom_data[][ticket_charge][agent]	object (Person)	*
data.custom_data[][ticket_charge][custom_data][]	array of objects (CustomDataBilling)	*
data.custom_data[][field]	object (CustomDefBilling)	*
data.custom_data[][field][parent]	object (CustomDefBilling)	*
data.custom_data[][field][children][]	array of objects (CustomDefBilling)	*	Field children.
data.custom_data[][field][title]		*
data.custom_data[][root_field]	object (CustomDefBilling)	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/tickets/{parentId}/charges/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_charges.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Required?	Format
charge_time	integer	false
amount	float	false
date_created	string	false
comment	string	false
fields[1][mode]	string	false
fields[1][criteria]	string	false
fields[1][data]	string	false
fields[2][mode]	string	false
fields[2][criteria]	string	false
fields[2][data]	string	false
fields[3][mode]	string	false
fields[3][criteria]	string	false
fields[3][data]	choice	false
fields[7][mode]	string	false
fields[7][criteria]	string	false
fields[7][data]	boolean	false
fields[8][mode]	string	false
fields[8][criteria]	string	false
fields[8][data]	date	false	yyyy-MM-dd
fields[9][mode]	string	false
fields[9][criteria]	string	false
fields[9][data]	datetime	false	yyyy-MM-dd'T'HH:mm:ss

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/tickets/{parentId}/community_topic_links CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_community_topic_links.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (TicketCommunityTopicLink)	*
data[][ticket]	integer id (Ticket)	*
data[][topic]	integer id (CommunityTopic)	*
data[][id]	integer	*	The unique filter ID.
data[][person]	integer id (Person)	*
data[][date_created]	DateTime	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/tickets/{parentId}/community_topic_links CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_community_topic_links.post

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Required?
topic	choice	true
is_subscribe_ticket_owner	boolean	false
is_subscribe_ticket_participants	boolean	false

Parameter	Type	Versions	Description
data.ticket	integer id (Ticket)	*
data.topic	integer id (CommunityTopic)	*
data.id	integer	*	The unique filter ID.
data.person	integer id (Person)	*
data.date_created	DateTime	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/tickets/{parentId}/community_topic_links/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_community_topic_links.count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/tickets/{parentId}/community_topic_links/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_community_topic_links.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/tickets/{parentId}/community_topic_links/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_community_topic_links.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Versions	Description
data.ticket	integer id (Ticket)	*
data.topic	integer id (CommunityTopic)	*
data.id	integer	*	The unique filter ID.
data.person	integer id (Person)	*
data.date_created	DateTime	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

GET /api/v2/tickets/{parentId}/follow-ups CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_follow_ups.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (TicketFollowUp)	*
data[][actions]	array	*
data[][dateToRun]		*
data[][id]	integer	*	The unique ID.
data[][person]	integer id (Person)	*
data[][cancel_if_user_reply]	boolean	*
data[][cancel_if_agent_reply]	boolean	*
data[][status]	string	*
data[][date_created]	DateTime	*
data[][date_to_run]	DateTime	*
data[][date_did_run]	DateTime	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/tickets/{parentId}/follow-ups CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_follow_ups.post

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Required?	Format
ticket_has_invalid_fields	boolean	false
date_to_run	datetime	true	yyyy-MM-dd'T'HH:mm:ss
actions[][type]	string	true
actions[][options]	string	true
cancel_if_user_reply	boolean	true
cancel_if_agent_reply	boolean	true

Parameter	Type	Versions	Description
data.actions	array	*
data.dateToRun		*
data.id	integer	*	The unique ID.
data.person	integer id (Person)	*
data.cancel_if_user_reply	boolean	*
data.cancel_if_agent_reply	boolean	*
data.status	string	*
data.date_created	DateTime	*
data.date_to_run	DateTime	*
data.date_did_run	DateTime	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/tickets/{parentId}/follow-ups/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_follow_ups.count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/tickets/{parentId}/follow-ups/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_follow_ups.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/tickets/{parentId}/follow-ups/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_follow_ups.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Versions	Description
data.actions	array	*
data.dateToRun		*
data.id	integer	*	The unique ID.
data.person	integer id (Person)	*
data.cancel_if_user_reply	boolean	*
data.cancel_if_agent_reply	boolean	*
data.status	string	*
data.date_created	DateTime	*
data.date_to_run	DateTime	*
data.date_did_run	DateTime	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/tickets/{parentId}/follow-ups/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_follow_ups.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Required?	Format
ticket_has_invalid_fields	boolean	false
date_to_run	datetime	false	yyyy-MM-dd'T'HH:mm:ss
actions[][type]	string	false
actions[][options]	string	false
cancel_if_user_reply	boolean	false
cancel_if_agent_reply	boolean	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/tickets/{parentId}/logs CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_logs.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions
data[]	array of objects (TicketLog)	*
data[][id]	integer	*
data[][parent]	integer id (TicketLog)	*
data[][ticket]	integer id (Ticket)	*
data[][person]	integer id (Person)	*
data[][action_type]	string	*
data[][details]	array	*
data[][date_created]	DateTime	*
data[][message_html]	string	*
data[][message_text]	string	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/tickets/{parentId}/logs CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_logs.post

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Required?
details	string	false
message_html	string	false
message_text	string	false

Parameter	Type	Versions
data.id	integer	*
data.parent	integer id (TicketLog)	*
data.ticket	integer id (Ticket)	*
data.person	integer id (Person)	*
data.action_type	string	*
data.details	array	*
data.date_created	DateTime	*
data.message_html	string	*
data.message_text	string	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/tickets/{parentId}/logs/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_logs.count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

GET /api/v2/tickets/{parentId}/logs/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_logs.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Versions
data.id	integer	*
data.parent	integer id (TicketLog)	*
data.ticket	integer id (Ticket)	*
data.person	integer id (Person)	*
data.action_type	string	*
data.details	array	*
data.date_created	DateTime	*
data.message_html	string	*
data.message_text	string	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

GET /api/v2/tickets/{parentId}/messages CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_messages.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (TicketMessage)	*
data[][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data[][attachments][][id]	integer	*	The unique ID.
data[][attachments][][ticket]	integer id (Ticket)	*	Ticket this attachment belongs to.
data[][attachments][][person]	integer id (Person)	*	Who created the attachment.
data[][attachments][][blob]	object (Blob)	*	Actual attachment.
data[][attachments][][blob][sys_name]	string	*	A unique system name for the blob.
data[][attachments][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][attachments][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][attachments][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][attachments][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][attachments][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][attachments][][blob][file_url]	string	*	The HTTP link to download the file.
data[][attachments][][blob][authcode]	string	*
data[][attachments][][blob][blob_hash]	string	*
data[][attachments][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][attachments][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][attachments][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][attachments][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][attachments][][blob][date_created]	DateTime	*
data[][attachments][][blob][is_temp]	boolean	*
data[][attachments][][blob][source_ref]	string	*
data[][attachments][][blob][labels][]	array of objects (LabelBlob)	*
data[][attachments][][blob][labels][][blob]	object (Blob)	*
data[][attachments][][message]	integer id (TicketMessage)	*	Message - holder of this attachment.
data[][attachments][][is_agent_note]	boolean	*	True if this attachmen just a note.
data[][attachments][][is_inline]	boolean	*	Is this attachment is embed in message.
data[][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data[][snippet_use_logs][][id]	integer	*	The unique ID.
data[][snippet_use_logs][][snippet]	object (SnippetV2)	*	Snippet used.
data[][snippet_use_logs][][snippet][id]	integer	*
data[][snippet_use_logs][][snippet][title]	string	*
data[][snippet_use_logs][][snippet][author]	object (Person)	*
data[][snippet_use_logs][][snippet][is_private]	boolean	*
data[][snippet_use_logs][][snippet][avatar]	object (Blob)	*
data[][snippet_use_logs][][snippet][avatar][sys_name]	string	*	A unique system name for the blob.
data[][snippet_use_logs][][snippet][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][snippet_use_logs][][snippet][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][snippet_use_logs][][snippet][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][snippet_use_logs][][snippet][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][snippet_use_logs][][snippet][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data[][snippet_use_logs][][snippet][avatar][file_url]	string	*	The HTTP link to download the file.
data[][snippet_use_logs][][snippet][avatar][authcode]	string	*
data[][snippet_use_logs][][snippet][avatar][blob_hash]	string	*
data[][snippet_use_logs][][snippet][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][snippet_use_logs][][snippet][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][snippet_use_logs][][snippet][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][snippet_use_logs][][snippet][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][snippet_use_logs][][snippet][avatar][date_created]	DateTime	*
data[][snippet_use_logs][][snippet][avatar][is_temp]	boolean	*
data[][snippet_use_logs][][snippet][avatar][source_ref]	string	*
data[][snippet_use_logs][][snippet][avatar][labels][]	array of objects (LabelBlob)	*
data[][snippet_use_logs][][snippet][avatar][labels][][blob]	object (Blob)	*
data[][snippet_use_logs][][snippet][status]	string	*
data[][snippet_use_logs][][snippet][shortcut_codes]	array	*
data[][snippet_use_logs][][snippet][inline_translations]	array	*
data[][snippet_use_logs][][snippet][translations][]	array of objects (SnippetV2Translation)	*
data[][snippet_use_logs][][snippet][translations][][id]	integer	*	The unique ID.
data[][snippet_use_logs][][snippet][translations][][snippet]	object (SnippetV2)	*	Snippet translated.
data[][snippet_use_logs][][snippet][translations][][language]	object (Language)	*
data[][snippet_use_logs][][snippet][translations][][language][id]	integer	*	The unique ID.
data[][snippet_use_logs][][snippet][translations][][language][sys_name]	string	*	The unique sys name assigned to the language.
data[][snippet_use_logs][][snippet][translations][][language][title]	string	*	Title of the language.
data[][snippet_use_logs][][snippet][translations][][language][title_local]	string	*	Title of the language.
data[][snippet_use_logs][][snippet][translations][][language][base_filepath]	string	*	The base filepath for default phrases for this lang.
data[][snippet_use_logs][][snippet][translations][][language][locale]	string	*	The locale code.
data[][snippet_use_logs][][snippet][translations][][language][flag_image]	string	*	String path to image.
data[][snippet_use_logs][][snippet][translations][][language][is_rtl]	boolean	*	True if this is a right-to-left language.
data[][snippet_use_logs][][snippet][translations][][language][has_user]	boolean	*	True if has user.
data[][snippet_use_logs][][snippet][translations][][language][has_agent]	boolean	*	True if has agent.
data[][snippet_use_logs][][snippet][translations][][language][has_admin]	boolean	*	True if has admin.
data[][snippet_use_logs][][snippet][translations][][language][plural_categories][]	array of strings	*
data[][snippet_use_logs][][snippet][translations][][language][plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data[][snippet_use_logs][][snippet][translations][][language][flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`
data[][snippet_use_logs][][snippet][translations][][content]	array	*	Snippet content.
data[][snippet_use_logs][][snippet][translations][][blobs][]	array of objects (Blob)	*
data[][snippet_use_logs][][snippet][categories][]	array of objects (SnippetV2Category)	*
data[][snippet_use_logs][][snippet][categories][][id]	integer	*
data[][snippet_use_logs][][snippet][categories][][title]	string	*
data[][snippet_use_logs][][snippet][categories][][is_global]	boolean	*
data[][snippet_use_logs][][snippet][categories][][display_order]	integer	*
data[][snippet_use_logs][][snippet][categories][][parent]	object (SnippetV2Category)	*
data[][snippet_use_logs][][snippet][categories][][agent_teams][]	array of objects (AgentTeam)	*
data[][snippet_use_logs][][snippet][categories][][agent_teams][][id]	integer	*	The unique ID.
data[][snippet_use_logs][][snippet][categories][][agent_teams][][name]	string	*	The name of agent team.
data[][snippet_use_logs][][snippet][categories][][agent_teams][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][snippet_use_logs][][snippet][display_order]	integer	*
data[][snippet_use_logs][][snippet][date_created]	DateTime	*
data[][snippet_use_logs][][ticket_message]	object (TicketMessage)	*	Ticket Message where the snippet was used.
data[][snippet_use_logs][][ticket_message][id]	integer	*	The unique id of message.
data[][snippet_use_logs][][ticket_message][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data[][snippet_use_logs][][ticket_message][person]	object (Person)	*	Person this message was sent by.
data[][snippet_use_logs][][ticket_message][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data[][snippet_use_logs][][ticket_message][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data[][snippet_use_logs][][ticket_message][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data[][snippet_use_logs][][ticket_message][date_created]	DateTime	*	Date when message was created.
data[][snippet_use_logs][][ticket_message][is_agent_note]	boolean	*	Is this message agent note?
data[][snippet_use_logs][][ticket_message][is_hidden]	boolean	*	Is this message hidden?
data[][snippet_use_logs][][ticket_message][creation_system]	string	*	How this message was created.
data[][snippet_use_logs][][ticket_message][ip_address]	string	*	An ip address from which message was sent.
data[][snippet_use_logs][][ticket_message][visitor_id]	string	*	Unique ID of visitor left this message.
data[][snippet_use_logs][][ticket_message][hostname]	string	*	Host from which message was left.
data[][snippet_use_logs][][ticket_message][geo_country]	string	*	Country message is from (deprecated).
data[][snippet_use_logs][][ticket_message][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data[][snippet_use_logs][][ticket_message][message_hash]	string	*	An unique hash of message.
data[][snippet_use_logs][][ticket_message][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data[][snippet_use_logs][][ticket_message][primary_translation][id]	integer	*
data[][snippet_use_logs][][ticket_message][primary_translation][ticket]	object (Ticket)	*
data[][snippet_use_logs][][ticket_message][primary_translation][ticket_message]	object (TicketMessage)	*
data[][snippet_use_logs][][ticket_message][primary_translation][from_lang_code]	string	*
data[][snippet_use_logs][][ticket_message][primary_translation][lang_code]	string	*
data[][snippet_use_logs][][ticket_message][primary_translation][message]	string	*
data[][snippet_use_logs][][ticket_message][primary_translation][date_created]	DateTime	*
data[][snippet_use_logs][][ticket_message][message]	string	*	The message, will be in HTML!
data[][snippet_use_logs][][ticket_message][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data[][snippet_use_logs][][ticket_message][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data[][snippet_use_logs][][ticket_message][message_source]	string	*	The message source.
data[][snippet_use_logs][][ticket_message][message_source_type]	string	*	The message source type.
data[][snippet_use_logs][][ticket_message][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data[][snippet_use_logs][][ticket_message][lang_code]	string	*	The set/detected lang code.
data[][snippet_use_logs][][ticket_message][email_message_id][]	array of objects (TicketMessageEmailId)	*
data[][snippet_use_logs][][ticket_message][email_message_id][][id]	integer	*
data[][snippet_use_logs][][ticket_message][email_message_id][][message]	object (TicketMessage)	*
data[][snippet_use_logs][][ticket_message][email_message_id][][email_id]	string	*
data[][snippet_use_logs][][ticket_message][ticket_feedback][]	array of objects (TicketFeedback)	*
data[][snippet_use_logs][][ticket_message][ticket_feedback][][id]	integer	*
data[][snippet_use_logs][][ticket_message][ticket_feedback][][ticket]	object (Ticket)	*
data[][snippet_use_logs][][ticket_message][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data[][snippet_use_logs][][ticket_message][ticket_feedback][][person]	object (Person)	*
data[][snippet_use_logs][][ticket_message][ticket_feedback][][rating]	integer	*
data[][snippet_use_logs][][ticket_message][ticket_feedback][][message]	string	*
data[][snippet_use_logs][][ticket_message][ticket_feedback][][date_created]	DateTime	*
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][id]	integer	*
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][subject]	string	*
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][from_email]	string	*
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][tos]	array	*
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][ccs]	array	*
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][bccs]	array	*
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][message]	string	*
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][blobs][][authcode]	string	*
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][blobs][][blob_hash]	string	*
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][blobs][][source_ref]	string	*
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data[][snippet_use_logs][][ticket_message][ticket_message_forwards][][date_created]	DateTime	*
data[][snippet_use_logs][][ticket_message][channel_message]	object (TicketMessageChannelMessage)	*
data[][snippet_use_logs][][ticket_message][channel_message][id]	integer	*	@var int The unique id of message.
data[][snippet_use_logs][][ticket_message][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data[][snippet_use_logs][][ticket_message][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data[][snippet_use_logs][][ticket_message][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data[][snippet_use_logs][][ticket_message][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data[][snippet_use_logs][][ticket_message][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data[][snippet_use_logs][][ticket_message][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data[][snippet_use_logs][][ticket_message][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data[][snippet_use_logs][][ticket_message][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data[][snippet_use_logs][][ticket_message][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data[][snippet_use_logs][][chat_message]	object (ChatMessage)	*	Chat Message where the snippet was used.
data[][snippet_use_logs][][chat_message][id]	integer	*	The unique ID.
data[][snippet_use_logs][][chat_message][author_id]	integer	*	Author id (legacy).
data[][snippet_use_logs][][chat_message][author_type]	string	*	Author type (legacy).
data[][snippet_use_logs][][chat_message][conversation_id]	integer	*	Conversation id (legacy).
data[][snippet_use_logs][][chat_message][author]	integer id (Person)	*	Person who created the message.
data[][snippet_use_logs][][chat_message][content]	string	*	The message.
data[][snippet_use_logs][][chat_message][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data[][snippet_use_logs][][chat_message][is_user]	boolean	*	Is this an user's message? (send from the widget).
data[][snippet_use_logs][][chat_message][is_html]	boolean	*	Is the content an HTML message?
data[][snippet_use_logs][][chat_message][metadata]	array	*	Additional data.
data[][snippet_use_logs][][chat_message][date_created]	DateTime	*	Date message was created.
data[][snippet_use_logs][][chat_message][date_received]	DateTime	*	Date message was received.
data[][snippet_use_logs][][language]	object (Language)	*	Snippet translated.
data[][snippet_use_logs][][language][id]	integer	*	The unique ID.
data[][snippet_use_logs][][language][sys_name]	string	*	The unique sys name assigned to the language.
data[][snippet_use_logs][][language][title]	string	*	Title of the language.
data[][snippet_use_logs][][language][title_local]	string	*	Title of the language.
data[][snippet_use_logs][][language][base_filepath]	string	*	The base filepath for default phrases for this lang.
data[][snippet_use_logs][][language][locale]	string	*	The locale code.
data[][snippet_use_logs][][language][flag_image]	string	*	String path to image.
data[][snippet_use_logs][][language][is_rtl]	boolean	*	True if this is a right-to-left language.
data[][snippet_use_logs][][language][has_user]	boolean	*	True if has user.
data[][snippet_use_logs][][language][has_agent]	boolean	*	True if has agent.
data[][snippet_use_logs][][language][has_admin]	boolean	*	True if has admin.
data[][snippet_use_logs][][language][plural_categories][]	array of strings	*
data[][snippet_use_logs][][language][plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data[][snippet_use_logs][][language][flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`
data[][snippet_use_logs][][person]	object (Person)	*
data[][snippet_use_logs][][rating]	integer	*
data[][snippet_use_logs][][rating_person]	object (Person)	*
data[][snippet_use_logs][][rating_message]	string	*
data[][snippet_use_logs][][date_created]	DateTime	*
data[][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data[][primary_translation][id]	integer	*
data[][primary_translation][ticket]	object (Ticket)	*
data[][primary_translation][ticket_message]	object (TicketMessage)	*
data[][primary_translation][ticket_message][id]	integer	*	The unique id of message.
data[][primary_translation][ticket_message][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data[][primary_translation][ticket_message][person]	object (Person)	*	Person this message was sent by.
data[][primary_translation][ticket_message][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data[][primary_translation][ticket_message][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data[][primary_translation][ticket_message][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data[][primary_translation][ticket_message][date_created]	DateTime	*	Date when message was created.
data[][primary_translation][ticket_message][is_agent_note]	boolean	*	Is this message agent note?
data[][primary_translation][ticket_message][is_hidden]	boolean	*	Is this message hidden?
data[][primary_translation][ticket_message][creation_system]	string	*	How this message was created.
data[][primary_translation][ticket_message][ip_address]	string	*	An ip address from which message was sent.
data[][primary_translation][ticket_message][visitor_id]	string	*	Unique ID of visitor left this message.
data[][primary_translation][ticket_message][hostname]	string	*	Host from which message was left.
data[][primary_translation][ticket_message][geo_country]	string	*	Country message is from (deprecated).
data[][primary_translation][ticket_message][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data[][primary_translation][ticket_message][message_hash]	string	*	An unique hash of message.
data[][primary_translation][ticket_message][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data[][primary_translation][ticket_message][message]	string	*	The message, will be in HTML!
data[][primary_translation][ticket_message][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data[][primary_translation][ticket_message][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data[][primary_translation][ticket_message][message_source]	string	*	The message source.
data[][primary_translation][ticket_message][message_source_type]	string	*	The message source type.
data[][primary_translation][ticket_message][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data[][primary_translation][ticket_message][lang_code]	string	*	The set/detected lang code.
data[][primary_translation][ticket_message][email_message_id][]	array of objects (TicketMessageEmailId)	*
data[][primary_translation][ticket_message][email_message_id][][id]	integer	*
data[][primary_translation][ticket_message][email_message_id][][message]	object (TicketMessage)	*
data[][primary_translation][ticket_message][email_message_id][][email_id]	string	*
data[][primary_translation][ticket_message][ticket_feedback][]	array of objects (TicketFeedback)	*
data[][primary_translation][ticket_message][ticket_feedback][][id]	integer	*
data[][primary_translation][ticket_message][ticket_feedback][][ticket]	object (Ticket)	*
data[][primary_translation][ticket_message][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data[][primary_translation][ticket_message][ticket_feedback][][person]	object (Person)	*
data[][primary_translation][ticket_message][ticket_feedback][][rating]	integer	*
data[][primary_translation][ticket_message][ticket_feedback][][message]	string	*
data[][primary_translation][ticket_message][ticket_feedback][][date_created]	DateTime	*
data[][primary_translation][ticket_message][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data[][primary_translation][ticket_message][ticket_message_forwards][][id]	integer	*
data[][primary_translation][ticket_message][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data[][primary_translation][ticket_message][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data[][primary_translation][ticket_message][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data[][primary_translation][ticket_message][ticket_message_forwards][][subject]	string	*
data[][primary_translation][ticket_message][ticket_message_forwards][][from_email]	string	*
data[][primary_translation][ticket_message][ticket_message_forwards][][tos]	array	*
data[][primary_translation][ticket_message][ticket_message_forwards][][ccs]	array	*
data[][primary_translation][ticket_message][ticket_message_forwards][][bccs]	array	*
data[][primary_translation][ticket_message][ticket_message_forwards][][message]	string	*
data[][primary_translation][ticket_message][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data[][primary_translation][ticket_message][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data[][primary_translation][ticket_message][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][primary_translation][ticket_message][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][primary_translation][ticket_message][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][primary_translation][ticket_message][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][primary_translation][ticket_message][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data[][primary_translation][ticket_message][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data[][primary_translation][ticket_message][ticket_message_forwards][][blobs][][authcode]	string	*
data[][primary_translation][ticket_message][ticket_message_forwards][][blobs][][blob_hash]	string	*
data[][primary_translation][ticket_message][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][primary_translation][ticket_message][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][primary_translation][ticket_message][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][primary_translation][ticket_message][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][primary_translation][ticket_message][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data[][primary_translation][ticket_message][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data[][primary_translation][ticket_message][ticket_message_forwards][][blobs][][source_ref]	string	*
data[][primary_translation][ticket_message][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data[][primary_translation][ticket_message][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data[][primary_translation][ticket_message][ticket_message_forwards][][date_created]	DateTime	*
data[][primary_translation][ticket_message][channel_message]	object (TicketMessageChannelMessage)	*
data[][primary_translation][ticket_message][channel_message][id]	integer	*	@var int The unique id of message.
data[][primary_translation][ticket_message][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data[][primary_translation][ticket_message][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data[][primary_translation][ticket_message][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data[][primary_translation][ticket_message][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data[][primary_translation][ticket_message][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data[][primary_translation][ticket_message][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data[][primary_translation][ticket_message][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data[][primary_translation][ticket_message][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data[][primary_translation][ticket_message][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data[][primary_translation][from_lang_code]	string	*
data[][primary_translation][lang_code]	string	*
data[][primary_translation][message]	string	*
data[][primary_translation][date_created]	DateTime	*
data[][id]	integer	*	The unique id of message.
data[][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data[][ticket][id]	integer	*
data[][ticket][ref]	string	*
data[][ticket][auth]	string	*
data[][ticket][parent_ticket]	object (Ticket)	*	Parent ticket.
data[][ticket][children_tickets][]	array of objects (Ticket)	*
data[][ticket][language]	object (Language)	*	The language the ticket is in.
data[][ticket][language][id]	integer	*	The unique ID.
data[][ticket][language][sys_name]	string	*	The unique sys name assigned to the language.
data[][ticket][language][title]	string	*	Title of the language.
data[][ticket][language][title_local]	string	*	Title of the language.
data[][ticket][language][base_filepath]	string	*	The base filepath for default phrases for this lang.
data[][ticket][language][locale]	string	*	The locale code.
data[][ticket][language][flag_image]	string	*	String path to image.
data[][ticket][language][is_rtl]	boolean	*	True if this is a right-to-left language.
data[][ticket][language][has_user]	boolean	*	True if has user.
data[][ticket][language][has_agent]	boolean	*	True if has agent.
data[][ticket][language][has_admin]	boolean	*	True if has admin.
data[][ticket][language][plural_categories][]	array of strings	*
data[][ticket][language][plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data[][ticket][language][flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`
data[][ticket][brand]	object (Brand)	*
data[][ticket][brand][id]	integer	*	The unique ID.
data[][ticket][brand][name]	string	*	The brand name.
data[][ticket][brand][slug]	string	*
data[][ticket][brand][url]	string	*	The brand url.
data[][ticket][brand][theme_set]	object (ThemeSet)	*
data[][ticket][brand][theme_set][id]	integer	*
data[][ticket][brand][theme_set][theme_id]	string	*
data[][ticket][brand][theme_set][title]	string	*
data[][ticket][brand][edit_theme_set]	object (ThemeSet)	*
data[][ticket][brand][departments][]	array of objects (Department)	*
data[][ticket][brand][departments][][id]	integer	*
data[][ticket][brand][departments][][parent]	object (Department)	*
data[][ticket][brand][departments][][children][]	array of objects (Department)	*
data[][ticket][brand][departments][][title]	string	*
data[][ticket][brand][departments][][user_title]	string	*
data[][ticket][brand][departments][][is_tickets_enabled]	boolean	*
data[][ticket][brand][departments][][is_chat_enabled]	boolean	*
data[][ticket][brand][departments][][display_order]	integer	*
data[][ticket][brand][departments][][avatar]	object (Blob)	*
data[][ticket][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data[][ticket][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][ticket][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][ticket][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][ticket][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][ticket][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data[][ticket][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data[][ticket][brand][departments][][avatar][authcode]	string	*
data[][ticket][brand][departments][][avatar][blob_hash]	string	*
data[][ticket][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][ticket][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][ticket][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][ticket][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][ticket][brand][departments][][avatar][date_created]	DateTime	*
data[][ticket][brand][departments][][avatar][is_temp]	boolean	*
data[][ticket][brand][departments][][avatar][source_ref]	string	*
data[][ticket][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data[][ticket][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data[][ticket][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][ticket][brand][departments][][brands][]	array of objects (Brand)	*
data[][ticket][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data[][ticket][brand][departments][][permissions][][department]	integer id (Department)	*
data[][ticket][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][ticket][brand][departments][][permissions][][name]	string	*	The name of the permission.
data[][ticket][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][ticket][brand][departments][][permissions][][is_active]	boolean	*
data[][ticket][brand][departments][][chat_queue]	object (UserChatQueue)	*
data[][ticket][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data[][ticket][brand][departments][][chat_queue][name]	string	*
data[][ticket][brand][departments][][chat_queue][routing_model]	string	*
data[][ticket][brand][departments][][chat_queue][answer_timeout]	integer	*
data[][ticket][brand][departments][][chat_queue][is_all_agents]	boolean	*
data[][ticket][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data[][ticket][brand][departments][][chat_queue][max_queue_size]	integer	*
data[][ticket][brand][theme_sets][]	array of objects (ThemeSet)	*
data[][ticket][department]	object (Department)	*
data[][ticket][department][id]	integer	*
data[][ticket][department][parent]	object (Department)	*
data[][ticket][department][children][]	array of objects (Department)	*
data[][ticket][department][title]	string	*
data[][ticket][department][user_title]	string	*
data[][ticket][department][is_tickets_enabled]	boolean	*
data[][ticket][department][is_chat_enabled]	boolean	*
data[][ticket][department][display_order]	integer	*
data[][ticket][department][avatar]	object (Blob)	*
data[][ticket][department][avatar][sys_name]	string	*	A unique system name for the blob.
data[][ticket][department][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][ticket][department][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][ticket][department][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][ticket][department][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][ticket][department][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data[][ticket][department][avatar][file_url]	string	*	The HTTP link to download the file.
data[][ticket][department][avatar][authcode]	string	*
data[][ticket][department][avatar][blob_hash]	string	*
data[][ticket][department][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][ticket][department][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][ticket][department][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][ticket][department][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][ticket][department][avatar][date_created]	DateTime	*
data[][ticket][department][avatar][is_temp]	boolean	*
data[][ticket][department][avatar][source_ref]	string	*
data[][ticket][department][avatar][labels][]	array of objects (LabelBlob)	*
data[][ticket][department][avatar][labels][][blob]	object (Blob)	*
data[][ticket][department][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][ticket][department][brands][]	array of objects (Brand)	*
data[][ticket][department][permissions][]	array of objects (DepartmentPermission)	*
data[][ticket][department][permissions][][department]	integer id (Department)	*
data[][ticket][department][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][ticket][department][permissions][][name]	string	*	The name of the permission.
data[][ticket][department][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][ticket][department][permissions][][is_active]	boolean	*
data[][ticket][department][chat_queue]	object (UserChatQueue)	*
data[][ticket][department][chat_queue][id]	integer	*	The unique ID.
data[][ticket][department][chat_queue][name]	string	*
data[][ticket][department][chat_queue][routing_model]	string	*
data[][ticket][department][chat_queue][answer_timeout]	integer	*
data[][ticket][department][chat_queue][is_all_agents]	boolean	*
data[][ticket][department][chat_queue][departments][]	array of objects (Department)	*
data[][ticket][department][chat_queue][max_queue_size]	integer	*
data[][ticket][category]	object (TicketCategory)	*
data[][ticket][category][id]	integer	*	The unique ID.
data[][ticket][category][parent]	integer id (TicketCategory)	*	This category parent.
data[][ticket][category][title]	string	*	Category title.
data[][ticket][category][display_order]	integer	*	Obviously it's display order for lists.
data[][ticket][priority]	object (TicketPriority)	*
data[][ticket][priority][id]	integer	*	The unique ID.
data[][ticket][priority][title]	string	*	Priority title.
data[][ticket][priority][priority]	integer	*	The priority itself.
data[][ticket][workflow]	object (TicketWorkflow)	*
data[][ticket][workflow][id]	integer	*	The unique ID.
data[][ticket][workflow][title]	string	*	Workflow title.
data[][ticket][workflow][display_order]	integer	*	Workflow display order.
data[][ticket][product]	object (Product)	*
data[][ticket][product][parent]	integer id (Product)	*	Parent of the product.
data[][ticket][person]	object (Person)	*
data[][ticket][person_email]	object (PersonEmail)	*
data[][ticket][person_email][id]	integer	*	The unique ID.
data[][ticket][person_email][person]	integer id (Person)	*	Person owner of email.
data[][ticket][person_email][email]	string	*	The email address.
data[][ticket][person_email][email_domain]	string	*	The email address domain.
data[][ticket][person_email][is_validated]	boolean	*	True if validation passed.
data[][ticket][person_email][date_created]	DateTime	*	The original time the email was created.
data[][ticket][agent]	object (Person)	*
data[][ticket][agent_team]	object (AgentTeam)	*
data[][ticket][agent_team][id]	integer	*	The unique ID.
data[][ticket][agent_team][name]	string	*	The name of agent team.
data[][ticket][agent_team][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][ticket][organization]	object (Organization)	*
data[][ticket][organization][id]	integer	*	The unique ID.
data[][ticket][organization][picture_blob]	object (Blob)	*	The org picture.
data[][ticket][organization][picture_blob][sys_name]	string	*	A unique system name for the blob.
data[][ticket][organization][picture_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][ticket][organization][picture_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][ticket][organization][picture_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][ticket][organization][picture_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][ticket][organization][picture_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][ticket][organization][picture_blob][file_url]	string	*	The HTTP link to download the file.
data[][ticket][organization][picture_blob][authcode]	string	*
data[][ticket][organization][picture_blob][blob_hash]	string	*
data[][ticket][organization][picture_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][ticket][organization][picture_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][ticket][organization][picture_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][ticket][organization][picture_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][ticket][organization][picture_blob][date_created]	DateTime	*
data[][ticket][organization][picture_blob][is_temp]	boolean	*
data[][ticket][organization][picture_blob][source_ref]	string	*
data[][ticket][organization][picture_blob][labels][]	array of objects (LabelBlob)	*
data[][ticket][organization][picture_blob][labels][][blob]	object (Blob)	*
data[][ticket][organization][icon_property]	object (IconProperty)	*
data[][ticket][organization][icon_property][urn]	string	*
data[][ticket][organization][icon_property][options]	array	*
data[][ticket][organization][name]	string	*	The organization name.
data[][ticket][organization][summary]	string	*	The summary field as filled in by agents.
data[][ticket][organization][importance]	integer	*	The org importance.
data[][ticket][organization][custom_data][]	array of objects (CustomDataOrganization)	*
data[][ticket][organization][custom_data][][organization]	object (Organization)	*
data[][ticket][organization][custom_data][][field]	object (CustomDefOrganization)	*
data[][ticket][organization][custom_data][][field][parent]	object (CustomDefOrganization)	*	Field`s parent.
data[][ticket][organization][custom_data][][field][children][]	array of objects (CustomDefOrganization)	*	Field children.
data[][ticket][organization][custom_data][][root_field]	object (CustomDefOrganization)	*
data[][ticket][organization][usergroups][]	array of objects (Usergroup)	*	Usergroups the user belongs to.
data[][ticket][organization][usergroups][][id]	integer	*	The unique ID, DB-generated.
data[][ticket][organization][usergroups][][title]	string	*	Title of the usergroup.
data[][ticket][organization][usergroups][][note]	string	*	A note or description about the usergroup.
data[][ticket][organization][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data[][ticket][organization][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data[][ticket][organization][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data[][ticket][organization][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data[][ticket][organization][usergroups][][permissions][][id]	integer	*	The unique ID.
data[][ticket][organization][usergroups][][permissions][][name]	string	*	The name of the permission.
data[][ticket][organization][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][ticket][organization][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data[][ticket][organization][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data[][ticket][organization][usergroups][][department_permissions][][department]	integer id (Department)	*
data[][ticket][organization][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][ticket][organization][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data[][ticket][organization][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][ticket][organization][usergroups][][department_permissions][][is_active]	boolean	*
data[][ticket][organization][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data[][ticket][organization][auto_cc_people][]	array of objects (Person)	*	Users who are set to automatically be added to tickets and other org things.
data[][ticket][organization][labels][]	array of objects (LabelOrganization)	*
data[][ticket][organization][labels][][organization]	object (Organization)	*
data[][ticket][organization][contact_data][]	array of objects (OrganizationContactData)	*
data[][ticket][organization][emails][]	array of objects (OrganizationEmail)	*
data[][ticket][organization][emails][][id]	integer	*	The unique log id.
data[][ticket][organization][emails][][organization]	object (Organization)	*
data[][ticket][organization][emails][][email]	string	*
data[][ticket][organization][emails][][date_created]	DateTime	*
data[][ticket][organization][email_domains][]	array of objects (OrganizationEmailDomain)	*
data[][ticket][organization][email_domains][][domain]	string	*	The email domain.
data[][ticket][organization][email_domains][][organization]	object (Organization)	*	The users organization.
data[][ticket][organization][date_created]	DateTime	*	The date the org was inserted into the system.
data[][ticket][organization][members][]	array of objects (Person)	*
data[][ticket][organization][parent]	object (Organization)	*
data[][ticket][organization][children][]	array of objects (Organization)	*
data[][ticket][organization][tickets][]	array of objects (Ticket)	*
data[][ticket][organization][organization_members][]	array of objects (OrganizationMember)	*
data[][ticket][organization][organization_members][][id]	integer	*
data[][ticket][organization][organization_members][][person]	integer id (Person)	*
data[][ticket][organization][organization_members][][organization]	integer id (Organization)	*
data[][ticket][organization][organization_members][][is_manager]	boolean	*
data[][ticket][organization][organization_members][][position]	string	*
data[][ticket][organization][organization_members][][created_at]	DateTime	*
data[][ticket][organization][organization_members][][updated_at]	DateTime	*
data[][ticket][linked_chat]	object (ChatConversation)	*
data[][ticket][linked_chat][id]	integer	*	The unique id of chat conversation.
data[][ticket][linked_chat][department]	object (Department)	*	Department which chat was assigned.
data[][ticket][linked_chat][brand]	object (Brand)	*	Department which chat was assigned.
data[][ticket][linked_chat][task_id]	integer	*
data[][ticket][linked_chat][ticket]	object (Ticket)	*
data[][ticket][linked_chat][labels][]	array of objects (LabelChatConversation)	*
data[][ticket][linked_chat][labels][][chat]	object (ChatConversation)	*
data[][ticket][linked_chat][subject]	string	*	Subject of the chat conversation.
data[][ticket][linked_chat][status]	string	*	Status of the chat conversation.
data[][ticket][linked_chat][agent]	object (Person)	*	If this is a user conversation, this is the agent assigned.
data[][ticket][linked_chat][agent_team]	object (AgentTeam)	*	If this is a team chat, the team it is.
data[][ticket][linked_chat][person]	object (Person)	*	If this is a user conversation, this is the user who started the chat.
data[][ticket][linked_chat][session]	object (Session)	*	If this is a user convo, this is the users session.
data[][ticket][linked_chat][session][id]	integer	*	The unique ID.
data[][ticket][linked_chat][session][auth]	string	*	The authcode for the session to verify an id.
data[][ticket][linked_chat][session][interface]	string	*	The Interface the session is for.
data[][ticket][linked_chat][session][person]	object (Person)	*
data[][ticket][linked_chat][session][user_agent]	string	*	The users user agent string.
data[][ticket][linked_chat][session][visitor_id]	string	*
data[][ticket][linked_chat][session][ip_address]	string	*	The users IP address.
data[][ticket][linked_chat][session][data]	string	*
data[][ticket][linked_chat][session][is_person]	boolean	*
data[][ticket][linked_chat][session][is_bot]	boolean	*
data[][ticket][linked_chat][session][is_helpdesk]	boolean	*
data[][ticket][linked_chat][session][active_status]	string	*	(Agents) Status (available or away).
data[][ticket][linked_chat][session][is_chat_available]	boolean	*	(Agents) Wehn status is available, if they are available for chat.
data[][ticket][linked_chat][session][date_created]	DateTime	*
data[][ticket][linked_chat][session][date_last]	DateTime	*
data[][ticket][linked_chat][session][date_last_page]	DateTime	*
data[][ticket][linked_chat][visitor_id]	string	*
data[][ticket][linked_chat][person_name]	string	*	User chat: The users name, if they arent a person.
data[][ticket][linked_chat][person_email]	string	*	User chat: The users email, if they aren`t a person.
data[][ticket][linked_chat][participants][]	array of objects (Person)	*
data[][ticket][linked_chat][messages][]	array of objects (ChatMessage)	*
data[][ticket][linked_chat][messages][][id]	integer	*	The unique ID.
data[][ticket][linked_chat][messages][][author_id]	integer	*	Author id (legacy).
data[][ticket][linked_chat][messages][][author_type]	string	*	Author type (legacy).
data[][ticket][linked_chat][messages][][conversation_id]	integer	*	Conversation id (legacy).
data[][ticket][linked_chat][messages][][author]	integer id (Person)	*	Person who created the message.
data[][ticket][linked_chat][messages][][content]	string	*	The message.
data[][ticket][linked_chat][messages][][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data[][ticket][linked_chat][messages][][is_user]	boolean	*	Is this an user's message? (send from the widget).
data[][ticket][linked_chat][messages][][is_html]	boolean	*	Is the content an HTML message?
data[][ticket][linked_chat][messages][][metadata]	array	*	Additional data.
data[][ticket][linked_chat][messages][][date_created]	DateTime	*	Date message was created.
data[][ticket][linked_chat][messages][][date_received]	DateTime	*	Date message was received.
data[][ticket][linked_chat][custom_data][]	array of objects (CustomDataChat)	*
data[][ticket][linked_chat][custom_data][][conversation]	object (ChatConversation)	*	The conversation the message belongs to.
data[][ticket][linked_chat][custom_data][][field]	object (CustomDefChat)	*
data[][ticket][linked_chat][custom_data][][field][parent]	object (CustomDefChat)	*
data[][ticket][linked_chat][custom_data][][field][children][]	array of objects (CustomDefChat)	*	Field children.
data[][ticket][linked_chat][custom_data][][root_field]	object (CustomDefChat)	*
data[][ticket][linked_chat][rating_response_time]	integer	*
data[][ticket][linked_chat][rating_overall]	integer	*
data[][ticket][linked_chat][rating_comment]	string	*
data[][ticket][linked_chat][is_agent]	boolean	*	Is this an agent chat.
data[][ticket][linked_chat][is_window]	boolean	*	If the chat is popped out into a window. This is used to make sure the JS widget on pages doesn't load again.
data[][ticket][linked_chat][date_created]	DateTime	*	Date when chat was started.
data[][ticket][linked_chat][date_user_waiting]	DateTime	*	Since when the user has started waiting (i.e., time the assignment was 0).
data[][ticket][linked_chat][date_assigned]	DateTime	*
data[][ticket][linked_chat][date_agent_typing]	DateTime	*	Date when agent typed last time.
data[][ticket][linked_chat][date_first_agent_message]	DateTime	*
data[][ticket][linked_chat][date_ended]	DateTime	*	Date when chat was ended.
data[][ticket][linked_chat][total_to_ended]	integer	*
data[][ticket][linked_chat][ended_by]	string	*	Who ended the chat.
data[][ticket][linked_chat][should_send_transcript]	boolean	*	True if transcript should be send.
data[][ticket][linked_chat][date_transcript_sent]	DateTime	*	Date when transcript was sent.
data[][ticket][linked_chat][email_validation_code]	string	*
data[][ticket][linked_chat][email_validated]	boolean	*
data[][ticket][linked_chat][access_token]	string	*
data[][ticket][attachments][]	array of objects (TicketAttachment)	*
data[][ticket][attachments][][id]	integer	*	The unique ID.
data[][ticket][attachments][][ticket]	integer id (Ticket)	*	Ticket this attachment belongs to.
data[][ticket][attachments][][person]	integer id (Person)	*	Who created the attachment.
data[][ticket][attachments][][blob]	object (Blob)	*	Actual attachment.
data[][ticket][attachments][][blob][sys_name]	string	*	A unique system name for the blob.
data[][ticket][attachments][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][ticket][attachments][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][ticket][attachments][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][ticket][attachments][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][ticket][attachments][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][ticket][attachments][][blob][file_url]	string	*	The HTTP link to download the file.
data[][ticket][attachments][][blob][authcode]	string	*
data[][ticket][attachments][][blob][blob_hash]	string	*
data[][ticket][attachments][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][ticket][attachments][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][ticket][attachments][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][ticket][attachments][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][ticket][attachments][][blob][date_created]	DateTime	*
data[][ticket][attachments][][blob][is_temp]	boolean	*
data[][ticket][attachments][][blob][source_ref]	string	*
data[][ticket][attachments][][blob][labels][]	array of objects (LabelBlob)	*
data[][ticket][attachments][][blob][labels][][blob]	object (Blob)	*
data[][ticket][attachments][][message]	integer id (TicketMessage)	*	Message - holder of this attachment.
data[][ticket][attachments][][is_agent_note]	boolean	*	True if this attachmen just a note.
data[][ticket][attachments][][is_inline]	boolean	*	Is this attachment is embed in message.
data[][ticket][access_codes][]	array of objects (TicketAccessCode)	*
data[][ticket][access_codes][][id]	integer	*
data[][ticket][access_codes][][ticket]	object (Ticket)	*
data[][ticket][access_codes][][person]	object (Person)	*
data[][ticket][access_codes][][auth]	string	*
data[][ticket][messages][]	array of objects (TicketMessage)	*
data[][ticket][messages][][id]	integer	*	The unique id of message.
data[][ticket][messages][][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data[][ticket][messages][][person]	object (Person)	*	Person this message was sent by.
data[][ticket][messages][][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data[][ticket][messages][][email_source][id]	integer	*
data[][ticket][messages][][email_source][uuid]	string	*
data[][ticket][messages][][email_source][blob]	object (Blob)	*
data[][ticket][messages][][email_source][blob][sys_name]	string	*	A unique system name for the blob.
data[][ticket][messages][][email_source][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][ticket][messages][][email_source][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][ticket][messages][][email_source][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][ticket][messages][][email_source][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][ticket][messages][][email_source][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][ticket][messages][][email_source][blob][file_url]	string	*	The HTTP link to download the file.
data[][ticket][messages][][email_source][blob][authcode]	string	*
data[][ticket][messages][][email_source][blob][blob_hash]	string	*
data[][ticket][messages][][email_source][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][ticket][messages][][email_source][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][ticket][messages][][email_source][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][ticket][messages][][email_source][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][ticket][messages][][email_source][blob][date_created]	DateTime	*
data[][ticket][messages][][email_source][blob][is_temp]	boolean	*
data[][ticket][messages][][email_source][blob][source_ref]	string	*
data[][ticket][messages][][email_source][blob][labels][]	array of objects (LabelBlob)	*
data[][ticket][messages][][email_source][blob][labels][][blob]	object (Blob)	*
data[][ticket][messages][][email_source][object_type]	string	*	The type of object this is attached to (should be the table name of the super type, eg: tickets, people, organizations). This typically is not set until after the email is processed (ie the status is 'processed').
data[][ticket][messages][][email_source][object_id]	integer	*	The ID of the object this is attached to.
data[][ticket][messages][][email_source][from_email]	string	*
data[][ticket][messages][][email_source][status]	string	*	The current status of the message: - inserted: Only inserted - processing: Currently processing - complete: Fully processed - error: Tried to process but there was some kind of error (see error_code).
data[][ticket][messages][][email_source][date_status]	DateTime	*
data[][ticket][messages][][email_source][error_code]	string	*	When status is error, this is the code that describes the error.
data[][ticket][messages][][email_source][date_created]	DateTime	*
data[][ticket][messages][][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data[][ticket][messages][][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data[][ticket][messages][][snippet_use_logs][][id]	integer	*	The unique ID.
data[][ticket][messages][][snippet_use_logs][][snippet]	object (SnippetV2)	*	Snippet used.
data[][ticket][messages][][snippet_use_logs][][snippet][id]	integer	*
data[][ticket][messages][][snippet_use_logs][][snippet][title]	string	*
data[][ticket][messages][][snippet_use_logs][][snippet][author]	object (Person)	*
data[][ticket][messages][][snippet_use_logs][][snippet][is_private]	boolean	*
data[][ticket][messages][][snippet_use_logs][][snippet][avatar]	object (Blob)	*
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][sys_name]	string	*	A unique system name for the blob.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][file_url]	string	*	The HTTP link to download the file.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][authcode]	string	*
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][blob_hash]	string	*
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][date_created]	DateTime	*
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][is_temp]	boolean	*
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][source_ref]	string	*
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][labels][]	array of objects (LabelBlob)	*
data[][ticket][messages][][snippet_use_logs][][snippet][avatar][labels][][blob]	object (Blob)	*
data[][ticket][messages][][snippet_use_logs][][snippet][status]	string	*
data[][ticket][messages][][snippet_use_logs][][snippet][shortcut_codes]	array	*
data[][ticket][messages][][snippet_use_logs][][snippet][inline_translations]	array	*
data[][ticket][messages][][snippet_use_logs][][snippet][translations][]	array of objects (SnippetV2Translation)	*
data[][ticket][messages][][snippet_use_logs][][snippet][translations][][id]	integer	*	The unique ID.
data[][ticket][messages][][snippet_use_logs][][snippet][translations][][snippet]	object (SnippetV2)	*	Snippet translated.
data[][ticket][messages][][snippet_use_logs][][snippet][translations][][language]	object (Language)	*
data[][ticket][messages][][snippet_use_logs][][snippet][translations][][content]	array	*	Snippet content.
data[][ticket][messages][][snippet_use_logs][][snippet][translations][][blobs][]	array of objects (Blob)	*
data[][ticket][messages][][snippet_use_logs][][snippet][categories][]	array of objects (SnippetV2Category)	*
data[][ticket][messages][][snippet_use_logs][][snippet][categories][][id]	integer	*
data[][ticket][messages][][snippet_use_logs][][snippet][categories][][title]	string	*
data[][ticket][messages][][snippet_use_logs][][snippet][categories][][is_global]	boolean	*
data[][ticket][messages][][snippet_use_logs][][snippet][categories][][display_order]	integer	*
data[][ticket][messages][][snippet_use_logs][][snippet][categories][][parent]	object (SnippetV2Category)	*
data[][ticket][messages][][snippet_use_logs][][snippet][categories][][agent_teams][]	array of objects (AgentTeam)	*
data[][ticket][messages][][snippet_use_logs][][snippet][display_order]	integer	*
data[][ticket][messages][][snippet_use_logs][][snippet][date_created]	DateTime	*
data[][ticket][messages][][snippet_use_logs][][ticket_message]	object (TicketMessage)	*	Ticket Message where the snippet was used.
data[][ticket][messages][][snippet_use_logs][][chat_message]	object (ChatMessage)	*	Chat Message where the snippet was used.
data[][ticket][messages][][snippet_use_logs][][chat_message][id]	integer	*	The unique ID.
data[][ticket][messages][][snippet_use_logs][][chat_message][author_id]	integer	*	Author id (legacy).
data[][ticket][messages][][snippet_use_logs][][chat_message][author_type]	string	*	Author type (legacy).
data[][ticket][messages][][snippet_use_logs][][chat_message][conversation_id]	integer	*	Conversation id (legacy).
data[][ticket][messages][][snippet_use_logs][][chat_message][author]	integer id (Person)	*	Person who created the message.
data[][ticket][messages][][snippet_use_logs][][chat_message][content]	string	*	The message.
data[][ticket][messages][][snippet_use_logs][][chat_message][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data[][ticket][messages][][snippet_use_logs][][chat_message][is_user]	boolean	*	Is this an user's message? (send from the widget).
data[][ticket][messages][][snippet_use_logs][][chat_message][is_html]	boolean	*	Is the content an HTML message?
data[][ticket][messages][][snippet_use_logs][][chat_message][metadata]	array	*	Additional data.
data[][ticket][messages][][snippet_use_logs][][chat_message][date_created]	DateTime	*	Date message was created.
data[][ticket][messages][][snippet_use_logs][][chat_message][date_received]	DateTime	*	Date message was received.
data[][ticket][messages][][snippet_use_logs][][language]	object (Language)	*	Snippet translated.
data[][ticket][messages][][snippet_use_logs][][person]	object (Person)	*
data[][ticket][messages][][snippet_use_logs][][rating]	integer	*
data[][ticket][messages][][snippet_use_logs][][rating_person]	object (Person)	*
data[][ticket][messages][][snippet_use_logs][][rating_message]	string	*
data[][ticket][messages][][snippet_use_logs][][date_created]	DateTime	*
data[][ticket][messages][][date_created]	DateTime	*	Date when message was created.
data[][ticket][messages][][is_agent_note]	boolean	*	Is this message agent note?
data[][ticket][messages][][is_hidden]	boolean	*	Is this message hidden?
data[][ticket][messages][][creation_system]	string	*	How this message was created.
data[][ticket][messages][][ip_address]	string	*	An ip address from which message was sent.
data[][ticket][messages][][visitor_id]	string	*	Unique ID of visitor left this message.
data[][ticket][messages][][hostname]	string	*	Host from which message was left.
data[][ticket][messages][][geo_country]	string	*	Country message is from (deprecated).
data[][ticket][messages][][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data[][ticket][messages][][message_hash]	string	*	An unique hash of message.
data[][ticket][messages][][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data[][ticket][messages][][primary_translation][id]	integer	*
data[][ticket][messages][][primary_translation][ticket]	object (Ticket)	*
data[][ticket][messages][][primary_translation][ticket_message]	object (TicketMessage)	*
data[][ticket][messages][][primary_translation][from_lang_code]	string	*
data[][ticket][messages][][primary_translation][lang_code]	string	*
data[][ticket][messages][][primary_translation][message]	string	*
data[][ticket][messages][][primary_translation][date_created]	DateTime	*
data[][ticket][messages][][message]	string	*	The message, will be in HTML!
data[][ticket][messages][][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data[][ticket][messages][][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data[][ticket][messages][][message_source]	string	*	The message source.
data[][ticket][messages][][message_source_type]	string	*	The message source type.
data[][ticket][messages][][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data[][ticket][messages][][lang_code]	string	*	The set/detected lang code.
data[][ticket][messages][][email_message_id][]	array of objects (TicketMessageEmailId)	*
data[][ticket][messages][][email_message_id][][id]	integer	*
data[][ticket][messages][][email_message_id][][message]	object (TicketMessage)	*
data[][ticket][messages][][email_message_id][][email_id]	string	*
data[][ticket][messages][][ticket_feedback][]	array of objects (TicketFeedback)	*
data[][ticket][messages][][ticket_feedback][][id]	integer	*
data[][ticket][messages][][ticket_feedback][][ticket]	object (Ticket)	*
data[][ticket][messages][][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data[][ticket][messages][][ticket_feedback][][person]	object (Person)	*
data[][ticket][messages][][ticket_feedback][][rating]	integer	*
data[][ticket][messages][][ticket_feedback][][message]	string	*
data[][ticket][messages][][ticket_feedback][][date_created]	DateTime	*
data[][ticket][messages][][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data[][ticket][messages][][ticket_message_forwards][][id]	integer	*
data[][ticket][messages][][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data[][ticket][messages][][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data[][ticket][messages][][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data[][ticket][messages][][ticket_message_forwards][][subject]	string	*
data[][ticket][messages][][ticket_message_forwards][][from_email]	string	*
data[][ticket][messages][][ticket_message_forwards][][tos]	array	*
data[][ticket][messages][][ticket_message_forwards][][ccs]	array	*
data[][ticket][messages][][ticket_message_forwards][][bccs]	array	*
data[][ticket][messages][][ticket_message_forwards][][message]	string	*
data[][ticket][messages][][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data[][ticket][messages][][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data[][ticket][messages][][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][ticket][messages][][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][ticket][messages][][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][ticket][messages][][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][ticket][messages][][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data[][ticket][messages][][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data[][ticket][messages][][ticket_message_forwards][][blobs][][authcode]	string	*
data[][ticket][messages][][ticket_message_forwards][][blobs][][blob_hash]	string	*
data[][ticket][messages][][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][ticket][messages][][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][ticket][messages][][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][ticket][messages][][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][ticket][messages][][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data[][ticket][messages][][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data[][ticket][messages][][ticket_message_forwards][][blobs][][source_ref]	string	*
data[][ticket][messages][][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data[][ticket][messages][][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data[][ticket][messages][][ticket_message_forwards][][date_created]	DateTime	*
data[][ticket][messages][][channel_message]	object (TicketMessageChannelMessage)	*
data[][ticket][messages][][channel_message][id]	integer	*	@var int The unique id of message.
data[][ticket][messages][][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data[][ticket][messages][][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data[][ticket][messages][][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data[][ticket][messages][][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data[][ticket][messages][][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data[][ticket][messages][][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data[][ticket][messages][][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data[][ticket][messages][][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data[][ticket][messages][][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data[][ticket][sms_messages][]	array of objects (TicketSms)	*
data[][ticket][sms_messages][][id]	integer	*
data[][ticket][sms_messages][][ticket]	object (Ticket)	*
data[][ticket][sms_messages][][person]	object (Person)	*
data[][ticket][sms_messages][][sms_account]	object (SmsAccount)	*
data[][ticket][sms_messages][][sms_account][id]	integer	*	The unique ID.
data[][ticket][sms_messages][][sms_account][type]	string	*
data[][ticket][sms_messages][][sms_account][params]	array	*
data[][ticket][sms_messages][][sms_account][identifier]	string	*
data[][ticket][sms_messages][][sms_account][is_enabled]	boolean	*
data[][ticket][sms_messages][][sms_account][is_connected]	boolean	*
data[][ticket][sms_messages][][sms_account][is_tested]	boolean	*
data[][ticket][sms_messages][][sms_account][test_code]	string	*
data[][ticket][sms_messages][][job]	object (Job)	*
data[][ticket][sms_messages][][job][id]	integer	*	The unique job id.
data[][ticket][sms_messages][][job][type]	string	*	The job type, used by the Job Router to find the right Job Processor.
data[][ticket][sms_messages][][job][status]	string	*	The status of the job.
data[][ticket][sms_messages][][job][status_code]	string	*	Any code to further classify the status.
data[][ticket][sms_messages][][job][date_touch]	DateTime	*	Date the last time a process "touched" this ticket.
data[][ticket][sms_messages][][job][date_created]	DateTime	*	Date this job entered the "jobs" table.
data[][ticket][sms_messages][][job][date_last_try]	DateTime	*	Last time we processed this job.
data[][ticket][sms_messages][][job][date_next_try]	DateTime	*	If this DateTime is in the future, it won't be selected for execution.
data[][ticket][sms_messages][][job][num_tries]	integer	*	The number of times this job has been executed Job Processor (usually indicated failures if > 1).
data[][ticket][sms_messages][][job][log_summary]	string	*	A human readable summary of the job's execution.
data[][ticket][sms_messages][][job][log]	string	*	A more verbose log.
data[][ticket][sms_messages][][job][data]	array	*	An array of data, or payload, that the job processor needs to execute this job (stored in the db as json). This MUST always be an array, even if its an empty array
data[][ticket][sms_messages][][job][original_job]	integer	*	Null unless the job was created as a retry - if so, the originating job ID is stored here so we can query it later. Note: You MUST specify the originating job, do not create a linked list of failed jobs.
data[][ticket][sms_messages][][date_created]	DateTime	*
data[][ticket][sms_messages][][from_number]	string	*	Permanent record of the phone number that sent this SMS. (Won't change even if Person changes their phone number).
data[][ticket][sms_messages][][to_number]	string	*	Permanent record of the phone number that this SMS was sent to.
data[][ticket][sms_messages][][message]	string	*	The SMS message.
data[][ticket][sms_messages][][direction]	string	*	Just a system flag for reporting.
data[][ticket][topic_links][]	array of objects (TicketCommunityTopicLink)	*
data[][ticket][topic_links][][id]	integer	*	The unique filter ID.
data[][ticket][topic_links][][ticket]	integer id (Ticket)	*
data[][ticket][topic_links][][topic]	integer id (CommunityTopic)	*
data[][ticket][topic_links][][person]	integer id (Person)	*
data[][ticket][topic_links][][date_created]	DateTime	*
data[][ticket][custom_data][]	array of objects (CustomDataTicket)	*
data[][ticket][custom_data][][ticket]	object (Ticket)	*
data[][ticket][custom_data][][field]	object (CustomDefTicket)	*
data[][ticket][custom_data][][field][parent]	object (CustomDefTicket)	*
data[][ticket][custom_data][][field][children][]	array of objects (CustomDefTicket)	*	Field children.
data[][ticket][custom_data][][root_field]	object (CustomDefTicket)	*
data[][ticket][labels][]	array of objects (LabelTicket)	*
data[][ticket][labels][][ticket]	object (Ticket)	*
data[][ticket][sent_to_address]	string	*	The email address the ticket was sent to if it came in via a gateway. This is a full string (e.g., including CC's) of the original.
data[][ticket][email_account]	object (EmailAccount)	*	The gateway this ticket originated from.
data[][ticket][email_account][id]	integer	*
data[][ticket][email_account][account_type]	string	*
data[][ticket][email_account][is_enabled]	boolean	*
data[][ticket][email_account][address]	string	*
data[][ticket][email_account][cert_blob]	object (Blob)	*
data[][ticket][email_account][cert_blob][sys_name]	string	*	A unique system name for the blob.
data[][ticket][email_account][cert_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][ticket][email_account][cert_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][ticket][email_account][cert_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][ticket][email_account][cert_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][ticket][email_account][cert_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][ticket][email_account][cert_blob][file_url]	string	*	The HTTP link to download the file.
data[][ticket][email_account][cert_blob][authcode]	string	*
data[][ticket][email_account][cert_blob][blob_hash]	string	*
data[][ticket][email_account][cert_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][ticket][email_account][cert_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][ticket][email_account][cert_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][ticket][email_account][cert_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][ticket][email_account][cert_blob][date_created]	DateTime	*
data[][ticket][email_account][cert_blob][is_temp]	boolean	*
data[][ticket][email_account][cert_blob][source_ref]	string	*
data[][ticket][email_account][cert_blob][labels][]	array of objects (LabelBlob)	*
data[][ticket][email_account][cert_blob][labels][][blob]	object (Blob)	*
data[][ticket][email_account][key_blob]	object (Blob)	*
data[][ticket][email_account_address]	string	*	The email address (from list of to/cc) that matched with the email account.
data[][ticket][creation_system]	string	*
data[][ticket][creation_system_option]	string	*	Optional information about the creation system. For example, source URL the ticket came from.
data[][ticket][ticket_hash]	string	*
data[][ticket][status]	string	*
data[][ticket][ticket_status]	object (TicketStatus)	*
data[][ticket][ticket_status][id]	integer	*
data[][ticket][ticket_status][status_type]	string	*
data[][ticket][ticket_status][status_code]	string	*
data[][ticket][ticket_status][sys_id]	string	*
data[][ticket][ticket_status][title]	string	*
data[][ticket][ticket_status][display_order]	integer	*
data[][ticket][ticket_status][pending_waiting_time_mode]	string	*	Where to count time spending in pending status. Check PENDING_WAITING_TIME_MODE_ constants
data[][ticket][ticket_status][children][]	array of objects (TicketStatus)	*
data[][ticket][ticket_status][options]	array	*
data[][ticket][urgency]	integer	*
data[][ticket][feedback_rating]	integer	*
data[][ticket][date_feedback_rating]	DateTime	*
data[][ticket][date_created]	DateTime	*
data[][ticket][date_resolved]	DateTime	*
data[][ticket][date_archived]	DateTime	*
data[][ticket][date_first_agent_assign]	DateTime	*
data[][ticket][date_first_agent_reply]	DateTime	*
data[][ticket][date_last_agent_reply]	DateTime	*
data[][ticket][date_last_user_reply]	DateTime	*
data[][ticket][date_agent_waiting]	DateTime	*
data[][ticket][date_user_waiting]	DateTime	*
data[][ticket][date_status]	DateTime	*
data[][ticket][date_on_hold]	DateTime	*
data[][ticket][total_user_waiting]	integer	*
data[][ticket][total_to_first_reply]	integer	*
data[][ticket][total_user_waiting_wh_start]	DateTime	*
data[][ticket][total_user_waiting_wh]	integer	*
data[][ticket][total_to_first_reply_wh]	integer	*
data[][ticket][locked_by_agent]	object (Person)	*
data[][ticket][date_locked]	DateTime	*
data[][ticket][has_attachments]	boolean	*
data[][ticket][subject]	string	*
data[][ticket][original_subject]	string	*
data[][ticket][properties]	array	*
data[][ticket][count_agent_replies]	integer	*
data[][ticket][count_user_replies]	integer	*
data[][ticket][worst_sla_status]	string	*
data[][ticket][waiting_times]	array	*	Used to track ticket status changes and how much time ticket was in status Add new item every time status changed This is optimisation over TicketLog.
data[][ticket][participants][]	array of objects (TicketParticipant)	*
data[][ticket][participants][][id]	integer	*
data[][ticket][participants][][ticket]	object (Ticket)	*
data[][ticket][participants][][person]	object (Person)	*
data[][ticket][participants][][access_code]	object (TicketAccessCode)	*
data[][ticket][participants][][person_email]	object (PersonEmail)	*
data[][ticket][participants][][default_on]	boolean	*	Default checkbox status of the user.
data[][ticket][charges][]	array of objects (TicketCharge)	*
data[][ticket][charges][][id]	integer	*
data[][ticket][charges][][charge_time]	integer	*
data[][ticket][charges][][amount]	float	*
data[][ticket][charges][][date_created]	DateTime	*
data[][ticket][charges][][ticket]	object (Ticket)	*
data[][ticket][charges][][person]	object (Person)	*
data[][ticket][charges][][organization]	object (Organization)	*
data[][ticket][charges][][agent]	object (Person)	*
data[][ticket][charges][][custom_data][]	array of objects (CustomDataBilling)	*
data[][ticket][charges][][custom_data][][ticket_charge]	object (TicketCharge)	*
data[][ticket][charges][][custom_data][][field]	object (CustomDefBilling)	*
data[][ticket][charges][][custom_data][][field][parent]	object (CustomDefBilling)	*
data[][ticket][charges][][custom_data][][field][children][]	array of objects (CustomDefBilling)	*	Field children.
data[][ticket][charges][][custom_data][][root_field]	object (CustomDefBilling)	*
data[][ticket][ticket_slas][]	array of objects (TicketSla)	*
data[][ticket][ticket_slas][][id]	integer	*	The unique ID.
data[][ticket][ticket_slas][][sla_status]	string	*	The SLA status.
data[][ticket][ticket_slas][][warn_date]	DateTime	*	The SLA warn date.
data[][ticket][ticket_slas][][fail_date]	DateTime	*	The SLA fail date.
data[][ticket][ticket_slas][][is_completed]	boolean	*	Is the SLA completed?
data[][ticket][ticket_slas][][is_completed_set]	boolean	*	Completed by automated action.
data[][ticket][ticket_slas][][completed_time_taken]	integer	*	Time taken.
data[][ticket][ticket_slas][][ticket]	integer id (Ticket)	*	Ticket.
data[][ticket][ticket_slas][][sla]	integer id (Sla)	*	SLA.
data[][ticket][ticket_slas][][date_applied]	DateTime	*	time and date when SLA was applied to the ticket.
data[][ticket][ticket_slas][][date_completed]	DateTime	*	time when SLA status became OK.
data[][ticket][jira_issues][]	array of objects (JiraIssue)	*	linked jira issues.
data[][ticket][jira_issues][][id]	integer	*	The unique ID.
data[][ticket][jira_issues][][ticket]	object (Ticket)	*	The associated DeskPRO ticket.
data[][ticket][jira_issues][][issue_id]	integer	*
data[][ticket][jira_issues][][status_id]	integer	*
data[][ticket][jira_issues][][created]	DateTime	*	Export time.
data[][ticket][problems][]	array of objects (Problem)	*
data[][ticket][problems][][id]	integer	*	The unique ID.
data[][ticket][problems][][title]	string	*	Problem title.
data[][ticket][problems][][creator]	integer id (Person)	*	Person who created the problem.
data[][ticket][problems][][created]	DateTime	*	Date when the problem was created.
data[][ticket][problems][][is_open]	boolean	*	Is problem still has no solution?
data[][ticket][problems][][tickets][]	array of integer ids (Ticket)	*	Tickets associated with problem.
data[][ticket][stars][]	array of objects (TicketFlagged)	*
data[][ticket][stars][][ticket]	object (Ticket)	*
data[][ticket][stars][][person_id]	integer	*
data[][ticket][stars][][color]	string	*
data[][ticket][follow_ups][]	array of objects (TicketFollowUp)	*
data[][ticket][follow_ups][][id]	integer	*	The unique ID.
data[][ticket][follow_ups][][person]	integer id (Person)	*
data[][ticket][follow_ups][][actions]	array	*
data[][ticket][follow_ups][][cancel_if_user_reply]	boolean	*
data[][ticket][follow_ups][][cancel_if_agent_reply]	boolean	*
data[][ticket][follow_ups][][status]	string	*
data[][ticket][follow_ups][][date_created]	DateTime	*
data[][ticket][follow_ups][][date_to_run]	DateTime	*
data[][ticket][follow_ups][][date_did_run]	DateTime	*
data[][ticket][logs][]	array of objects (TicketLog)	*
data[][ticket][logs][][id]	integer	*
data[][ticket][logs][][parent]	object (TicketLog)	*
data[][ticket][logs][][ticket]	object (Ticket)	*
data[][ticket][logs][][person]	object (Person)	*
data[][ticket][logs][][action_type]	string	*
data[][ticket][logs][][id_object]	integer	*	If the log involves a specific thing in a ticket (eg a message that was moved), then that is this id.
data[][ticket][logs][][id_before]	integer	*	The ID of the previous entity changed, or any other numeric value.
data[][ticket][logs][][id_after]	integer	*	The ID of the new entity, or any other numeric value.
data[][ticket][logs][][trigger_id]	integer	*	If the change was caused by a trigger, the trigger id. Note this is the integer ID (not a FK relation) so the record is kept even if the trigger itself is deleted.
data[][ticket][logs][][escalation_id]	integer	*	If the change was caused by an escalation Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data[][ticket][logs][][macro_id]	integer	*	If the change was caused by an v2 macro Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data[][ticket][logs][][sla]	object (Sla)	*	If the change was caused by an SLA, the SLA.
data[][ticket][logs][][sla][id]	integer	*	The unique ID.
data[][ticket][logs][][sla][title]	string	*	SLA title.
data[][ticket][logs][][sla][sla_type]	string	*	Type of SLA - first_response, resolution, waiting_time.
data[][ticket][logs][][sla][active_time]	string	*	Whether active all the time (all) or during work hours only (work_hours) or use the default ticket-wide settings (default).
data[][ticket][logs][][sla][work_start]	integer	*	When the work day starts. This is stored as the number of seconds after 00:00:00.
data[][ticket][logs][][sla][work_end]	integer	*	When the work day ends. This is stored as the number of seconds after 00:00:00.
data[][ticket][logs][][sla][work_days]	array	*	Array of work days, stored with keys corresponding to day numbers. Values are true. 0 = Sunday, 6 = Saturday (same as PHP, easy to convert to MySQL which is 1 = Sunday, 7 = Saturday).
data[][ticket][logs][][sla][work_timezone]	string	*	Timezone for work hours/days to be considered in.
data[][ticket][logs][][sla][work_holidays]	array	*	List of work holidays.
data[][ticket][logs][][sla][apply_type]	string	*	Controls how the SLA is applied to tickets: all, terms, terms_before_triggers, manual.
data[][ticket][logs][][sla][apply_terms]	object (TriggerTerms)	*	Conditions to apply.
data[][ticket][logs][][sla][apply_terms][version]	integer	*	Terms version.
data[][ticket][logs][][sla][apply_terms][terms]	array	*	Terms themselves.
data[][ticket][logs][][sla][trigger_terms]	object (TriggerTerms)	*	Conditions to consider sla completed.
data[][ticket][logs][][sla][warn_time]	integer	*	Warn time integer.
data[][ticket][logs][][sla][warn_time_unit]	string	*	And it's unit (see warn time).
data[][ticket][logs][][sla][warn_actions]	object (TriggerActions)	*	How to warn about SLA will fail.
data[][ticket][logs][][sla][warn_actions][version]	integer	*	Actions version.
data[][ticket][logs][][sla][warn_actions][actions]	array	*	Actions array representation.
data[][ticket][logs][][sla][fail_time]	integer	*	Fail time integer.
data[][ticket][logs][][sla][fail_time_unit]	string	*	And it's measuring unit (see fail_time).
data[][ticket][logs][][sla][fail_actions]	object (TriggerActions)	*	What to do if SLA failed.
data[][ticket][logs][][sla][exclude_ticket_statuses]	array	*	This SLA will not apply while tickets are in these pending statuses.
data[][ticket][logs][][sla_status]	string	*
data[][ticket][logs][][details]	array	*
data[][ticket][logs][][date_created]	DateTime	*
data[][ticket][chats][]	array of objects (ChatConversation)	*
data[][ticket][created_with_channel]	string	*
data[][ticket][last_channel_used]	string	*
data[][ticket][channels]	array	*
data[][ticket][pending_articles][]	array of objects (ArticlePendingCreate)	*
data[][ticket][pending_articles][][id]	integer	*
data[][ticket][pending_articles][][person]	integer id (Person)	*
data[][ticket][pending_articles][][assigned_person]	integer id (Person)	*
data[][ticket][pending_articles][][ticket]	integer id (Ticket)	*
data[][ticket][pending_articles][][message]	integer id (TicketMessage)	*
data[][ticket][pending_articles][][comment]	string	*
data[][ticket][pending_articles][][date_created]	DateTime	*
data[][ticket][summary]	object (TicketSummary)	*
data[][ticket][summary][id]	integer	*
data[][ticket][summary][ticket]	object (Ticket)	*
data[][ticket][summary][summary]	string	*
data[][ticket][summary][summary_input]	string	*
data[][ticket][summary][date_created]	DateTime	*
data[][person]	object (Person)	*	Person this message was sent by.
data[][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data[][email_source][id]	integer	*
data[][email_source][uuid]	string	*
data[][email_source][blob]	object (Blob)	*
data[][email_source][blob][sys_name]	string	*	A unique system name for the blob.
data[][email_source][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][email_source][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][email_source][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][email_source][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][email_source][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][email_source][blob][file_url]	string	*	The HTTP link to download the file.
data[][email_source][blob][authcode]	string	*
data[][email_source][blob][blob_hash]	string	*
data[][email_source][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][email_source][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][email_source][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][email_source][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][email_source][blob][date_created]	DateTime	*
data[][email_source][blob][is_temp]	boolean	*
data[][email_source][blob][source_ref]	string	*
data[][email_source][blob][labels][]	array of objects (LabelBlob)	*
data[][email_source][blob][labels][][blob]	object (Blob)	*
data[][email_source][object_type]	string	*	The type of object this is attached to (should be the table name of the super type, eg: tickets, people, organizations). This typically is not set until after the email is processed (ie the status is 'processed').
data[][email_source][object_id]	integer	*	The ID of the object this is attached to.
data[][email_source][from_email]	string	*
data[][email_source][status]	string	*	The current status of the message: - inserted: Only inserted - processing: Currently processing - complete: Fully processed - error: Tried to process but there was some kind of error (see error_code).
data[][email_source][date_status]	DateTime	*
data[][email_source][error_code]	string	*	When status is error, this is the code that describes the error.
data[][email_source][date_created]	DateTime	*
data[][date_created]	DateTime	*	Date when message was created.
data[][is_agent_note]	boolean	*	Is this message agent note?
data[][is_hidden]	boolean	*	Is this message hidden?
data[][creation_system]	string	*	How this message was created.
data[][ip_address]	string	*	An ip address from which message was sent.
data[][visitor_id]	string	*	Unique ID of visitor left this message.
data[][hostname]	string	*	Host from which message was left.
data[][geo_country]	string	*	Country message is from (deprecated).
data[][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data[][message_hash]	string	*	An unique hash of message.
data[][message]	string	*	The message, will be in HTML!
data[][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data[][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data[][message_source]	string	*	The message source.
data[][message_source_type]	string	*	The message source type.
data[][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data[][lang_code]	string	*	The set/detected lang code.
data[][email_message_id][]	array of objects (TicketMessageEmailId)	*
data[][email_message_id][][id]	integer	*
data[][email_message_id][][message]	object (TicketMessage)	*
data[][email_message_id][][message][id]	integer	*	The unique id of message.
data[][email_message_id][][message][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data[][email_message_id][][message][person]	object (Person)	*	Person this message was sent by.
data[][email_message_id][][message][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data[][email_message_id][][message][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data[][email_message_id][][message][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data[][email_message_id][][message][date_created]	DateTime	*	Date when message was created.
data[][email_message_id][][message][is_agent_note]	boolean	*	Is this message agent note?
data[][email_message_id][][message][is_hidden]	boolean	*	Is this message hidden?
data[][email_message_id][][message][creation_system]	string	*	How this message was created.
data[][email_message_id][][message][ip_address]	string	*	An ip address from which message was sent.
data[][email_message_id][][message][visitor_id]	string	*	Unique ID of visitor left this message.
data[][email_message_id][][message][hostname]	string	*	Host from which message was left.
data[][email_message_id][][message][geo_country]	string	*	Country message is from (deprecated).
data[][email_message_id][][message][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data[][email_message_id][][message][message_hash]	string	*	An unique hash of message.
data[][email_message_id][][message][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data[][email_message_id][][message][message]	string	*	The message, will be in HTML!
data[][email_message_id][][message][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data[][email_message_id][][message][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data[][email_message_id][][message][message_source]	string	*	The message source.
data[][email_message_id][][message][message_source_type]	string	*	The message source type.
data[][email_message_id][][message][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data[][email_message_id][][message][lang_code]	string	*	The set/detected lang code.
data[][email_message_id][][message][email_message_id][]	array of objects (TicketMessageEmailId)	*
data[][email_message_id][][message][ticket_feedback][]	array of objects (TicketFeedback)	*
data[][email_message_id][][message][ticket_feedback][][id]	integer	*
data[][email_message_id][][message][ticket_feedback][][ticket]	object (Ticket)	*
data[][email_message_id][][message][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data[][email_message_id][][message][ticket_feedback][][person]	object (Person)	*
data[][email_message_id][][message][ticket_feedback][][rating]	integer	*
data[][email_message_id][][message][ticket_feedback][][message]	string	*
data[][email_message_id][][message][ticket_feedback][][date_created]	DateTime	*
data[][email_message_id][][message][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data[][email_message_id][][message][ticket_message_forwards][][id]	integer	*
data[][email_message_id][][message][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data[][email_message_id][][message][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data[][email_message_id][][message][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data[][email_message_id][][message][ticket_message_forwards][][subject]	string	*
data[][email_message_id][][message][ticket_message_forwards][][from_email]	string	*
data[][email_message_id][][message][ticket_message_forwards][][tos]	array	*
data[][email_message_id][][message][ticket_message_forwards][][ccs]	array	*
data[][email_message_id][][message][ticket_message_forwards][][bccs]	array	*
data[][email_message_id][][message][ticket_message_forwards][][message]	string	*
data[][email_message_id][][message][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data[][email_message_id][][message][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data[][email_message_id][][message][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][email_message_id][][message][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][email_message_id][][message][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][email_message_id][][message][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][email_message_id][][message][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data[][email_message_id][][message][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data[][email_message_id][][message][ticket_message_forwards][][blobs][][authcode]	string	*
data[][email_message_id][][message][ticket_message_forwards][][blobs][][blob_hash]	string	*
data[][email_message_id][][message][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][email_message_id][][message][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][email_message_id][][message][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][email_message_id][][message][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][email_message_id][][message][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data[][email_message_id][][message][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data[][email_message_id][][message][ticket_message_forwards][][blobs][][source_ref]	string	*
data[][email_message_id][][message][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data[][email_message_id][][message][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data[][email_message_id][][message][ticket_message_forwards][][date_created]	DateTime	*
data[][email_message_id][][message][channel_message]	object (TicketMessageChannelMessage)	*
data[][email_message_id][][message][channel_message][id]	integer	*	@var int The unique id of message.
data[][email_message_id][][message][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data[][email_message_id][][message][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data[][email_message_id][][message][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data[][email_message_id][][message][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data[][email_message_id][][message][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data[][email_message_id][][message][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data[][email_message_id][][message][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data[][email_message_id][][message][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data[][email_message_id][][message][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data[][email_message_id][][email_id]	string	*
data[][ticket_feedback][]	array of objects (TicketFeedback)	*
data[][ticket_feedback][][id]	integer	*
data[][ticket_feedback][][ticket]	object (Ticket)	*
data[][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data[][ticket_feedback][][ticket_message][id]	integer	*	The unique id of message.
data[][ticket_feedback][][ticket_message][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data[][ticket_feedback][][ticket_message][person]	object (Person)	*	Person this message was sent by.
data[][ticket_feedback][][ticket_message][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data[][ticket_feedback][][ticket_message][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data[][ticket_feedback][][ticket_message][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data[][ticket_feedback][][ticket_message][date_created]	DateTime	*	Date when message was created.
data[][ticket_feedback][][ticket_message][is_agent_note]	boolean	*	Is this message agent note?
data[][ticket_feedback][][ticket_message][is_hidden]	boolean	*	Is this message hidden?
data[][ticket_feedback][][ticket_message][creation_system]	string	*	How this message was created.
data[][ticket_feedback][][ticket_message][ip_address]	string	*	An ip address from which message was sent.
data[][ticket_feedback][][ticket_message][visitor_id]	string	*	Unique ID of visitor left this message.
data[][ticket_feedback][][ticket_message][hostname]	string	*	Host from which message was left.
data[][ticket_feedback][][ticket_message][geo_country]	string	*	Country message is from (deprecated).
data[][ticket_feedback][][ticket_message][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data[][ticket_feedback][][ticket_message][message_hash]	string	*	An unique hash of message.
data[][ticket_feedback][][ticket_message][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data[][ticket_feedback][][ticket_message][message]	string	*	The message, will be in HTML!
data[][ticket_feedback][][ticket_message][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data[][ticket_feedback][][ticket_message][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data[][ticket_feedback][][ticket_message][message_source]	string	*	The message source.
data[][ticket_feedback][][ticket_message][message_source_type]	string	*	The message source type.
data[][ticket_feedback][][ticket_message][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data[][ticket_feedback][][ticket_message][lang_code]	string	*	The set/detected lang code.
data[][ticket_feedback][][ticket_message][email_message_id][]	array of objects (TicketMessageEmailId)	*
data[][ticket_feedback][][ticket_message][ticket_feedback][]	array of objects (TicketFeedback)	*
data[][ticket_feedback][][ticket_message][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][id]	integer	*
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][subject]	string	*
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][from_email]	string	*
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][tos]	array	*
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][ccs]	array	*
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][bccs]	array	*
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][message]	string	*
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][blobs][][authcode]	string	*
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][blobs][][blob_hash]	string	*
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][blobs][][source_ref]	string	*
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data[][ticket_feedback][][ticket_message][ticket_message_forwards][][date_created]	DateTime	*
data[][ticket_feedback][][ticket_message][channel_message]	object (TicketMessageChannelMessage)	*
data[][ticket_feedback][][ticket_message][channel_message][id]	integer	*	@var int The unique id of message.
data[][ticket_feedback][][ticket_message][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data[][ticket_feedback][][ticket_message][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data[][ticket_feedback][][ticket_message][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data[][ticket_feedback][][ticket_message][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data[][ticket_feedback][][ticket_message][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data[][ticket_feedback][][ticket_message][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data[][ticket_feedback][][ticket_message][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data[][ticket_feedback][][ticket_message][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data[][ticket_feedback][][ticket_message][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data[][ticket_feedback][][person]	object (Person)	*
data[][ticket_feedback][][rating]	integer	*
data[][ticket_feedback][][message]	string	*
data[][ticket_feedback][][date_created]	DateTime	*
data[][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data[][ticket_message_forwards][][id]	integer	*
data[][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data[][ticket_message_forwards][][ticket_message][id]	integer	*	The unique id of message.
data[][ticket_message_forwards][][ticket_message][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data[][ticket_message_forwards][][ticket_message][person]	object (Person)	*	Person this message was sent by.
data[][ticket_message_forwards][][ticket_message][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data[][ticket_message_forwards][][ticket_message][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data[][ticket_message_forwards][][ticket_message][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data[][ticket_message_forwards][][ticket_message][date_created]	DateTime	*	Date when message was created.
data[][ticket_message_forwards][][ticket_message][is_agent_note]	boolean	*	Is this message agent note?
data[][ticket_message_forwards][][ticket_message][is_hidden]	boolean	*	Is this message hidden?
data[][ticket_message_forwards][][ticket_message][creation_system]	string	*	How this message was created.
data[][ticket_message_forwards][][ticket_message][ip_address]	string	*	An ip address from which message was sent.
data[][ticket_message_forwards][][ticket_message][visitor_id]	string	*	Unique ID of visitor left this message.
data[][ticket_message_forwards][][ticket_message][hostname]	string	*	Host from which message was left.
data[][ticket_message_forwards][][ticket_message][geo_country]	string	*	Country message is from (deprecated).
data[][ticket_message_forwards][][ticket_message][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data[][ticket_message_forwards][][ticket_message][message_hash]	string	*	An unique hash of message.
data[][ticket_message_forwards][][ticket_message][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data[][ticket_message_forwards][][ticket_message][message]	string	*	The message, will be in HTML!
data[][ticket_message_forwards][][ticket_message][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data[][ticket_message_forwards][][ticket_message][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data[][ticket_message_forwards][][ticket_message][message_source]	string	*	The message source.
data[][ticket_message_forwards][][ticket_message][message_source_type]	string	*	The message source type.
data[][ticket_message_forwards][][ticket_message][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data[][ticket_message_forwards][][ticket_message][lang_code]	string	*	The set/detected lang code.
data[][ticket_message_forwards][][ticket_message][email_message_id][]	array of objects (TicketMessageEmailId)	*
data[][ticket_message_forwards][][ticket_message][ticket_feedback][]	array of objects (TicketFeedback)	*
data[][ticket_message_forwards][][ticket_message][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data[][ticket_message_forwards][][ticket_message][channel_message]	object (TicketMessageChannelMessage)	*
data[][ticket_message_forwards][][ticket_message][channel_message][id]	integer	*	@var int The unique id of message.
data[][ticket_message_forwards][][ticket_message][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data[][ticket_message_forwards][][ticket_message][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data[][ticket_message_forwards][][ticket_message][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data[][ticket_message_forwards][][ticket_message][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data[][ticket_message_forwards][][ticket_message][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data[][ticket_message_forwards][][ticket_message][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data[][ticket_message_forwards][][ticket_message][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data[][ticket_message_forwards][][ticket_message][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data[][ticket_message_forwards][][ticket_message][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data[][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data[][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data[][ticket_message_forwards][][subject]	string	*
data[][ticket_message_forwards][][from_email]	string	*
data[][ticket_message_forwards][][tos]	array	*
data[][ticket_message_forwards][][ccs]	array	*
data[][ticket_message_forwards][][bccs]	array	*
data[][ticket_message_forwards][][message]	string	*
data[][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data[][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data[][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data[][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data[][ticket_message_forwards][][blobs][][authcode]	string	*
data[][ticket_message_forwards][][blobs][][blob_hash]	string	*
data[][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data[][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data[][ticket_message_forwards][][blobs][][source_ref]	string	*
data[][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data[][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data[][ticket_message_forwards][][date_created]	DateTime	*
data[][channel_message]	object (TicketMessageChannelMessage)	*
data[][channel_message][id]	integer	*	@var int The unique id of message.
data[][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data[][channel_message][ticket_message][id]	integer	*	The unique id of message.
data[][channel_message][ticket_message][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data[][channel_message][ticket_message][person]	object (Person)	*	Person this message was sent by.
data[][channel_message][ticket_message][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data[][channel_message][ticket_message][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data[][channel_message][ticket_message][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data[][channel_message][ticket_message][date_created]	DateTime	*	Date when message was created.
data[][channel_message][ticket_message][is_agent_note]	boolean	*	Is this message agent note?
data[][channel_message][ticket_message][is_hidden]	boolean	*	Is this message hidden?
data[][channel_message][ticket_message][creation_system]	string	*	How this message was created.
data[][channel_message][ticket_message][ip_address]	string	*	An ip address from which message was sent.
data[][channel_message][ticket_message][visitor_id]	string	*	Unique ID of visitor left this message.
data[][channel_message][ticket_message][hostname]	string	*	Host from which message was left.
data[][channel_message][ticket_message][geo_country]	string	*	Country message is from (deprecated).
data[][channel_message][ticket_message][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data[][channel_message][ticket_message][message_hash]	string	*	An unique hash of message.
data[][channel_message][ticket_message][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data[][channel_message][ticket_message][message]	string	*	The message, will be in HTML!
data[][channel_message][ticket_message][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data[][channel_message][ticket_message][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data[][channel_message][ticket_message][message_source]	string	*	The message source.
data[][channel_message][ticket_message][message_source_type]	string	*	The message source type.
data[][channel_message][ticket_message][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data[][channel_message][ticket_message][lang_code]	string	*	The set/detected lang code.
data[][channel_message][ticket_message][email_message_id][]	array of objects (TicketMessageEmailId)	*
data[][channel_message][ticket_message][ticket_feedback][]	array of objects (TicketFeedback)	*
data[][channel_message][ticket_message][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data[][channel_message][ticket_message][channel_message]	object (TicketMessageChannelMessage)	*
data[][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data[][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data[][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data[][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data[][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data[][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data[][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data[][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/tickets/{parentId}/messages CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_messages.post

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Required?	Format	Description
message	string	true		Message
format	choice	true	["html","text"]
message_source_type	string	false
message_source	string	false
is_note	boolean	true
date_created	datetime	false	yyyy-MM-dd'T'HH:mm:ss

Parameter	Type	Versions	Description
data.attachments[]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.attachments[][id]	integer	*	The unique ID.
data.attachments[][ticket]	integer id (Ticket)	*	Ticket this attachment belongs to.
data.attachments[][person]	integer id (Person)	*	Who created the attachment.
data.attachments[][blob]	object (Blob)	*	Actual attachment.
data.attachments[][blob][sys_name]	string	*	A unique system name for the blob.
data.attachments[][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.attachments[][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.attachments[][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.attachments[][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.attachments[][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.attachments[][blob][file_url]	string	*	The HTTP link to download the file.
data.attachments[][blob][authcode]	string	*
data.attachments[][blob][blob_hash]	string	*
data.attachments[][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.attachments[][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.attachments[][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.attachments[][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.attachments[][blob][date_created]	DateTime	*
data.attachments[][blob][is_temp]	boolean	*
data.attachments[][blob][source_ref]	string	*
data.attachments[][blob][labels][]	array of objects (LabelBlob)	*
data.attachments[][blob][labels][][blob]	object (Blob)	*
data.attachments[][message]	integer id (TicketMessage)	*	Message - holder of this attachment.
data.attachments[][is_agent_note]	boolean	*	True if this attachmen just a note.
data.attachments[][is_inline]	boolean	*	Is this attachment is embed in message.
data.snippet_use_logs[]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.snippet_use_logs[][id]	integer	*	The unique ID.
data.snippet_use_logs[][snippet]	object (SnippetV2)	*	Snippet used.
data.snippet_use_logs[][snippet][id]	integer	*
data.snippet_use_logs[][snippet][title]	string	*
data.snippet_use_logs[][snippet][author]	object (Person)	*
data.snippet_use_logs[][snippet][is_private]	boolean	*
data.snippet_use_logs[][snippet][avatar]	object (Blob)	*
data.snippet_use_logs[][snippet][avatar][sys_name]	string	*	A unique system name for the blob.
data.snippet_use_logs[][snippet][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.snippet_use_logs[][snippet][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.snippet_use_logs[][snippet][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.snippet_use_logs[][snippet][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.snippet_use_logs[][snippet][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.snippet_use_logs[][snippet][avatar][file_url]	string	*	The HTTP link to download the file.
data.snippet_use_logs[][snippet][avatar][authcode]	string	*
data.snippet_use_logs[][snippet][avatar][blob_hash]	string	*
data.snippet_use_logs[][snippet][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.snippet_use_logs[][snippet][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.snippet_use_logs[][snippet][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.snippet_use_logs[][snippet][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.snippet_use_logs[][snippet][avatar][date_created]	DateTime	*
data.snippet_use_logs[][snippet][avatar][is_temp]	boolean	*
data.snippet_use_logs[][snippet][avatar][source_ref]	string	*
data.snippet_use_logs[][snippet][avatar][labels][]	array of objects (LabelBlob)	*
data.snippet_use_logs[][snippet][avatar][labels][][blob]	object (Blob)	*
data.snippet_use_logs[][snippet][status]	string	*
data.snippet_use_logs[][snippet][shortcut_codes]	array	*
data.snippet_use_logs[][snippet][inline_translations]	array	*
data.snippet_use_logs[][snippet][translations][]	array of objects (SnippetV2Translation)	*
data.snippet_use_logs[][snippet][translations][][id]	integer	*	The unique ID.
data.snippet_use_logs[][snippet][translations][][snippet]	object (SnippetV2)	*	Snippet translated.
data.snippet_use_logs[][snippet][translations][][language]	object (Language)	*
data.snippet_use_logs[][snippet][translations][][language][id]	integer	*	The unique ID.
data.snippet_use_logs[][snippet][translations][][language][sys_name]	string	*	The unique sys name assigned to the language.
data.snippet_use_logs[][snippet][translations][][language][title]	string	*	Title of the language.
data.snippet_use_logs[][snippet][translations][][language][title_local]	string	*	Title of the language.
data.snippet_use_logs[][snippet][translations][][language][base_filepath]	string	*	The base filepath for default phrases for this lang.
data.snippet_use_logs[][snippet][translations][][language][locale]	string	*	The locale code.
data.snippet_use_logs[][snippet][translations][][language][flag_image]	string	*	String path to image.
data.snippet_use_logs[][snippet][translations][][language][is_rtl]	boolean	*	True if this is a right-to-left language.
data.snippet_use_logs[][snippet][translations][][language][has_user]	boolean	*	True if has user.
data.snippet_use_logs[][snippet][translations][][language][has_agent]	boolean	*	True if has agent.
data.snippet_use_logs[][snippet][translations][][language][has_admin]	boolean	*	True if has admin.
data.snippet_use_logs[][snippet][translations][][language][plural_categories][]	array of strings	*
data.snippet_use_logs[][snippet][translations][][language][plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data.snippet_use_logs[][snippet][translations][][language][flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`
data.snippet_use_logs[][snippet][translations][][content]	array	*	Snippet content.
data.snippet_use_logs[][snippet][translations][][blobs][]	array of objects (Blob)	*
data.snippet_use_logs[][snippet][categories][]	array of objects (SnippetV2Category)	*
data.snippet_use_logs[][snippet][categories][][id]	integer	*
data.snippet_use_logs[][snippet][categories][][title]	string	*
data.snippet_use_logs[][snippet][categories][][is_global]	boolean	*
data.snippet_use_logs[][snippet][categories][][display_order]	integer	*
data.snippet_use_logs[][snippet][categories][][parent]	object (SnippetV2Category)	*
data.snippet_use_logs[][snippet][categories][][agent_teams][]	array of objects (AgentTeam)	*
data.snippet_use_logs[][snippet][categories][][agent_teams][][id]	integer	*	The unique ID.
data.snippet_use_logs[][snippet][categories][][agent_teams][][name]	string	*	The name of agent team.
data.snippet_use_logs[][snippet][categories][][agent_teams][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.snippet_use_logs[][snippet][display_order]	integer	*
data.snippet_use_logs[][snippet][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message]	object (TicketMessage)	*	Ticket Message where the snippet was used.
data.snippet_use_logs[][ticket_message][id]	integer	*	The unique id of message.
data.snippet_use_logs[][ticket_message][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data.snippet_use_logs[][ticket_message][ticket][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][ref]	string	*
data.snippet_use_logs[][ticket_message][ticket][auth]	string	*
data.snippet_use_logs[][ticket_message][ticket][parent_ticket]	object (Ticket)	*	Parent ticket.
data.snippet_use_logs[][ticket_message][ticket][children_tickets][]	array of objects (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][language]	object (Language)	*	The language the ticket is in.
data.snippet_use_logs[][ticket_message][ticket][language][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][language][sys_name]	string	*	The unique sys name assigned to the language.
data.snippet_use_logs[][ticket_message][ticket][language][title]	string	*	Title of the language.
data.snippet_use_logs[][ticket_message][ticket][language][title_local]	string	*	Title of the language.
data.snippet_use_logs[][ticket_message][ticket][language][base_filepath]	string	*	The base filepath for default phrases for this lang.
data.snippet_use_logs[][ticket_message][ticket][language][locale]	string	*	The locale code.
data.snippet_use_logs[][ticket_message][ticket][language][flag_image]	string	*	String path to image.
data.snippet_use_logs[][ticket_message][ticket][language][is_rtl]	boolean	*	True if this is a right-to-left language.
data.snippet_use_logs[][ticket_message][ticket][language][has_user]	boolean	*	True if has user.
data.snippet_use_logs[][ticket_message][ticket][language][has_agent]	boolean	*	True if has agent.
data.snippet_use_logs[][ticket_message][ticket][language][has_admin]	boolean	*	True if has admin.
data.snippet_use_logs[][ticket_message][ticket][language][plural_categories][]	array of strings	*
data.snippet_use_logs[][ticket_message][ticket][language][plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data.snippet_use_logs[][ticket_message][ticket][language][flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`
data.snippet_use_logs[][ticket_message][ticket][brand]	object (Brand)	*
data.snippet_use_logs[][ticket_message][ticket][brand][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][brand][name]	string	*	The brand name.
data.snippet_use_logs[][ticket_message][ticket][brand][slug]	string	*
data.snippet_use_logs[][ticket_message][ticket][brand][url]	string	*	The brand url.
data.snippet_use_logs[][ticket_message][ticket][brand][theme_set]	object (ThemeSet)	*
data.snippet_use_logs[][ticket_message][ticket][brand][theme_set][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][brand][theme_set][theme_id]	string	*
data.snippet_use_logs[][ticket_message][ticket][brand][theme_set][title]	string	*
data.snippet_use_logs[][ticket_message][ticket][brand][edit_theme_set]	object (ThemeSet)	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][]	array of objects (Department)	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][parent]	object (Department)	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][children][]	array of objects (Department)	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][title]	string	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][user_title]	string	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][is_tickets_enabled]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][is_chat_enabled]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][display_order]	integer	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar]	object (Blob)	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][authcode]	string	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][blob_hash]	string	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][is_temp]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][source_ref]	string	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][brands][]	array of objects (Brand)	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][permissions][][department]	integer id (Department)	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][permissions][][name]	string	*	The name of the permission.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][permissions][][is_active]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][chat_queue]	object (UserChatQueue)	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][chat_queue][name]	string	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][chat_queue][routing_model]	string	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][chat_queue][answer_timeout]	integer	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][chat_queue][is_all_agents]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][chat_queue][max_queue_size]	integer	*
data.snippet_use_logs[][ticket_message][ticket][brand][theme_sets][]	array of objects (ThemeSet)	*
data.snippet_use_logs[][ticket_message][ticket][department]	object (Department)	*
data.snippet_use_logs[][ticket_message][ticket][department][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][department][parent]	object (Department)	*
data.snippet_use_logs[][ticket_message][ticket][department][children][]	array of objects (Department)	*
data.snippet_use_logs[][ticket_message][ticket][department][title]	string	*
data.snippet_use_logs[][ticket_message][ticket][department][user_title]	string	*
data.snippet_use_logs[][ticket_message][ticket][department][is_tickets_enabled]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][department][is_chat_enabled]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][department][display_order]	integer	*
data.snippet_use_logs[][ticket_message][ticket][department][avatar]	object (Blob)	*
data.snippet_use_logs[][ticket_message][ticket][department][avatar][sys_name]	string	*	A unique system name for the blob.
data.snippet_use_logs[][ticket_message][ticket][department][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.snippet_use_logs[][ticket_message][ticket][department][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.snippet_use_logs[][ticket_message][ticket][department][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.snippet_use_logs[][ticket_message][ticket][department][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.snippet_use_logs[][ticket_message][ticket][department][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.snippet_use_logs[][ticket_message][ticket][department][avatar][file_url]	string	*	The HTTP link to download the file.
data.snippet_use_logs[][ticket_message][ticket][department][avatar][authcode]	string	*
data.snippet_use_logs[][ticket_message][ticket][department][avatar][blob_hash]	string	*
data.snippet_use_logs[][ticket_message][ticket][department][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.snippet_use_logs[][ticket_message][ticket][department][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.snippet_use_logs[][ticket_message][ticket][department][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.snippet_use_logs[][ticket_message][ticket][department][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.snippet_use_logs[][ticket_message][ticket][department][avatar][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][department][avatar][is_temp]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][department][avatar][source_ref]	string	*
data.snippet_use_logs[][ticket_message][ticket][department][avatar][labels][]	array of objects (LabelBlob)	*
data.snippet_use_logs[][ticket_message][ticket][department][avatar][labels][][blob]	object (Blob)	*
data.snippet_use_logs[][ticket_message][ticket][department][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.snippet_use_logs[][ticket_message][ticket][department][brands][]	array of objects (Brand)	*
data.snippet_use_logs[][ticket_message][ticket][department][permissions][]	array of objects (DepartmentPermission)	*
data.snippet_use_logs[][ticket_message][ticket][department][permissions][][department]	integer id (Department)	*
data.snippet_use_logs[][ticket_message][ticket][department][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.snippet_use_logs[][ticket_message][ticket][department][permissions][][name]	string	*	The name of the permission.
data.snippet_use_logs[][ticket_message][ticket][department][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.snippet_use_logs[][ticket_message][ticket][department][permissions][][is_active]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][department][chat_queue]	object (UserChatQueue)	*
data.snippet_use_logs[][ticket_message][ticket][department][chat_queue][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][department][chat_queue][name]	string	*
data.snippet_use_logs[][ticket_message][ticket][department][chat_queue][routing_model]	string	*
data.snippet_use_logs[][ticket_message][ticket][department][chat_queue][answer_timeout]	integer	*
data.snippet_use_logs[][ticket_message][ticket][department][chat_queue][is_all_agents]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][department][chat_queue][departments][]	array of objects (Department)	*
data.snippet_use_logs[][ticket_message][ticket][department][chat_queue][max_queue_size]	integer	*
data.snippet_use_logs[][ticket_message][ticket][category]	object (TicketCategory)	*
data.snippet_use_logs[][ticket_message][ticket][category][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][category][parent]	integer id (TicketCategory)	*	This category parent.
data.snippet_use_logs[][ticket_message][ticket][category][title]	string	*	Category title.
data.snippet_use_logs[][ticket_message][ticket][category][display_order]	integer	*	Obviously it's display order for lists.
data.snippet_use_logs[][ticket_message][ticket][priority]	object (TicketPriority)	*
data.snippet_use_logs[][ticket_message][ticket][priority][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][priority][title]	string	*	Priority title.
data.snippet_use_logs[][ticket_message][ticket][priority][priority]	integer	*	The priority itself.
data.snippet_use_logs[][ticket_message][ticket][workflow]	object (TicketWorkflow)	*
data.snippet_use_logs[][ticket_message][ticket][workflow][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][workflow][title]	string	*	Workflow title.
data.snippet_use_logs[][ticket_message][ticket][workflow][display_order]	integer	*	Workflow display order.
data.snippet_use_logs[][ticket_message][ticket][product]	object (Product)	*
data.snippet_use_logs[][ticket_message][ticket][product][parent]	integer id (Product)	*	Parent of the product.
data.snippet_use_logs[][ticket_message][ticket][person]	object (Person)	*
data.snippet_use_logs[][ticket_message][ticket][person_email]	object (PersonEmail)	*
data.snippet_use_logs[][ticket_message][ticket][person_email][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][person_email][person]	integer id (Person)	*	Person owner of email.
data.snippet_use_logs[][ticket_message][ticket][person_email][email]	string	*	The email address.
data.snippet_use_logs[][ticket_message][ticket][person_email][email_domain]	string	*	The email address domain.
data.snippet_use_logs[][ticket_message][ticket][person_email][is_validated]	boolean	*	True if validation passed.
data.snippet_use_logs[][ticket_message][ticket][person_email][date_created]	DateTime	*	The original time the email was created.
data.snippet_use_logs[][ticket_message][ticket][agent]	object (Person)	*
data.snippet_use_logs[][ticket_message][ticket][agent_team]	object (AgentTeam)	*
data.snippet_use_logs[][ticket_message][ticket][agent_team][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][agent_team][name]	string	*	The name of agent team.
data.snippet_use_logs[][ticket_message][ticket][agent_team][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.snippet_use_logs[][ticket_message][ticket][organization]	object (Organization)	*
data.snippet_use_logs[][ticket_message][ticket][organization][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob]	object (Blob)	*	The org picture.
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][sys_name]	string	*	A unique system name for the blob.
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][file_url]	string	*	The HTTP link to download the file.
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][authcode]	string	*
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][blob_hash]	string	*
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][is_temp]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][source_ref]	string	*
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][labels][]	array of objects (LabelBlob)	*
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][labels][][blob]	object (Blob)	*
data.snippet_use_logs[][ticket_message][ticket][organization][icon_property]	object (IconProperty)	*
data.snippet_use_logs[][ticket_message][ticket][organization][icon_property][urn]	string	*
data.snippet_use_logs[][ticket_message][ticket][organization][icon_property][options]	array	*
data.snippet_use_logs[][ticket_message][ticket][organization][name]	string	*	The organization name.
data.snippet_use_logs[][ticket_message][ticket][organization][summary]	string	*	The summary field as filled in by agents.
data.snippet_use_logs[][ticket_message][ticket][organization][importance]	integer	*	The org importance.
data.snippet_use_logs[][ticket_message][ticket][organization][custom_data][]	array of objects (CustomDataOrganization)	*
data.snippet_use_logs[][ticket_message][ticket][organization][custom_data][][organization]	object (Organization)	*
data.snippet_use_logs[][ticket_message][ticket][organization][custom_data][][field]	object (CustomDefOrganization)	*
data.snippet_use_logs[][ticket_message][ticket][organization][custom_data][][field][parent]	object (CustomDefOrganization)	*	Field`s parent.
data.snippet_use_logs[][ticket_message][ticket][organization][custom_data][][field][children][]	array of objects (CustomDefOrganization)	*	Field children.
data.snippet_use_logs[][ticket_message][ticket][organization][custom_data][][root_field]	object (CustomDefOrganization)	*
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][]	array of objects (Usergroup)	*	Usergroups the user belongs to.
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][id]	integer	*	The unique ID, DB-generated.
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][title]	string	*	Title of the usergroup.
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][note]	string	*	A note or description about the usergroup.
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][permissions][][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][permissions][][name]	string	*	The name of the permission.
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][department_permissions][][department]	integer id (Department)	*
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][department_permissions][][is_active]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.snippet_use_logs[][ticket_message][ticket][organization][auto_cc_people][]	array of objects (Person)	*	Users who are set to automatically be added to tickets and other org things.
data.snippet_use_logs[][ticket_message][ticket][organization][labels][]	array of objects (LabelOrganization)	*
data.snippet_use_logs[][ticket_message][ticket][organization][labels][][organization]	object (Organization)	*
data.snippet_use_logs[][ticket_message][ticket][organization][contact_data][]	array of objects (OrganizationContactData)	*
data.snippet_use_logs[][ticket_message][ticket][organization][emails][]	array of objects (OrganizationEmail)	*
data.snippet_use_logs[][ticket_message][ticket][organization][emails][][id]	integer	*	The unique log id.
data.snippet_use_logs[][ticket_message][ticket][organization][emails][][organization]	object (Organization)	*
data.snippet_use_logs[][ticket_message][ticket][organization][emails][][email]	string	*
data.snippet_use_logs[][ticket_message][ticket][organization][emails][][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][organization][email_domains][]	array of objects (OrganizationEmailDomain)	*
data.snippet_use_logs[][ticket_message][ticket][organization][email_domains][][domain]	string	*	The email domain.
data.snippet_use_logs[][ticket_message][ticket][organization][email_domains][][organization]	object (Organization)	*	The users organization.
data.snippet_use_logs[][ticket_message][ticket][organization][date_created]	DateTime	*	The date the org was inserted into the system.
data.snippet_use_logs[][ticket_message][ticket][organization][members][]	array of objects (Person)	*
data.snippet_use_logs[][ticket_message][ticket][organization][parent]	object (Organization)	*
data.snippet_use_logs[][ticket_message][ticket][organization][children][]	array of objects (Organization)	*
data.snippet_use_logs[][ticket_message][ticket][organization][tickets][]	array of objects (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][organization][organization_members][]	array of objects (OrganizationMember)	*
data.snippet_use_logs[][ticket_message][ticket][organization][organization_members][][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][organization][organization_members][][person]	integer id (Person)	*
data.snippet_use_logs[][ticket_message][ticket][organization][organization_members][][organization]	integer id (Organization)	*
data.snippet_use_logs[][ticket_message][ticket][organization][organization_members][][is_manager]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][organization][organization_members][][position]	string	*
data.snippet_use_logs[][ticket_message][ticket][organization][organization_members][][created_at]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][organization][organization_members][][updated_at]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat]	object (ChatConversation)	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][id]	integer	*	The unique id of chat conversation.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][department]	object (Department)	*	Department which chat was assigned.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][brand]	object (Brand)	*	Department which chat was assigned.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][task_id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][ticket]	object (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][labels][]	array of objects (LabelChatConversation)	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][labels][][chat]	object (ChatConversation)	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][subject]	string	*	Subject of the chat conversation.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][status]	string	*	Status of the chat conversation.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][agent]	object (Person)	*	If this is a user conversation, this is the agent assigned.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][agent_team]	object (AgentTeam)	*	If this is a team chat, the team it is.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][person]	object (Person)	*	If this is a user conversation, this is the user who started the chat.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session]	object (Session)	*	If this is a user convo, this is the users session.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][auth]	string	*	The authcode for the session to verify an id.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][interface]	string	*	The Interface the session is for.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][person]	object (Person)	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][user_agent]	string	*	The users user agent string.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][visitor_id]	string	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][ip_address]	string	*	The users IP address.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][data]	string	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][is_person]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][is_bot]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][is_helpdesk]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][active_status]	string	*	(Agents) Status (available or away).
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][is_chat_available]	boolean	*	(Agents) Wehn status is available, if they are available for chat.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][date_last]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][date_last_page]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][visitor_id]	string	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][person_name]	string	*	User chat: The users name, if they arent a person.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][person_email]	string	*	User chat: The users email, if they aren`t a person.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][participants][]	array of objects (Person)	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][]	array of objects (ChatMessage)	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][author_id]	integer	*	Author id (legacy).
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][author_type]	string	*	Author type (legacy).
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][conversation_id]	integer	*	Conversation id (legacy).
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][author]	integer id (Person)	*	Person who created the message.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][content]	string	*	The message.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][is_html]	boolean	*	Is the content an HTML message?
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][metadata]	array	*	Additional data.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][date_created]	DateTime	*	Date message was created.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][date_received]	DateTime	*	Date message was received.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][custom_data][]	array of objects (CustomDataChat)	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][custom_data][][conversation]	object (ChatConversation)	*	The conversation the message belongs to.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][custom_data][][field]	object (CustomDefChat)	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][custom_data][][field][parent]	object (CustomDefChat)	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][custom_data][][field][children][]	array of objects (CustomDefChat)	*	Field children.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][custom_data][][root_field]	object (CustomDefChat)	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][rating_response_time]	integer	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][rating_overall]	integer	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][rating_comment]	string	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][is_agent]	boolean	*	Is this an agent chat.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][is_window]	boolean	*	If the chat is popped out into a window. This is used to make sure the JS widget on pages doesn't load again.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][date_created]	DateTime	*	Date when chat was started.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][date_user_waiting]	DateTime	*	Since when the user has started waiting (i.e., time the assignment was 0).
data.snippet_use_logs[][ticket_message][ticket][linked_chat][date_assigned]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][date_agent_typing]	DateTime	*	Date when agent typed last time.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][date_first_agent_message]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][date_ended]	DateTime	*	Date when chat was ended.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][total_to_ended]	integer	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][ended_by]	string	*	Who ended the chat.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][should_send_transcript]	boolean	*	True if transcript should be send.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][date_transcript_sent]	DateTime	*	Date when transcript was sent.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][email_validation_code]	string	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][email_validated]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][access_token]	string	*
data.snippet_use_logs[][ticket_message][ticket][attachments][]	array of objects (TicketAttachment)	*
data.snippet_use_logs[][ticket_message][ticket][access_codes][]	array of objects (TicketAccessCode)	*
data.snippet_use_logs[][ticket_message][ticket][access_codes][][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][access_codes][][ticket]	object (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][access_codes][][person]	object (Person)	*
data.snippet_use_logs[][ticket_message][ticket][access_codes][][auth]	string	*
data.snippet_use_logs[][ticket_message][ticket][messages][]	array of objects (TicketMessage)	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][]	array of objects (TicketSms)	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][ticket]	object (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][person]	object (Person)	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][sms_account]	object (SmsAccount)	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][sms_account][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][sms_account][type]	string	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][sms_account][params]	array	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][sms_account][identifier]	string	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][sms_account][is_enabled]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][sms_account][is_connected]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][sms_account][is_tested]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][sms_account][test_code]	string	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job]	object (Job)	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][id]	integer	*	The unique job id.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][type]	string	*	The job type, used by the Job Router to find the right Job Processor.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][status]	string	*	The status of the job.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][status_code]	string	*	Any code to further classify the status.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][date_touch]	DateTime	*	Date the last time a process "touched" this ticket.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][date_created]	DateTime	*	Date this job entered the "jobs" table.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][date_last_try]	DateTime	*	Last time we processed this job.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][date_next_try]	DateTime	*	If this DateTime is in the future, it won't be selected for execution.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][num_tries]	integer	*	The number of times this job has been executed Job Processor (usually indicated failures if > 1).
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][log_summary]	string	*	A human readable summary of the job's execution.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][log]	string	*	A more verbose log.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][data]	array	*	An array of data, or payload, that the job processor needs to execute this job (stored in the db as json). This MUST always be an array, even if its an empty array
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][original_job]	integer	*	Null unless the job was created as a retry - if so, the originating job ID is stored here so we can query it later. Note: You MUST specify the originating job, do not create a linked list of failed jobs.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][from_number]	string	*	Permanent record of the phone number that sent this SMS. (Won't change even if Person changes their phone number).
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][to_number]	string	*	Permanent record of the phone number that this SMS was sent to.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][message]	string	*	The SMS message.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][direction]	string	*	Just a system flag for reporting.
data.snippet_use_logs[][ticket_message][ticket][topic_links][]	array of objects (TicketCommunityTopicLink)	*
data.snippet_use_logs[][ticket_message][ticket][topic_links][][id]	integer	*	The unique filter ID.
data.snippet_use_logs[][ticket_message][ticket][topic_links][][ticket]	integer id (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][topic_links][][topic]	integer id (CommunityTopic)	*
data.snippet_use_logs[][ticket_message][ticket][topic_links][][person]	integer id (Person)	*
data.snippet_use_logs[][ticket_message][ticket][topic_links][][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][custom_data][]	array of objects (CustomDataTicket)	*
data.snippet_use_logs[][ticket_message][ticket][custom_data][][ticket]	object (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][custom_data][][field]	object (CustomDefTicket)	*
data.snippet_use_logs[][ticket_message][ticket][custom_data][][field][parent]	object (CustomDefTicket)	*
data.snippet_use_logs[][ticket_message][ticket][custom_data][][field][children][]	array of objects (CustomDefTicket)	*	Field children.
data.snippet_use_logs[][ticket_message][ticket][custom_data][][root_field]	object (CustomDefTicket)	*
data.snippet_use_logs[][ticket_message][ticket][labels][]	array of objects (LabelTicket)	*
data.snippet_use_logs[][ticket_message][ticket][labels][][ticket]	object (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][sent_to_address]	string	*	The email address the ticket was sent to if it came in via a gateway. This is a full string (e.g., including CC's) of the original.
data.snippet_use_logs[][ticket_message][ticket][email_account]	object (EmailAccount)	*	The gateway this ticket originated from.
data.snippet_use_logs[][ticket_message][ticket][email_account][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][email_account][account_type]	string	*
data.snippet_use_logs[][ticket_message][ticket][email_account][is_enabled]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][email_account][address]	string	*
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob]	object (Blob)	*
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][sys_name]	string	*	A unique system name for the blob.
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][file_url]	string	*	The HTTP link to download the file.
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][authcode]	string	*
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][blob_hash]	string	*
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][is_temp]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][source_ref]	string	*
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][labels][]	array of objects (LabelBlob)	*
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][labels][][blob]	object (Blob)	*
data.snippet_use_logs[][ticket_message][ticket][email_account][key_blob]	object (Blob)	*
data.snippet_use_logs[][ticket_message][ticket][email_account_address]	string	*	The email address (from list of to/cc) that matched with the email account.
data.snippet_use_logs[][ticket_message][ticket][creation_system]	string	*
data.snippet_use_logs[][ticket_message][ticket][creation_system_option]	string	*	Optional information about the creation system. For example, source URL the ticket came from.
data.snippet_use_logs[][ticket_message][ticket][ticket_hash]	string	*
data.snippet_use_logs[][ticket_message][ticket][status]	string	*
data.snippet_use_logs[][ticket_message][ticket][ticket_status]	object (TicketStatus)	*
data.snippet_use_logs[][ticket_message][ticket][ticket_status][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][ticket_status][status_type]	string	*
data.snippet_use_logs[][ticket_message][ticket][ticket_status][status_code]	string	*
data.snippet_use_logs[][ticket_message][ticket][ticket_status][sys_id]	string	*
data.snippet_use_logs[][ticket_message][ticket][ticket_status][title]	string	*
data.snippet_use_logs[][ticket_message][ticket][ticket_status][display_order]	integer	*
data.snippet_use_logs[][ticket_message][ticket][ticket_status][pending_waiting_time_mode]	string	*	Where to count time spending in pending status. Check PENDING_WAITING_TIME_MODE_ constants
data.snippet_use_logs[][ticket_message][ticket][ticket_status][children][]	array of objects (TicketStatus)	*
data.snippet_use_logs[][ticket_message][ticket][ticket_status][options]	array	*
data.snippet_use_logs[][ticket_message][ticket][urgency]	integer	*
data.snippet_use_logs[][ticket_message][ticket][feedback_rating]	integer	*
data.snippet_use_logs[][ticket_message][ticket][date_feedback_rating]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][date_resolved]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][date_archived]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][date_first_agent_assign]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][date_first_agent_reply]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][date_last_agent_reply]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][date_last_user_reply]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][date_agent_waiting]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][date_user_waiting]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][date_status]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][date_on_hold]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][total_user_waiting]	integer	*
data.snippet_use_logs[][ticket_message][ticket][total_to_first_reply]	integer	*
data.snippet_use_logs[][ticket_message][ticket][total_user_waiting_wh_start]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][total_user_waiting_wh]	integer	*
data.snippet_use_logs[][ticket_message][ticket][total_to_first_reply_wh]	integer	*
data.snippet_use_logs[][ticket_message][ticket][locked_by_agent]	object (Person)	*
data.snippet_use_logs[][ticket_message][ticket][date_locked]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][has_attachments]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][subject]	string	*
data.snippet_use_logs[][ticket_message][ticket][original_subject]	string	*
data.snippet_use_logs[][ticket_message][ticket][properties]	array	*
data.snippet_use_logs[][ticket_message][ticket][count_agent_replies]	integer	*
data.snippet_use_logs[][ticket_message][ticket][count_user_replies]	integer	*
data.snippet_use_logs[][ticket_message][ticket][worst_sla_status]	string	*
data.snippet_use_logs[][ticket_message][ticket][waiting_times]	array	*	Used to track ticket status changes and how much time ticket was in status Add new item every time status changed This is optimisation over TicketLog.
data.snippet_use_logs[][ticket_message][ticket][participants][]	array of objects (TicketParticipant)	*
data.snippet_use_logs[][ticket_message][ticket][participants][][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][participants][][ticket]	object (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][participants][][person]	object (Person)	*
data.snippet_use_logs[][ticket_message][ticket][participants][][access_code]	object (TicketAccessCode)	*
data.snippet_use_logs[][ticket_message][ticket][participants][][person_email]	object (PersonEmail)	*
data.snippet_use_logs[][ticket_message][ticket][participants][][default_on]	boolean	*	Default checkbox status of the user.
data.snippet_use_logs[][ticket_message][ticket][charges][]	array of objects (TicketCharge)	*
data.snippet_use_logs[][ticket_message][ticket][charges][][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][charges][][charge_time]	integer	*
data.snippet_use_logs[][ticket_message][ticket][charges][][amount]	float	*
data.snippet_use_logs[][ticket_message][ticket][charges][][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][charges][][ticket]	object (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][charges][][person]	object (Person)	*
data.snippet_use_logs[][ticket_message][ticket][charges][][organization]	object (Organization)	*
data.snippet_use_logs[][ticket_message][ticket][charges][][agent]	object (Person)	*
data.snippet_use_logs[][ticket_message][ticket][charges][][custom_data][]	array of objects (CustomDataBilling)	*
data.snippet_use_logs[][ticket_message][ticket][charges][][custom_data][][ticket_charge]	object (TicketCharge)	*
data.snippet_use_logs[][ticket_message][ticket][charges][][custom_data][][field]	object (CustomDefBilling)	*
data.snippet_use_logs[][ticket_message][ticket][charges][][custom_data][][field][parent]	object (CustomDefBilling)	*
data.snippet_use_logs[][ticket_message][ticket][charges][][custom_data][][field][children][]	array of objects (CustomDefBilling)	*	Field children.
data.snippet_use_logs[][ticket_message][ticket][charges][][custom_data][][root_field]	object (CustomDefBilling)	*
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][]	array of objects (TicketSla)	*
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][sla_status]	string	*	The SLA status.
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][warn_date]	DateTime	*	The SLA warn date.
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][fail_date]	DateTime	*	The SLA fail date.
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][is_completed]	boolean	*	Is the SLA completed?
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][is_completed_set]	boolean	*	Completed by automated action.
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][completed_time_taken]	integer	*	Time taken.
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][ticket]	integer id (Ticket)	*	Ticket.
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][sla]	integer id (Sla)	*	SLA.
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][date_applied]	DateTime	*	time and date when SLA was applied to the ticket.
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][date_completed]	DateTime	*	time when SLA status became OK.
data.snippet_use_logs[][ticket_message][ticket][jira_issues][]	array of objects (JiraIssue)	*	linked jira issues.
data.snippet_use_logs[][ticket_message][ticket][jira_issues][][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][jira_issues][][ticket]	object (Ticket)	*	The associated DeskPRO ticket.
data.snippet_use_logs[][ticket_message][ticket][jira_issues][][issue_id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][jira_issues][][status_id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][jira_issues][][created]	DateTime	*	Export time.
data.snippet_use_logs[][ticket_message][ticket][problems][]	array of objects (Problem)	*
data.snippet_use_logs[][ticket_message][ticket][problems][][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][problems][][title]	string	*	Problem title.
data.snippet_use_logs[][ticket_message][ticket][problems][][creator]	integer id (Person)	*	Person who created the problem.
data.snippet_use_logs[][ticket_message][ticket][problems][][created]	DateTime	*	Date when the problem was created.
data.snippet_use_logs[][ticket_message][ticket][problems][][is_open]	boolean	*	Is problem still has no solution?
data.snippet_use_logs[][ticket_message][ticket][problems][][tickets][]	array of integer ids (Ticket)	*	Tickets associated with problem.
data.snippet_use_logs[][ticket_message][ticket][stars][]	array of objects (TicketFlagged)	*
data.snippet_use_logs[][ticket_message][ticket][stars][][ticket]	object (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][stars][][person_id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][stars][][color]	string	*
data.snippet_use_logs[][ticket_message][ticket][follow_ups][]	array of objects (TicketFollowUp)	*
data.snippet_use_logs[][ticket_message][ticket][follow_ups][][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][follow_ups][][person]	integer id (Person)	*
data.snippet_use_logs[][ticket_message][ticket][follow_ups][][actions]	array	*
data.snippet_use_logs[][ticket_message][ticket][follow_ups][][cancel_if_user_reply]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][follow_ups][][cancel_if_agent_reply]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][follow_ups][][status]	string	*
data.snippet_use_logs[][ticket_message][ticket][follow_ups][][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][follow_ups][][date_to_run]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][follow_ups][][date_did_run]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][logs][]	array of objects (TicketLog)	*
data.snippet_use_logs[][ticket_message][ticket][logs][][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][logs][][parent]	object (TicketLog)	*
data.snippet_use_logs[][ticket_message][ticket][logs][][ticket]	object (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][logs][][person]	object (Person)	*
data.snippet_use_logs[][ticket_message][ticket][logs][][action_type]	string	*
data.snippet_use_logs[][ticket_message][ticket][logs][][id_object]	integer	*	If the log involves a specific thing in a ticket (eg a message that was moved), then that is this id.
data.snippet_use_logs[][ticket_message][ticket][logs][][id_before]	integer	*	The ID of the previous entity changed, or any other numeric value.
data.snippet_use_logs[][ticket_message][ticket][logs][][id_after]	integer	*	The ID of the new entity, or any other numeric value.
data.snippet_use_logs[][ticket_message][ticket][logs][][trigger_id]	integer	*	If the change was caused by a trigger, the trigger id. Note this is the integer ID (not a FK relation) so the record is kept even if the trigger itself is deleted.
data.snippet_use_logs[][ticket_message][ticket][logs][][escalation_id]	integer	*	If the change was caused by an escalation Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.snippet_use_logs[][ticket_message][ticket][logs][][macro_id]	integer	*	If the change was caused by an v2 macro Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla]	object (Sla)	*	If the change was caused by an SLA, the SLA.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][title]	string	*	SLA title.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][sla_type]	string	*	Type of SLA - first_response, resolution, waiting_time.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][active_time]	string	*	Whether active all the time (all) or during work hours only (work_hours) or use the default ticket-wide settings (default).
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][work_start]	integer	*	When the work day starts. This is stored as the number of seconds after 00:00:00.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][work_end]	integer	*	When the work day ends. This is stored as the number of seconds after 00:00:00.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][work_days]	array	*	Array of work days, stored with keys corresponding to day numbers. Values are true. 0 = Sunday, 6 = Saturday (same as PHP, easy to convert to MySQL which is 1 = Sunday, 7 = Saturday).
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][work_timezone]	string	*	Timezone for work hours/days to be considered in.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][work_holidays]	array	*	List of work holidays.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][apply_type]	string	*	Controls how the SLA is applied to tickets: all, terms, terms_before_triggers, manual.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][apply_terms]	object (TriggerTerms)	*	Conditions to apply.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][apply_terms][version]	integer	*	Terms version.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][apply_terms][terms]	array	*	Terms themselves.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][trigger_terms]	object (TriggerTerms)	*	Conditions to consider sla completed.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][warn_time]	integer	*	Warn time integer.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][warn_time_unit]	string	*	And it's unit (see warn time).
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][warn_actions]	object (TriggerActions)	*	How to warn about SLA will fail.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][warn_actions][version]	integer	*	Actions version.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][warn_actions][actions]	array	*	Actions array representation.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][fail_time]	integer	*	Fail time integer.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][fail_time_unit]	string	*	And it's measuring unit (see fail_time).
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][fail_actions]	object (TriggerActions)	*	What to do if SLA failed.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][exclude_ticket_statuses]	array	*	This SLA will not apply while tickets are in these pending statuses.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla_status]	string	*
data.snippet_use_logs[][ticket_message][ticket][logs][][details]	array	*
data.snippet_use_logs[][ticket_message][ticket][logs][][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][chats][]	array of objects (ChatConversation)	*
data.snippet_use_logs[][ticket_message][ticket][created_with_channel]	string	*
data.snippet_use_logs[][ticket_message][ticket][last_channel_used]	string	*
data.snippet_use_logs[][ticket_message][ticket][channels]	array	*
data.snippet_use_logs[][ticket_message][ticket][pending_articles][]	array of objects (ArticlePendingCreate)	*
data.snippet_use_logs[][ticket_message][ticket][pending_articles][][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][pending_articles][][person]	integer id (Person)	*
data.snippet_use_logs[][ticket_message][ticket][pending_articles][][assigned_person]	integer id (Person)	*
data.snippet_use_logs[][ticket_message][ticket][pending_articles][][ticket]	integer id (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][pending_articles][][message]	integer id (TicketMessage)	*
data.snippet_use_logs[][ticket_message][ticket][pending_articles][][comment]	string	*
data.snippet_use_logs[][ticket_message][ticket][pending_articles][][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][summary]	object (TicketSummary)	*
data.snippet_use_logs[][ticket_message][ticket][summary][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][summary][ticket]	object (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][summary][summary]	string	*
data.snippet_use_logs[][ticket_message][ticket][summary][summary_input]	string	*
data.snippet_use_logs[][ticket_message][ticket][summary][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][person]	object (Person)	*	Person this message was sent by.
data.snippet_use_logs[][ticket_message][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data.snippet_use_logs[][ticket_message][email_source][id]	integer	*
data.snippet_use_logs[][ticket_message][email_source][uuid]	string	*
data.snippet_use_logs[][ticket_message][email_source][blob]	object (Blob)	*
data.snippet_use_logs[][ticket_message][email_source][blob][sys_name]	string	*	A unique system name for the blob.
data.snippet_use_logs[][ticket_message][email_source][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.snippet_use_logs[][ticket_message][email_source][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.snippet_use_logs[][ticket_message][email_source][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.snippet_use_logs[][ticket_message][email_source][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.snippet_use_logs[][ticket_message][email_source][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.snippet_use_logs[][ticket_message][email_source][blob][file_url]	string	*	The HTTP link to download the file.
data.snippet_use_logs[][ticket_message][email_source][blob][authcode]	string	*
data.snippet_use_logs[][ticket_message][email_source][blob][blob_hash]	string	*
data.snippet_use_logs[][ticket_message][email_source][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.snippet_use_logs[][ticket_message][email_source][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.snippet_use_logs[][ticket_message][email_source][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.snippet_use_logs[][ticket_message][email_source][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.snippet_use_logs[][ticket_message][email_source][blob][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][email_source][blob][is_temp]	boolean	*
data.snippet_use_logs[][ticket_message][email_source][blob][source_ref]	string	*
data.snippet_use_logs[][ticket_message][email_source][blob][labels][]	array of objects (LabelBlob)	*
data.snippet_use_logs[][ticket_message][email_source][blob][labels][][blob]	object (Blob)	*
data.snippet_use_logs[][ticket_message][email_source][object_type]	string	*	The type of object this is attached to (should be the table name of the super type, eg: tickets, people, organizations). This typically is not set until after the email is processed (ie the status is 'processed').
data.snippet_use_logs[][ticket_message][email_source][object_id]	integer	*	The ID of the object this is attached to.
data.snippet_use_logs[][ticket_message][email_source][from_email]	string	*
data.snippet_use_logs[][ticket_message][email_source][status]	string	*	The current status of the message: - inserted: Only inserted - processing: Currently processing - complete: Fully processed - error: Tried to process but there was some kind of error (see error_code).
data.snippet_use_logs[][ticket_message][email_source][date_status]	DateTime	*
data.snippet_use_logs[][ticket_message][email_source][error_code]	string	*	When status is error, this is the code that describes the error.
data.snippet_use_logs[][ticket_message][email_source][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.snippet_use_logs[][ticket_message][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.snippet_use_logs[][ticket_message][date_created]	DateTime	*	Date when message was created.
data.snippet_use_logs[][ticket_message][is_agent_note]	boolean	*	Is this message agent note?
data.snippet_use_logs[][ticket_message][is_hidden]	boolean	*	Is this message hidden?
data.snippet_use_logs[][ticket_message][creation_system]	string	*	How this message was created.
data.snippet_use_logs[][ticket_message][ip_address]	string	*	An ip address from which message was sent.
data.snippet_use_logs[][ticket_message][visitor_id]	string	*	Unique ID of visitor left this message.
data.snippet_use_logs[][ticket_message][hostname]	string	*	Host from which message was left.
data.snippet_use_logs[][ticket_message][geo_country]	string	*	Country message is from (deprecated).
data.snippet_use_logs[][ticket_message][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.snippet_use_logs[][ticket_message][message_hash]	string	*	An unique hash of message.
data.snippet_use_logs[][ticket_message][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.snippet_use_logs[][ticket_message][primary_translation][id]	integer	*
data.snippet_use_logs[][ticket_message][primary_translation][ticket]	object (Ticket)	*
data.snippet_use_logs[][ticket_message][primary_translation][ticket_message]	object (TicketMessage)	*
data.snippet_use_logs[][ticket_message][primary_translation][from_lang_code]	string	*
data.snippet_use_logs[][ticket_message][primary_translation][lang_code]	string	*
data.snippet_use_logs[][ticket_message][primary_translation][message]	string	*
data.snippet_use_logs[][ticket_message][primary_translation][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][message]	string	*	The message, will be in HTML!
data.snippet_use_logs[][ticket_message][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.snippet_use_logs[][ticket_message][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.snippet_use_logs[][ticket_message][message_source]	string	*	The message source.
data.snippet_use_logs[][ticket_message][message_source_type]	string	*	The message source type.
data.snippet_use_logs[][ticket_message][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.snippet_use_logs[][ticket_message][lang_code]	string	*	The set/detected lang code.
data.snippet_use_logs[][ticket_message][email_message_id][]	array of objects (TicketMessageEmailId)	*
data.snippet_use_logs[][ticket_message][email_message_id][][id]	integer	*
data.snippet_use_logs[][ticket_message][email_message_id][][message]	object (TicketMessage)	*
data.snippet_use_logs[][ticket_message][email_message_id][][email_id]	string	*
data.snippet_use_logs[][ticket_message][ticket_feedback][]	array of objects (TicketFeedback)	*
data.snippet_use_logs[][ticket_message][ticket_feedback][][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket_feedback][][ticket]	object (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data.snippet_use_logs[][ticket_message][ticket_feedback][][person]	object (Person)	*
data.snippet_use_logs[][ticket_message][ticket_feedback][][rating]	integer	*
data.snippet_use_logs[][ticket_message][ticket_feedback][][message]	string	*
data.snippet_use_logs[][ticket_message][ticket_feedback][][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][subject]	string	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][from_email]	string	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][tos]	array	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][ccs]	array	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][bccs]	array	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][message]	string	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][authcode]	string	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][blob_hash]	string	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][source_ref]	string	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][channel_message]	object (TicketMessageChannelMessage)	*
data.snippet_use_logs[][ticket_message][channel_message][id]	integer	*	@var int The unique id of message.
data.snippet_use_logs[][ticket_message][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data.snippet_use_logs[][ticket_message][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data.snippet_use_logs[][ticket_message][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data.snippet_use_logs[][ticket_message][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data.snippet_use_logs[][ticket_message][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data.snippet_use_logs[][ticket_message][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data.snippet_use_logs[][ticket_message][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data.snippet_use_logs[][ticket_message][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data.snippet_use_logs[][ticket_message][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data.snippet_use_logs[][chat_message]	object (ChatMessage)	*	Chat Message where the snippet was used.
data.snippet_use_logs[][chat_message][id]	integer	*	The unique ID.
data.snippet_use_logs[][chat_message][author_id]	integer	*	Author id (legacy).
data.snippet_use_logs[][chat_message][author_type]	string	*	Author type (legacy).
data.snippet_use_logs[][chat_message][conversation_id]	integer	*	Conversation id (legacy).
data.snippet_use_logs[][chat_message][author]	integer id (Person)	*	Person who created the message.
data.snippet_use_logs[][chat_message][content]	string	*	The message.
data.snippet_use_logs[][chat_message][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.snippet_use_logs[][chat_message][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.snippet_use_logs[][chat_message][is_html]	boolean	*	Is the content an HTML message?
data.snippet_use_logs[][chat_message][metadata]	array	*	Additional data.
data.snippet_use_logs[][chat_message][date_created]	DateTime	*	Date message was created.
data.snippet_use_logs[][chat_message][date_received]	DateTime	*	Date message was received.
data.snippet_use_logs[][language]	object (Language)	*	Snippet translated.
data.snippet_use_logs[][language][id]	integer	*	The unique ID.
data.snippet_use_logs[][language][sys_name]	string	*	The unique sys name assigned to the language.
data.snippet_use_logs[][language][title]	string	*	Title of the language.
data.snippet_use_logs[][language][title_local]	string	*	Title of the language.
data.snippet_use_logs[][language][base_filepath]	string	*	The base filepath for default phrases for this lang.
data.snippet_use_logs[][language][locale]	string	*	The locale code.
data.snippet_use_logs[][language][flag_image]	string	*	String path to image.
data.snippet_use_logs[][language][is_rtl]	boolean	*	True if this is a right-to-left language.
data.snippet_use_logs[][language][has_user]	boolean	*	True if has user.
data.snippet_use_logs[][language][has_agent]	boolean	*	True if has agent.
data.snippet_use_logs[][language][has_admin]	boolean	*	True if has admin.
data.snippet_use_logs[][language][plural_categories][]	array of strings	*
data.snippet_use_logs[][language][plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data.snippet_use_logs[][language][flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`
data.snippet_use_logs[][person]	object (Person)	*
data.snippet_use_logs[][rating]	integer	*
data.snippet_use_logs[][rating_person]	object (Person)	*
data.snippet_use_logs[][rating_message]	string	*
data.snippet_use_logs[][date_created]	DateTime	*
data.primary_translation	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.primary_translation[id]	integer	*
data.primary_translation[ticket]	object (Ticket)	*
data.primary_translation[ticket][id]	integer	*
data.primary_translation[ticket][ref]	string	*
data.primary_translation[ticket][auth]	string	*
data.primary_translation[ticket][parent_ticket]	object (Ticket)	*	Parent ticket.
data.primary_translation[ticket][children_tickets][]	array of objects (Ticket)	*
data.primary_translation[ticket][language]	object (Language)	*	The language the ticket is in.
data.primary_translation[ticket][language][id]	integer	*	The unique ID.
data.primary_translation[ticket][language][sys_name]	string	*	The unique sys name assigned to the language.
data.primary_translation[ticket][language][title]	string	*	Title of the language.
data.primary_translation[ticket][language][title_local]	string	*	Title of the language.
data.primary_translation[ticket][language][base_filepath]	string	*	The base filepath for default phrases for this lang.
data.primary_translation[ticket][language][locale]	string	*	The locale code.
data.primary_translation[ticket][language][flag_image]	string	*	String path to image.
data.primary_translation[ticket][language][is_rtl]	boolean	*	True if this is a right-to-left language.
data.primary_translation[ticket][language][has_user]	boolean	*	True if has user.
data.primary_translation[ticket][language][has_agent]	boolean	*	True if has agent.
data.primary_translation[ticket][language][has_admin]	boolean	*	True if has admin.
data.primary_translation[ticket][language][plural_categories][]	array of strings	*
data.primary_translation[ticket][language][plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data.primary_translation[ticket][language][flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`
data.primary_translation[ticket][brand]	object (Brand)	*
data.primary_translation[ticket][brand][id]	integer	*	The unique ID.
data.primary_translation[ticket][brand][name]	string	*	The brand name.
data.primary_translation[ticket][brand][slug]	string	*
data.primary_translation[ticket][brand][url]	string	*	The brand url.
data.primary_translation[ticket][brand][theme_set]	object (ThemeSet)	*
data.primary_translation[ticket][brand][theme_set][id]	integer	*
data.primary_translation[ticket][brand][theme_set][theme_id]	string	*
data.primary_translation[ticket][brand][theme_set][title]	string	*
data.primary_translation[ticket][brand][edit_theme_set]	object (ThemeSet)	*
data.primary_translation[ticket][brand][departments][]	array of objects (Department)	*
data.primary_translation[ticket][brand][departments][][id]	integer	*
data.primary_translation[ticket][brand][departments][][parent]	object (Department)	*
data.primary_translation[ticket][brand][departments][][children][]	array of objects (Department)	*
data.primary_translation[ticket][brand][departments][][title]	string	*
data.primary_translation[ticket][brand][departments][][user_title]	string	*
data.primary_translation[ticket][brand][departments][][is_tickets_enabled]	boolean	*
data.primary_translation[ticket][brand][departments][][is_chat_enabled]	boolean	*
data.primary_translation[ticket][brand][departments][][display_order]	integer	*
data.primary_translation[ticket][brand][departments][][avatar]	object (Blob)	*
data.primary_translation[ticket][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.primary_translation[ticket][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.primary_translation[ticket][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.primary_translation[ticket][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.primary_translation[ticket][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.primary_translation[ticket][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.primary_translation[ticket][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.primary_translation[ticket][brand][departments][][avatar][authcode]	string	*
data.primary_translation[ticket][brand][departments][][avatar][blob_hash]	string	*
data.primary_translation[ticket][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.primary_translation[ticket][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.primary_translation[ticket][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.primary_translation[ticket][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.primary_translation[ticket][brand][departments][][avatar][date_created]	DateTime	*
data.primary_translation[ticket][brand][departments][][avatar][is_temp]	boolean	*
data.primary_translation[ticket][brand][departments][][avatar][source_ref]	string	*
data.primary_translation[ticket][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.primary_translation[ticket][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.primary_translation[ticket][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.primary_translation[ticket][brand][departments][][brands][]	array of objects (Brand)	*
data.primary_translation[ticket][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.primary_translation[ticket][brand][departments][][permissions][][department]	integer id (Department)	*
data.primary_translation[ticket][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.primary_translation[ticket][brand][departments][][permissions][][name]	string	*	The name of the permission.
data.primary_translation[ticket][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.primary_translation[ticket][brand][departments][][permissions][][is_active]	boolean	*
data.primary_translation[ticket][brand][departments][][chat_queue]	object (UserChatQueue)	*
data.primary_translation[ticket][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.primary_translation[ticket][brand][departments][][chat_queue][name]	string	*
data.primary_translation[ticket][brand][departments][][chat_queue][routing_model]	string	*
data.primary_translation[ticket][brand][departments][][chat_queue][answer_timeout]	integer	*
data.primary_translation[ticket][brand][departments][][chat_queue][is_all_agents]	boolean	*
data.primary_translation[ticket][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.primary_translation[ticket][brand][departments][][chat_queue][max_queue_size]	integer	*
data.primary_translation[ticket][brand][theme_sets][]	array of objects (ThemeSet)	*
data.primary_translation[ticket][department]	object (Department)	*
data.primary_translation[ticket][department][id]	integer	*
data.primary_translation[ticket][department][parent]	object (Department)	*
data.primary_translation[ticket][department][children][]	array of objects (Department)	*
data.primary_translation[ticket][department][title]	string	*
data.primary_translation[ticket][department][user_title]	string	*
data.primary_translation[ticket][department][is_tickets_enabled]	boolean	*
data.primary_translation[ticket][department][is_chat_enabled]	boolean	*
data.primary_translation[ticket][department][display_order]	integer	*
data.primary_translation[ticket][department][avatar]	object (Blob)	*
data.primary_translation[ticket][department][avatar][sys_name]	string	*	A unique system name for the blob.
data.primary_translation[ticket][department][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.primary_translation[ticket][department][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.primary_translation[ticket][department][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.primary_translation[ticket][department][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.primary_translation[ticket][department][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.primary_translation[ticket][department][avatar][file_url]	string	*	The HTTP link to download the file.
data.primary_translation[ticket][department][avatar][authcode]	string	*
data.primary_translation[ticket][department][avatar][blob_hash]	string	*
data.primary_translation[ticket][department][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.primary_translation[ticket][department][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.primary_translation[ticket][department][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.primary_translation[ticket][department][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.primary_translation[ticket][department][avatar][date_created]	DateTime	*
data.primary_translation[ticket][department][avatar][is_temp]	boolean	*
data.primary_translation[ticket][department][avatar][source_ref]	string	*
data.primary_translation[ticket][department][avatar][labels][]	array of objects (LabelBlob)	*
data.primary_translation[ticket][department][avatar][labels][][blob]	object (Blob)	*
data.primary_translation[ticket][department][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.primary_translation[ticket][department][brands][]	array of objects (Brand)	*
data.primary_translation[ticket][department][permissions][]	array of objects (DepartmentPermission)	*
data.primary_translation[ticket][department][permissions][][department]	integer id (Department)	*
data.primary_translation[ticket][department][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.primary_translation[ticket][department][permissions][][name]	string	*	The name of the permission.
data.primary_translation[ticket][department][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.primary_translation[ticket][department][permissions][][is_active]	boolean	*
data.primary_translation[ticket][department][chat_queue]	object (UserChatQueue)	*
data.primary_translation[ticket][department][chat_queue][id]	integer	*	The unique ID.
data.primary_translation[ticket][department][chat_queue][name]	string	*
data.primary_translation[ticket][department][chat_queue][routing_model]	string	*
data.primary_translation[ticket][department][chat_queue][answer_timeout]	integer	*
data.primary_translation[ticket][department][chat_queue][is_all_agents]	boolean	*
data.primary_translation[ticket][department][chat_queue][departments][]	array of objects (Department)	*
data.primary_translation[ticket][department][chat_queue][max_queue_size]	integer	*
data.primary_translation[ticket][category]	object (TicketCategory)	*
data.primary_translation[ticket][category][id]	integer	*	The unique ID.
data.primary_translation[ticket][category][parent]	integer id (TicketCategory)	*	This category parent.
data.primary_translation[ticket][category][title]	string	*	Category title.
data.primary_translation[ticket][category][display_order]	integer	*	Obviously it's display order for lists.
data.primary_translation[ticket][priority]	object (TicketPriority)	*
data.primary_translation[ticket][priority][id]	integer	*	The unique ID.
data.primary_translation[ticket][priority][title]	string	*	Priority title.
data.primary_translation[ticket][priority][priority]	integer	*	The priority itself.
data.primary_translation[ticket][workflow]	object (TicketWorkflow)	*
data.primary_translation[ticket][workflow][id]	integer	*	The unique ID.
data.primary_translation[ticket][workflow][title]	string	*	Workflow title.
data.primary_translation[ticket][workflow][display_order]	integer	*	Workflow display order.
data.primary_translation[ticket][product]	object (Product)	*
data.primary_translation[ticket][product][parent]	integer id (Product)	*	Parent of the product.
data.primary_translation[ticket][person]	object (Person)	*
data.primary_translation[ticket][person_email]	object (PersonEmail)	*
data.primary_translation[ticket][person_email][id]	integer	*	The unique ID.
data.primary_translation[ticket][person_email][person]	integer id (Person)	*	Person owner of email.
data.primary_translation[ticket][person_email][email]	string	*	The email address.
data.primary_translation[ticket][person_email][email_domain]	string	*	The email address domain.
data.primary_translation[ticket][person_email][is_validated]	boolean	*	True if validation passed.
data.primary_translation[ticket][person_email][date_created]	DateTime	*	The original time the email was created.
data.primary_translation[ticket][agent]	object (Person)	*
data.primary_translation[ticket][agent_team]	object (AgentTeam)	*
data.primary_translation[ticket][agent_team][id]	integer	*	The unique ID.
data.primary_translation[ticket][agent_team][name]	string	*	The name of agent team.
data.primary_translation[ticket][agent_team][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.primary_translation[ticket][organization]	object (Organization)	*
data.primary_translation[ticket][organization][id]	integer	*	The unique ID.
data.primary_translation[ticket][organization][picture_blob]	object (Blob)	*	The org picture.
data.primary_translation[ticket][organization][picture_blob][sys_name]	string	*	A unique system name for the blob.
data.primary_translation[ticket][organization][picture_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.primary_translation[ticket][organization][picture_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.primary_translation[ticket][organization][picture_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.primary_translation[ticket][organization][picture_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.primary_translation[ticket][organization][picture_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.primary_translation[ticket][organization][picture_blob][file_url]	string	*	The HTTP link to download the file.
data.primary_translation[ticket][organization][picture_blob][authcode]	string	*
data.primary_translation[ticket][organization][picture_blob][blob_hash]	string	*
data.primary_translation[ticket][organization][picture_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.primary_translation[ticket][organization][picture_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.primary_translation[ticket][organization][picture_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.primary_translation[ticket][organization][picture_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.primary_translation[ticket][organization][picture_blob][date_created]	DateTime	*
data.primary_translation[ticket][organization][picture_blob][is_temp]	boolean	*
data.primary_translation[ticket][organization][picture_blob][source_ref]	string	*
data.primary_translation[ticket][organization][picture_blob][labels][]	array of objects (LabelBlob)	*
data.primary_translation[ticket][organization][picture_blob][labels][][blob]	object (Blob)	*
data.primary_translation[ticket][organization][icon_property]	object (IconProperty)	*
data.primary_translation[ticket][organization][icon_property][urn]	string	*
data.primary_translation[ticket][organization][icon_property][options]	array	*
data.primary_translation[ticket][organization][name]	string	*	The organization name.
data.primary_translation[ticket][organization][summary]	string	*	The summary field as filled in by agents.
data.primary_translation[ticket][organization][importance]	integer	*	The org importance.
data.primary_translation[ticket][organization][custom_data][]	array of objects (CustomDataOrganization)	*
data.primary_translation[ticket][organization][custom_data][][organization]	object (Organization)	*
data.primary_translation[ticket][organization][custom_data][][field]	object (CustomDefOrganization)	*
data.primary_translation[ticket][organization][custom_data][][field][parent]	object (CustomDefOrganization)	*	Field`s parent.
data.primary_translation[ticket][organization][custom_data][][field][children][]	array of objects (CustomDefOrganization)	*	Field children.
data.primary_translation[ticket][organization][custom_data][][root_field]	object (CustomDefOrganization)	*
data.primary_translation[ticket][organization][usergroups][]	array of objects (Usergroup)	*	Usergroups the user belongs to.
data.primary_translation[ticket][organization][usergroups][][id]	integer	*	The unique ID, DB-generated.
data.primary_translation[ticket][organization][usergroups][][title]	string	*	Title of the usergroup.
data.primary_translation[ticket][organization][usergroups][][note]	string	*	A note or description about the usergroup.
data.primary_translation[ticket][organization][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.primary_translation[ticket][organization][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.primary_translation[ticket][organization][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.primary_translation[ticket][organization][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.primary_translation[ticket][organization][usergroups][][permissions][][id]	integer	*	The unique ID.
data.primary_translation[ticket][organization][usergroups][][permissions][][name]	string	*	The name of the permission.
data.primary_translation[ticket][organization][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.primary_translation[ticket][organization][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.primary_translation[ticket][organization][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.primary_translation[ticket][organization][usergroups][][department_permissions][][department]	integer id (Department)	*
data.primary_translation[ticket][organization][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.primary_translation[ticket][organization][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.primary_translation[ticket][organization][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.primary_translation[ticket][organization][usergroups][][department_permissions][][is_active]	boolean	*
data.primary_translation[ticket][organization][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.primary_translation[ticket][organization][auto_cc_people][]	array of objects (Person)	*	Users who are set to automatically be added to tickets and other org things.
data.primary_translation[ticket][organization][labels][]	array of objects (LabelOrganization)	*
data.primary_translation[ticket][organization][labels][][organization]	object (Organization)	*
data.primary_translation[ticket][organization][contact_data][]	array of objects (OrganizationContactData)	*
data.primary_translation[ticket][organization][emails][]	array of objects (OrganizationEmail)	*
data.primary_translation[ticket][organization][emails][][id]	integer	*	The unique log id.
data.primary_translation[ticket][organization][emails][][organization]	object (Organization)	*
data.primary_translation[ticket][organization][emails][][email]	string	*
data.primary_translation[ticket][organization][emails][][date_created]	DateTime	*
data.primary_translation[ticket][organization][email_domains][]	array of objects (OrganizationEmailDomain)	*
data.primary_translation[ticket][organization][email_domains][][domain]	string	*	The email domain.
data.primary_translation[ticket][organization][email_domains][][organization]	object (Organization)	*	The users organization.
data.primary_translation[ticket][organization][date_created]	DateTime	*	The date the org was inserted into the system.
data.primary_translation[ticket][organization][members][]	array of objects (Person)	*
data.primary_translation[ticket][organization][parent]	object (Organization)	*
data.primary_translation[ticket][organization][children][]	array of objects (Organization)	*
data.primary_translation[ticket][organization][tickets][]	array of objects (Ticket)	*
data.primary_translation[ticket][organization][organization_members][]	array of objects (OrganizationMember)	*
data.primary_translation[ticket][organization][organization_members][][id]	integer	*
data.primary_translation[ticket][organization][organization_members][][person]	integer id (Person)	*
data.primary_translation[ticket][organization][organization_members][][organization]	integer id (Organization)	*
data.primary_translation[ticket][organization][organization_members][][is_manager]	boolean	*
data.primary_translation[ticket][organization][organization_members][][position]	string	*
data.primary_translation[ticket][organization][organization_members][][created_at]	DateTime	*
data.primary_translation[ticket][organization][organization_members][][updated_at]	DateTime	*
data.primary_translation[ticket][linked_chat]	object (ChatConversation)	*
data.primary_translation[ticket][linked_chat][id]	integer	*	The unique id of chat conversation.
data.primary_translation[ticket][linked_chat][department]	object (Department)	*	Department which chat was assigned.
data.primary_translation[ticket][linked_chat][brand]	object (Brand)	*	Department which chat was assigned.
data.primary_translation[ticket][linked_chat][task_id]	integer	*
data.primary_translation[ticket][linked_chat][ticket]	object (Ticket)	*
data.primary_translation[ticket][linked_chat][labels][]	array of objects (LabelChatConversation)	*
data.primary_translation[ticket][linked_chat][labels][][chat]	object (ChatConversation)	*
data.primary_translation[ticket][linked_chat][subject]	string	*	Subject of the chat conversation.
data.primary_translation[ticket][linked_chat][status]	string	*	Status of the chat conversation.
data.primary_translation[ticket][linked_chat][agent]	object (Person)	*	If this is a user conversation, this is the agent assigned.
data.primary_translation[ticket][linked_chat][agent_team]	object (AgentTeam)	*	If this is a team chat, the team it is.
data.primary_translation[ticket][linked_chat][person]	object (Person)	*	If this is a user conversation, this is the user who started the chat.
data.primary_translation[ticket][linked_chat][session]	object (Session)	*	If this is a user convo, this is the users session.
data.primary_translation[ticket][linked_chat][session][id]	integer	*	The unique ID.
data.primary_translation[ticket][linked_chat][session][auth]	string	*	The authcode for the session to verify an id.
data.primary_translation[ticket][linked_chat][session][interface]	string	*	The Interface the session is for.
data.primary_translation[ticket][linked_chat][session][person]	object (Person)	*
data.primary_translation[ticket][linked_chat][session][user_agent]	string	*	The users user agent string.
data.primary_translation[ticket][linked_chat][session][visitor_id]	string	*
data.primary_translation[ticket][linked_chat][session][ip_address]	string	*	The users IP address.
data.primary_translation[ticket][linked_chat][session][data]	string	*
data.primary_translation[ticket][linked_chat][session][is_person]	boolean	*
data.primary_translation[ticket][linked_chat][session][is_bot]	boolean	*
data.primary_translation[ticket][linked_chat][session][is_helpdesk]	boolean	*
data.primary_translation[ticket][linked_chat][session][active_status]	string	*	(Agents) Status (available or away).
data.primary_translation[ticket][linked_chat][session][is_chat_available]	boolean	*	(Agents) Wehn status is available, if they are available for chat.
data.primary_translation[ticket][linked_chat][session][date_created]	DateTime	*
data.primary_translation[ticket][linked_chat][session][date_last]	DateTime	*
data.primary_translation[ticket][linked_chat][session][date_last_page]	DateTime	*
data.primary_translation[ticket][linked_chat][visitor_id]	string	*
data.primary_translation[ticket][linked_chat][person_name]	string	*	User chat: The users name, if they arent a person.
data.primary_translation[ticket][linked_chat][person_email]	string	*	User chat: The users email, if they aren`t a person.
data.primary_translation[ticket][linked_chat][participants][]	array of objects (Person)	*
data.primary_translation[ticket][linked_chat][messages][]	array of objects (ChatMessage)	*
data.primary_translation[ticket][linked_chat][messages][][id]	integer	*	The unique ID.
data.primary_translation[ticket][linked_chat][messages][][author_id]	integer	*	Author id (legacy).
data.primary_translation[ticket][linked_chat][messages][][author_type]	string	*	Author type (legacy).
data.primary_translation[ticket][linked_chat][messages][][conversation_id]	integer	*	Conversation id (legacy).
data.primary_translation[ticket][linked_chat][messages][][author]	integer id (Person)	*	Person who created the message.
data.primary_translation[ticket][linked_chat][messages][][content]	string	*	The message.
data.primary_translation[ticket][linked_chat][messages][][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.primary_translation[ticket][linked_chat][messages][][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.primary_translation[ticket][linked_chat][messages][][is_html]	boolean	*	Is the content an HTML message?
data.primary_translation[ticket][linked_chat][messages][][metadata]	array	*	Additional data.
data.primary_translation[ticket][linked_chat][messages][][date_created]	DateTime	*	Date message was created.
data.primary_translation[ticket][linked_chat][messages][][date_received]	DateTime	*	Date message was received.
data.primary_translation[ticket][linked_chat][custom_data][]	array of objects (CustomDataChat)	*
data.primary_translation[ticket][linked_chat][custom_data][][conversation]	object (ChatConversation)	*	The conversation the message belongs to.
data.primary_translation[ticket][linked_chat][custom_data][][field]	object (CustomDefChat)	*
data.primary_translation[ticket][linked_chat][custom_data][][field][parent]	object (CustomDefChat)	*
data.primary_translation[ticket][linked_chat][custom_data][][field][children][]	array of objects (CustomDefChat)	*	Field children.
data.primary_translation[ticket][linked_chat][custom_data][][root_field]	object (CustomDefChat)	*
data.primary_translation[ticket][linked_chat][rating_response_time]	integer	*
data.primary_translation[ticket][linked_chat][rating_overall]	integer	*
data.primary_translation[ticket][linked_chat][rating_comment]	string	*
data.primary_translation[ticket][linked_chat][is_agent]	boolean	*	Is this an agent chat.
data.primary_translation[ticket][linked_chat][is_window]	boolean	*	If the chat is popped out into a window. This is used to make sure the JS widget on pages doesn't load again.
data.primary_translation[ticket][linked_chat][date_created]	DateTime	*	Date when chat was started.
data.primary_translation[ticket][linked_chat][date_user_waiting]	DateTime	*	Since when the user has started waiting (i.e., time the assignment was 0).
data.primary_translation[ticket][linked_chat][date_assigned]	DateTime	*
data.primary_translation[ticket][linked_chat][date_agent_typing]	DateTime	*	Date when agent typed last time.
data.primary_translation[ticket][linked_chat][date_first_agent_message]	DateTime	*
data.primary_translation[ticket][linked_chat][date_ended]	DateTime	*	Date when chat was ended.
data.primary_translation[ticket][linked_chat][total_to_ended]	integer	*
data.primary_translation[ticket][linked_chat][ended_by]	string	*	Who ended the chat.
data.primary_translation[ticket][linked_chat][should_send_transcript]	boolean	*	True if transcript should be send.
data.primary_translation[ticket][linked_chat][date_transcript_sent]	DateTime	*	Date when transcript was sent.
data.primary_translation[ticket][linked_chat][email_validation_code]	string	*
data.primary_translation[ticket][linked_chat][email_validated]	boolean	*
data.primary_translation[ticket][linked_chat][access_token]	string	*
data.primary_translation[ticket][attachments][]	array of objects (TicketAttachment)	*
data.primary_translation[ticket][access_codes][]	array of objects (TicketAccessCode)	*
data.primary_translation[ticket][access_codes][][id]	integer	*
data.primary_translation[ticket][access_codes][][ticket]	object (Ticket)	*
data.primary_translation[ticket][access_codes][][person]	object (Person)	*
data.primary_translation[ticket][access_codes][][auth]	string	*
data.primary_translation[ticket][messages][]	array of objects (TicketMessage)	*
data.primary_translation[ticket][messages][][id]	integer	*	The unique id of message.
data.primary_translation[ticket][messages][][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data.primary_translation[ticket][messages][][person]	object (Person)	*	Person this message was sent by.
data.primary_translation[ticket][messages][][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data.primary_translation[ticket][messages][][email_source][id]	integer	*
data.primary_translation[ticket][messages][][email_source][uuid]	string	*
data.primary_translation[ticket][messages][][email_source][blob]	object (Blob)	*
data.primary_translation[ticket][messages][][email_source][blob][sys_name]	string	*	A unique system name for the blob.
data.primary_translation[ticket][messages][][email_source][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.primary_translation[ticket][messages][][email_source][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.primary_translation[ticket][messages][][email_source][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.primary_translation[ticket][messages][][email_source][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.primary_translation[ticket][messages][][email_source][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.primary_translation[ticket][messages][][email_source][blob][file_url]	string	*	The HTTP link to download the file.
data.primary_translation[ticket][messages][][email_source][blob][authcode]	string	*
data.primary_translation[ticket][messages][][email_source][blob][blob_hash]	string	*
data.primary_translation[ticket][messages][][email_source][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.primary_translation[ticket][messages][][email_source][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.primary_translation[ticket][messages][][email_source][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.primary_translation[ticket][messages][][email_source][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.primary_translation[ticket][messages][][email_source][blob][date_created]	DateTime	*
data.primary_translation[ticket][messages][][email_source][blob][is_temp]	boolean	*
data.primary_translation[ticket][messages][][email_source][blob][source_ref]	string	*
data.primary_translation[ticket][messages][][email_source][blob][labels][]	array of objects (LabelBlob)	*
data.primary_translation[ticket][messages][][email_source][blob][labels][][blob]	object (Blob)	*
data.primary_translation[ticket][messages][][email_source][object_type]	string	*	The type of object this is attached to (should be the table name of the super type, eg: tickets, people, organizations). This typically is not set until after the email is processed (ie the status is 'processed').
data.primary_translation[ticket][messages][][email_source][object_id]	integer	*	The ID of the object this is attached to.
data.primary_translation[ticket][messages][][email_source][from_email]	string	*
data.primary_translation[ticket][messages][][email_source][status]	string	*	The current status of the message: - inserted: Only inserted - processing: Currently processing - complete: Fully processed - error: Tried to process but there was some kind of error (see error_code).
data.primary_translation[ticket][messages][][email_source][date_status]	DateTime	*
data.primary_translation[ticket][messages][][email_source][error_code]	string	*	When status is error, this is the code that describes the error.
data.primary_translation[ticket][messages][][email_source][date_created]	DateTime	*
data.primary_translation[ticket][messages][][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.primary_translation[ticket][messages][][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.primary_translation[ticket][messages][][date_created]	DateTime	*	Date when message was created.
data.primary_translation[ticket][messages][][is_agent_note]	boolean	*	Is this message agent note?
data.primary_translation[ticket][messages][][is_hidden]	boolean	*	Is this message hidden?
data.primary_translation[ticket][messages][][creation_system]	string	*	How this message was created.
data.primary_translation[ticket][messages][][ip_address]	string	*	An ip address from which message was sent.
data.primary_translation[ticket][messages][][visitor_id]	string	*	Unique ID of visitor left this message.
data.primary_translation[ticket][messages][][hostname]	string	*	Host from which message was left.
data.primary_translation[ticket][messages][][geo_country]	string	*	Country message is from (deprecated).
data.primary_translation[ticket][messages][][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.primary_translation[ticket][messages][][message_hash]	string	*	An unique hash of message.
data.primary_translation[ticket][messages][][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.primary_translation[ticket][messages][][message]	string	*	The message, will be in HTML!
data.primary_translation[ticket][messages][][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.primary_translation[ticket][messages][][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.primary_translation[ticket][messages][][message_source]	string	*	The message source.
data.primary_translation[ticket][messages][][message_source_type]	string	*	The message source type.
data.primary_translation[ticket][messages][][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.primary_translation[ticket][messages][][lang_code]	string	*	The set/detected lang code.
data.primary_translation[ticket][messages][][email_message_id][]	array of objects (TicketMessageEmailId)	*
data.primary_translation[ticket][messages][][email_message_id][][id]	integer	*
data.primary_translation[ticket][messages][][email_message_id][][message]	object (TicketMessage)	*
data.primary_translation[ticket][messages][][email_message_id][][email_id]	string	*
data.primary_translation[ticket][messages][][ticket_feedback][]	array of objects (TicketFeedback)	*
data.primary_translation[ticket][messages][][ticket_feedback][][id]	integer	*
data.primary_translation[ticket][messages][][ticket_feedback][][ticket]	object (Ticket)	*
data.primary_translation[ticket][messages][][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data.primary_translation[ticket][messages][][ticket_feedback][][person]	object (Person)	*
data.primary_translation[ticket][messages][][ticket_feedback][][rating]	integer	*
data.primary_translation[ticket][messages][][ticket_feedback][][message]	string	*
data.primary_translation[ticket][messages][][ticket_feedback][][date_created]	DateTime	*
data.primary_translation[ticket][messages][][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][id]	integer	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][subject]	string	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][from_email]	string	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][tos]	array	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][ccs]	array	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][bccs]	array	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][message]	string	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][authcode]	string	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][blob_hash]	string	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][source_ref]	string	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][date_created]	DateTime	*
data.primary_translation[ticket][messages][][channel_message]	object (TicketMessageChannelMessage)	*
data.primary_translation[ticket][messages][][channel_message][id]	integer	*	@var int The unique id of message.
data.primary_translation[ticket][messages][][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data.primary_translation[ticket][messages][][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data.primary_translation[ticket][messages][][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data.primary_translation[ticket][messages][][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data.primary_translation[ticket][messages][][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data.primary_translation[ticket][messages][][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data.primary_translation[ticket][messages][][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data.primary_translation[ticket][messages][][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data.primary_translation[ticket][messages][][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data.primary_translation[ticket][sms_messages][]	array of objects (TicketSms)	*
data.primary_translation[ticket][sms_messages][][id]	integer	*
data.primary_translation[ticket][sms_messages][][ticket]	object (Ticket)	*
data.primary_translation[ticket][sms_messages][][person]	object (Person)	*
data.primary_translation[ticket][sms_messages][][sms_account]	object (SmsAccount)	*
data.primary_translation[ticket][sms_messages][][sms_account][id]	integer	*	The unique ID.
data.primary_translation[ticket][sms_messages][][sms_account][type]	string	*
data.primary_translation[ticket][sms_messages][][sms_account][params]	array	*
data.primary_translation[ticket][sms_messages][][sms_account][identifier]	string	*
data.primary_translation[ticket][sms_messages][][sms_account][is_enabled]	boolean	*
data.primary_translation[ticket][sms_messages][][sms_account][is_connected]	boolean	*
data.primary_translation[ticket][sms_messages][][sms_account][is_tested]	boolean	*
data.primary_translation[ticket][sms_messages][][sms_account][test_code]	string	*
data.primary_translation[ticket][sms_messages][][job]	object (Job)	*
data.primary_translation[ticket][sms_messages][][job][id]	integer	*	The unique job id.
data.primary_translation[ticket][sms_messages][][job][type]	string	*	The job type, used by the Job Router to find the right Job Processor.
data.primary_translation[ticket][sms_messages][][job][status]	string	*	The status of the job.
data.primary_translation[ticket][sms_messages][][job][status_code]	string	*	Any code to further classify the status.
data.primary_translation[ticket][sms_messages][][job][date_touch]	DateTime	*	Date the last time a process "touched" this ticket.
data.primary_translation[ticket][sms_messages][][job][date_created]	DateTime	*	Date this job entered the "jobs" table.
data.primary_translation[ticket][sms_messages][][job][date_last_try]	DateTime	*	Last time we processed this job.
data.primary_translation[ticket][sms_messages][][job][date_next_try]	DateTime	*	If this DateTime is in the future, it won't be selected for execution.
data.primary_translation[ticket][sms_messages][][job][num_tries]	integer	*	The number of times this job has been executed Job Processor (usually indicated failures if > 1).
data.primary_translation[ticket][sms_messages][][job][log_summary]	string	*	A human readable summary of the job's execution.
data.primary_translation[ticket][sms_messages][][job][log]	string	*	A more verbose log.
data.primary_translation[ticket][sms_messages][][job][data]	array	*	An array of data, or payload, that the job processor needs to execute this job (stored in the db as json). This MUST always be an array, even if its an empty array
data.primary_translation[ticket][sms_messages][][job][original_job]	integer	*	Null unless the job was created as a retry - if so, the originating job ID is stored here so we can query it later. Note: You MUST specify the originating job, do not create a linked list of failed jobs.
data.primary_translation[ticket][sms_messages][][date_created]	DateTime	*
data.primary_translation[ticket][sms_messages][][from_number]	string	*	Permanent record of the phone number that sent this SMS. (Won't change even if Person changes their phone number).
data.primary_translation[ticket][sms_messages][][to_number]	string	*	Permanent record of the phone number that this SMS was sent to.
data.primary_translation[ticket][sms_messages][][message]	string	*	The SMS message.
data.primary_translation[ticket][sms_messages][][direction]	string	*	Just a system flag for reporting.
data.primary_translation[ticket][topic_links][]	array of objects (TicketCommunityTopicLink)	*
data.primary_translation[ticket][topic_links][][id]	integer	*	The unique filter ID.
data.primary_translation[ticket][topic_links][][ticket]	integer id (Ticket)	*
data.primary_translation[ticket][topic_links][][topic]	integer id (CommunityTopic)	*
data.primary_translation[ticket][topic_links][][person]	integer id (Person)	*
data.primary_translation[ticket][topic_links][][date_created]	DateTime	*
data.primary_translation[ticket][custom_data][]	array of objects (CustomDataTicket)	*
data.primary_translation[ticket][custom_data][][ticket]	object (Ticket)	*
data.primary_translation[ticket][custom_data][][field]	object (CustomDefTicket)	*
data.primary_translation[ticket][custom_data][][field][parent]	object (CustomDefTicket)	*
data.primary_translation[ticket][custom_data][][field][children][]	array of objects (CustomDefTicket)	*	Field children.
data.primary_translation[ticket][custom_data][][root_field]	object (CustomDefTicket)	*
data.primary_translation[ticket][labels][]	array of objects (LabelTicket)	*
data.primary_translation[ticket][labels][][ticket]	object (Ticket)	*
data.primary_translation[ticket][sent_to_address]	string	*	The email address the ticket was sent to if it came in via a gateway. This is a full string (e.g., including CC's) of the original.
data.primary_translation[ticket][email_account]	object (EmailAccount)	*	The gateway this ticket originated from.
data.primary_translation[ticket][email_account][id]	integer	*
data.primary_translation[ticket][email_account][account_type]	string	*
data.primary_translation[ticket][email_account][is_enabled]	boolean	*
data.primary_translation[ticket][email_account][address]	string	*
data.primary_translation[ticket][email_account][cert_blob]	object (Blob)	*
data.primary_translation[ticket][email_account][cert_blob][sys_name]	string	*	A unique system name for the blob.
data.primary_translation[ticket][email_account][cert_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.primary_translation[ticket][email_account][cert_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.primary_translation[ticket][email_account][cert_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.primary_translation[ticket][email_account][cert_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.primary_translation[ticket][email_account][cert_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.primary_translation[ticket][email_account][cert_blob][file_url]	string	*	The HTTP link to download the file.
data.primary_translation[ticket][email_account][cert_blob][authcode]	string	*
data.primary_translation[ticket][email_account][cert_blob][blob_hash]	string	*
data.primary_translation[ticket][email_account][cert_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.primary_translation[ticket][email_account][cert_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.primary_translation[ticket][email_account][cert_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.primary_translation[ticket][email_account][cert_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.primary_translation[ticket][email_account][cert_blob][date_created]	DateTime	*
data.primary_translation[ticket][email_account][cert_blob][is_temp]	boolean	*
data.primary_translation[ticket][email_account][cert_blob][source_ref]	string	*
data.primary_translation[ticket][email_account][cert_blob][labels][]	array of objects (LabelBlob)	*
data.primary_translation[ticket][email_account][cert_blob][labels][][blob]	object (Blob)	*
data.primary_translation[ticket][email_account][key_blob]	object (Blob)	*
data.primary_translation[ticket][email_account_address]	string	*	The email address (from list of to/cc) that matched with the email account.
data.primary_translation[ticket][creation_system]	string	*
data.primary_translation[ticket][creation_system_option]	string	*	Optional information about the creation system. For example, source URL the ticket came from.
data.primary_translation[ticket][ticket_hash]	string	*
data.primary_translation[ticket][status]	string	*
data.primary_translation[ticket][ticket_status]	object (TicketStatus)	*
data.primary_translation[ticket][ticket_status][id]	integer	*
data.primary_translation[ticket][ticket_status][status_type]	string	*
data.primary_translation[ticket][ticket_status][status_code]	string	*
data.primary_translation[ticket][ticket_status][sys_id]	string	*
data.primary_translation[ticket][ticket_status][title]	string	*
data.primary_translation[ticket][ticket_status][display_order]	integer	*
data.primary_translation[ticket][ticket_status][pending_waiting_time_mode]	string	*	Where to count time spending in pending status. Check PENDING_WAITING_TIME_MODE_ constants
data.primary_translation[ticket][ticket_status][children][]	array of objects (TicketStatus)	*
data.primary_translation[ticket][ticket_status][options]	array	*
data.primary_translation[ticket][urgency]	integer	*
data.primary_translation[ticket][feedback_rating]	integer	*
data.primary_translation[ticket][date_feedback_rating]	DateTime	*
data.primary_translation[ticket][date_created]	DateTime	*
data.primary_translation[ticket][date_resolved]	DateTime	*
data.primary_translation[ticket][date_archived]	DateTime	*
data.primary_translation[ticket][date_first_agent_assign]	DateTime	*
data.primary_translation[ticket][date_first_agent_reply]	DateTime	*
data.primary_translation[ticket][date_last_agent_reply]	DateTime	*
data.primary_translation[ticket][date_last_user_reply]	DateTime	*
data.primary_translation[ticket][date_agent_waiting]	DateTime	*
data.primary_translation[ticket][date_user_waiting]	DateTime	*
data.primary_translation[ticket][date_status]	DateTime	*
data.primary_translation[ticket][date_on_hold]	DateTime	*
data.primary_translation[ticket][total_user_waiting]	integer	*
data.primary_translation[ticket][total_to_first_reply]	integer	*
data.primary_translation[ticket][total_user_waiting_wh_start]	DateTime	*
data.primary_translation[ticket][total_user_waiting_wh]	integer	*
data.primary_translation[ticket][total_to_first_reply_wh]	integer	*
data.primary_translation[ticket][locked_by_agent]	object (Person)	*
data.primary_translation[ticket][date_locked]	DateTime	*
data.primary_translation[ticket][has_attachments]	boolean	*
data.primary_translation[ticket][subject]	string	*
data.primary_translation[ticket][original_subject]	string	*
data.primary_translation[ticket][properties]	array	*
data.primary_translation[ticket][count_agent_replies]	integer	*
data.primary_translation[ticket][count_user_replies]	integer	*
data.primary_translation[ticket][worst_sla_status]	string	*
data.primary_translation[ticket][waiting_times]	array	*	Used to track ticket status changes and how much time ticket was in status Add new item every time status changed This is optimisation over TicketLog.
data.primary_translation[ticket][participants][]	array of objects (TicketParticipant)	*
data.primary_translation[ticket][participants][][id]	integer	*
data.primary_translation[ticket][participants][][ticket]	object (Ticket)	*
data.primary_translation[ticket][participants][][person]	object (Person)	*
data.primary_translation[ticket][participants][][access_code]	object (TicketAccessCode)	*
data.primary_translation[ticket][participants][][person_email]	object (PersonEmail)	*
data.primary_translation[ticket][participants][][default_on]	boolean	*	Default checkbox status of the user.
data.primary_translation[ticket][charges][]	array of objects (TicketCharge)	*
data.primary_translation[ticket][charges][][id]	integer	*
data.primary_translation[ticket][charges][][charge_time]	integer	*
data.primary_translation[ticket][charges][][amount]	float	*
data.primary_translation[ticket][charges][][date_created]	DateTime	*
data.primary_translation[ticket][charges][][ticket]	object (Ticket)	*
data.primary_translation[ticket][charges][][person]	object (Person)	*
data.primary_translation[ticket][charges][][organization]	object (Organization)	*
data.primary_translation[ticket][charges][][agent]	object (Person)	*
data.primary_translation[ticket][charges][][custom_data][]	array of objects (CustomDataBilling)	*
data.primary_translation[ticket][charges][][custom_data][][ticket_charge]	object (TicketCharge)	*
data.primary_translation[ticket][charges][][custom_data][][field]	object (CustomDefBilling)	*
data.primary_translation[ticket][charges][][custom_data][][field][parent]	object (CustomDefBilling)	*
data.primary_translation[ticket][charges][][custom_data][][field][children][]	array of objects (CustomDefBilling)	*	Field children.
data.primary_translation[ticket][charges][][custom_data][][root_field]	object (CustomDefBilling)	*
data.primary_translation[ticket][ticket_slas][]	array of objects (TicketSla)	*
data.primary_translation[ticket][ticket_slas][][id]	integer	*	The unique ID.
data.primary_translation[ticket][ticket_slas][][sla_status]	string	*	The SLA status.
data.primary_translation[ticket][ticket_slas][][warn_date]	DateTime	*	The SLA warn date.
data.primary_translation[ticket][ticket_slas][][fail_date]	DateTime	*	The SLA fail date.
data.primary_translation[ticket][ticket_slas][][is_completed]	boolean	*	Is the SLA completed?
data.primary_translation[ticket][ticket_slas][][is_completed_set]	boolean	*	Completed by automated action.
data.primary_translation[ticket][ticket_slas][][completed_time_taken]	integer	*	Time taken.
data.primary_translation[ticket][ticket_slas][][ticket]	integer id (Ticket)	*	Ticket.
data.primary_translation[ticket][ticket_slas][][sla]	integer id (Sla)	*	SLA.
data.primary_translation[ticket][ticket_slas][][date_applied]	DateTime	*	time and date when SLA was applied to the ticket.
data.primary_translation[ticket][ticket_slas][][date_completed]	DateTime	*	time when SLA status became OK.
data.primary_translation[ticket][jira_issues][]	array of objects (JiraIssue)	*	linked jira issues.
data.primary_translation[ticket][jira_issues][][id]	integer	*	The unique ID.
data.primary_translation[ticket][jira_issues][][ticket]	object (Ticket)	*	The associated DeskPRO ticket.
data.primary_translation[ticket][jira_issues][][issue_id]	integer	*
data.primary_translation[ticket][jira_issues][][status_id]	integer	*
data.primary_translation[ticket][jira_issues][][created]	DateTime	*	Export time.
data.primary_translation[ticket][problems][]	array of objects (Problem)	*
data.primary_translation[ticket][problems][][id]	integer	*	The unique ID.
data.primary_translation[ticket][problems][][title]	string	*	Problem title.
data.primary_translation[ticket][problems][][creator]	integer id (Person)	*	Person who created the problem.
data.primary_translation[ticket][problems][][created]	DateTime	*	Date when the problem was created.
data.primary_translation[ticket][problems][][is_open]	boolean	*	Is problem still has no solution?
data.primary_translation[ticket][problems][][tickets][]	array of integer ids (Ticket)	*	Tickets associated with problem.
data.primary_translation[ticket][stars][]	array of objects (TicketFlagged)	*
data.primary_translation[ticket][stars][][ticket]	object (Ticket)	*
data.primary_translation[ticket][stars][][person_id]	integer	*
data.primary_translation[ticket][stars][][color]	string	*
data.primary_translation[ticket][follow_ups][]	array of objects (TicketFollowUp)	*
data.primary_translation[ticket][follow_ups][][id]	integer	*	The unique ID.
data.primary_translation[ticket][follow_ups][][person]	integer id (Person)	*
data.primary_translation[ticket][follow_ups][][actions]	array	*
data.primary_translation[ticket][follow_ups][][cancel_if_user_reply]	boolean	*
data.primary_translation[ticket][follow_ups][][cancel_if_agent_reply]	boolean	*
data.primary_translation[ticket][follow_ups][][status]	string	*
data.primary_translation[ticket][follow_ups][][date_created]	DateTime	*
data.primary_translation[ticket][follow_ups][][date_to_run]	DateTime	*
data.primary_translation[ticket][follow_ups][][date_did_run]	DateTime	*
data.primary_translation[ticket][logs][]	array of objects (TicketLog)	*
data.primary_translation[ticket][logs][][id]	integer	*
data.primary_translation[ticket][logs][][parent]	object (TicketLog)	*
data.primary_translation[ticket][logs][][ticket]	object (Ticket)	*
data.primary_translation[ticket][logs][][person]	object (Person)	*
data.primary_translation[ticket][logs][][action_type]	string	*
data.primary_translation[ticket][logs][][id_object]	integer	*	If the log involves a specific thing in a ticket (eg a message that was moved), then that is this id.
data.primary_translation[ticket][logs][][id_before]	integer	*	The ID of the previous entity changed, or any other numeric value.
data.primary_translation[ticket][logs][][id_after]	integer	*	The ID of the new entity, or any other numeric value.
data.primary_translation[ticket][logs][][trigger_id]	integer	*	If the change was caused by a trigger, the trigger id. Note this is the integer ID (not a FK relation) so the record is kept even if the trigger itself is deleted.
data.primary_translation[ticket][logs][][escalation_id]	integer	*	If the change was caused by an escalation Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.primary_translation[ticket][logs][][macro_id]	integer	*	If the change was caused by an v2 macro Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.primary_translation[ticket][logs][][sla]	object (Sla)	*	If the change was caused by an SLA, the SLA.
data.primary_translation[ticket][logs][][sla][id]	integer	*	The unique ID.
data.primary_translation[ticket][logs][][sla][title]	string	*	SLA title.
data.primary_translation[ticket][logs][][sla][sla_type]	string	*	Type of SLA - first_response, resolution, waiting_time.
data.primary_translation[ticket][logs][][sla][active_time]	string	*	Whether active all the time (all) or during work hours only (work_hours) or use the default ticket-wide settings (default).
data.primary_translation[ticket][logs][][sla][work_start]	integer	*	When the work day starts. This is stored as the number of seconds after 00:00:00.
data.primary_translation[ticket][logs][][sla][work_end]	integer	*	When the work day ends. This is stored as the number of seconds after 00:00:00.
data.primary_translation[ticket][logs][][sla][work_days]	array	*	Array of work days, stored with keys corresponding to day numbers. Values are true. 0 = Sunday, 6 = Saturday (same as PHP, easy to convert to MySQL which is 1 = Sunday, 7 = Saturday).
data.primary_translation[ticket][logs][][sla][work_timezone]	string	*	Timezone for work hours/days to be considered in.
data.primary_translation[ticket][logs][][sla][work_holidays]	array	*	List of work holidays.
data.primary_translation[ticket][logs][][sla][apply_type]	string	*	Controls how the SLA is applied to tickets: all, terms, terms_before_triggers, manual.
data.primary_translation[ticket][logs][][sla][apply_terms]	object (TriggerTerms)	*	Conditions to apply.
data.primary_translation[ticket][logs][][sla][apply_terms][version]	integer	*	Terms version.
data.primary_translation[ticket][logs][][sla][apply_terms][terms]	array	*	Terms themselves.
data.primary_translation[ticket][logs][][sla][trigger_terms]	object (TriggerTerms)	*	Conditions to consider sla completed.
data.primary_translation[ticket][logs][][sla][warn_time]	integer	*	Warn time integer.
data.primary_translation[ticket][logs][][sla][warn_time_unit]	string	*	And it's unit (see warn time).
data.primary_translation[ticket][logs][][sla][warn_actions]	object (TriggerActions)	*	How to warn about SLA will fail.
data.primary_translation[ticket][logs][][sla][warn_actions][version]	integer	*	Actions version.
data.primary_translation[ticket][logs][][sla][warn_actions][actions]	array	*	Actions array representation.
data.primary_translation[ticket][logs][][sla][fail_time]	integer	*	Fail time integer.
data.primary_translation[ticket][logs][][sla][fail_time_unit]	string	*	And it's measuring unit (see fail_time).
data.primary_translation[ticket][logs][][sla][fail_actions]	object (TriggerActions)	*	What to do if SLA failed.
data.primary_translation[ticket][logs][][sla][exclude_ticket_statuses]	array	*	This SLA will not apply while tickets are in these pending statuses.
data.primary_translation[ticket][logs][][sla_status]	string	*
data.primary_translation[ticket][logs][][details]	array	*
data.primary_translation[ticket][logs][][date_created]	DateTime	*
data.primary_translation[ticket][chats][]	array of objects (ChatConversation)	*
data.primary_translation[ticket][created_with_channel]	string	*
data.primary_translation[ticket][last_channel_used]	string	*
data.primary_translation[ticket][channels]	array	*
data.primary_translation[ticket][pending_articles][]	array of objects (ArticlePendingCreate)	*
data.primary_translation[ticket][pending_articles][][id]	integer	*
data.primary_translation[ticket][pending_articles][][person]	integer id (Person)	*
data.primary_translation[ticket][pending_articles][][assigned_person]	integer id (Person)	*
data.primary_translation[ticket][pending_articles][][ticket]	integer id (Ticket)	*
data.primary_translation[ticket][pending_articles][][message]	integer id (TicketMessage)	*
data.primary_translation[ticket][pending_articles][][comment]	string	*
data.primary_translation[ticket][pending_articles][][date_created]	DateTime	*
data.primary_translation[ticket][summary]	object (TicketSummary)	*
data.primary_translation[ticket][summary][id]	integer	*
data.primary_translation[ticket][summary][ticket]	object (Ticket)	*
data.primary_translation[ticket][summary][summary]	string	*
data.primary_translation[ticket][summary][summary_input]	string	*
data.primary_translation[ticket][summary][date_created]	DateTime	*
data.primary_translation[ticket_message]	object (TicketMessage)	*
data.primary_translation[ticket_message][id]	integer	*	The unique id of message.
data.primary_translation[ticket_message][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data.primary_translation[ticket_message][person]	object (Person)	*	Person this message was sent by.
data.primary_translation[ticket_message][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data.primary_translation[ticket_message][email_source][id]	integer	*
data.primary_translation[ticket_message][email_source][uuid]	string	*
data.primary_translation[ticket_message][email_source][blob]	object (Blob)	*
data.primary_translation[ticket_message][email_source][blob][sys_name]	string	*	A unique system name for the blob.
data.primary_translation[ticket_message][email_source][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.primary_translation[ticket_message][email_source][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.primary_translation[ticket_message][email_source][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.primary_translation[ticket_message][email_source][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.primary_translation[ticket_message][email_source][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.primary_translation[ticket_message][email_source][blob][file_url]	string	*	The HTTP link to download the file.
data.primary_translation[ticket_message][email_source][blob][authcode]	string	*
data.primary_translation[ticket_message][email_source][blob][blob_hash]	string	*
data.primary_translation[ticket_message][email_source][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.primary_translation[ticket_message][email_source][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.primary_translation[ticket_message][email_source][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.primary_translation[ticket_message][email_source][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.primary_translation[ticket_message][email_source][blob][date_created]	DateTime	*
data.primary_translation[ticket_message][email_source][blob][is_temp]	boolean	*
data.primary_translation[ticket_message][email_source][blob][source_ref]	string	*
data.primary_translation[ticket_message][email_source][blob][labels][]	array of objects (LabelBlob)	*
data.primary_translation[ticket_message][email_source][blob][labels][][blob]	object (Blob)	*
data.primary_translation[ticket_message][email_source][object_type]	string	*	The type of object this is attached to (should be the table name of the super type, eg: tickets, people, organizations). This typically is not set until after the email is processed (ie the status is 'processed').
data.primary_translation[ticket_message][email_source][object_id]	integer	*	The ID of the object this is attached to.
data.primary_translation[ticket_message][email_source][from_email]	string	*
data.primary_translation[ticket_message][email_source][status]	string	*	The current status of the message: - inserted: Only inserted - processing: Currently processing - complete: Fully processed - error: Tried to process but there was some kind of error (see error_code).
data.primary_translation[ticket_message][email_source][date_status]	DateTime	*
data.primary_translation[ticket_message][email_source][error_code]	string	*	When status is error, this is the code that describes the error.
data.primary_translation[ticket_message][email_source][date_created]	DateTime	*
data.primary_translation[ticket_message][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.primary_translation[ticket_message][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.primary_translation[ticket_message][date_created]	DateTime	*	Date when message was created.
data.primary_translation[ticket_message][is_agent_note]	boolean	*	Is this message agent note?
data.primary_translation[ticket_message][is_hidden]	boolean	*	Is this message hidden?
data.primary_translation[ticket_message][creation_system]	string	*	How this message was created.
data.primary_translation[ticket_message][ip_address]	string	*	An ip address from which message was sent.
data.primary_translation[ticket_message][visitor_id]	string	*	Unique ID of visitor left this message.
data.primary_translation[ticket_message][hostname]	string	*	Host from which message was left.
data.primary_translation[ticket_message][geo_country]	string	*	Country message is from (deprecated).
data.primary_translation[ticket_message][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.primary_translation[ticket_message][message_hash]	string	*	An unique hash of message.
data.primary_translation[ticket_message][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.primary_translation[ticket_message][message]	string	*	The message, will be in HTML!
data.primary_translation[ticket_message][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.primary_translation[ticket_message][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.primary_translation[ticket_message][message_source]	string	*	The message source.
data.primary_translation[ticket_message][message_source_type]	string	*	The message source type.
data.primary_translation[ticket_message][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.primary_translation[ticket_message][lang_code]	string	*	The set/detected lang code.
data.primary_translation[ticket_message][email_message_id][]	array of objects (TicketMessageEmailId)	*
data.primary_translation[ticket_message][email_message_id][][id]	integer	*
data.primary_translation[ticket_message][email_message_id][][message]	object (TicketMessage)	*
data.primary_translation[ticket_message][email_message_id][][email_id]	string	*
data.primary_translation[ticket_message][ticket_feedback][]	array of objects (TicketFeedback)	*
data.primary_translation[ticket_message][ticket_feedback][][id]	integer	*
data.primary_translation[ticket_message][ticket_feedback][][ticket]	object (Ticket)	*
data.primary_translation[ticket_message][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data.primary_translation[ticket_message][ticket_feedback][][person]	object (Person)	*
data.primary_translation[ticket_message][ticket_feedback][][rating]	integer	*
data.primary_translation[ticket_message][ticket_feedback][][message]	string	*
data.primary_translation[ticket_message][ticket_feedback][][date_created]	DateTime	*
data.primary_translation[ticket_message][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data.primary_translation[ticket_message][ticket_message_forwards][][id]	integer	*
data.primary_translation[ticket_message][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data.primary_translation[ticket_message][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data.primary_translation[ticket_message][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data.primary_translation[ticket_message][ticket_message_forwards][][subject]	string	*
data.primary_translation[ticket_message][ticket_message_forwards][][from_email]	string	*
data.primary_translation[ticket_message][ticket_message_forwards][][tos]	array	*
data.primary_translation[ticket_message][ticket_message_forwards][][ccs]	array	*
data.primary_translation[ticket_message][ticket_message_forwards][][bccs]	array	*
data.primary_translation[ticket_message][ticket_message_forwards][][message]	string	*
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][authcode]	string	*
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][blob_hash]	string	*
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][source_ref]	string	*
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data.primary_translation[ticket_message][ticket_message_forwards][][date_created]	DateTime	*
data.primary_translation[ticket_message][channel_message]	object (TicketMessageChannelMessage)	*
data.primary_translation[ticket_message][channel_message][id]	integer	*	@var int The unique id of message.
data.primary_translation[ticket_message][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data.primary_translation[ticket_message][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data.primary_translation[ticket_message][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data.primary_translation[ticket_message][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data.primary_translation[ticket_message][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data.primary_translation[ticket_message][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data.primary_translation[ticket_message][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data.primary_translation[ticket_message][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data.primary_translation[ticket_message][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data.primary_translation[from_lang_code]	string	*
data.primary_translation[lang_code]	string	*
data.primary_translation[message]	string	*
data.primary_translation[date_created]	DateTime	*
data.id	integer	*	The unique id of message.
data.ticket	object (Ticket)	*	Ticket with which this message is associated.
data.ticket[id]	integer	*
data.ticket[ref]	string	*
data.ticket[auth]	string	*
data.ticket[parent_ticket]	object (Ticket)	*	Parent ticket.
data.ticket[children_tickets][]	array of objects (Ticket)	*
data.ticket[language]	object (Language)	*	The language the ticket is in.
data.ticket[language][id]	integer	*	The unique ID.
data.ticket[language][sys_name]	string	*	The unique sys name assigned to the language.
data.ticket[language][title]	string	*	Title of the language.
data.ticket[language][title_local]	string	*	Title of the language.
data.ticket[language][base_filepath]	string	*	The base filepath for default phrases for this lang.
data.ticket[language][locale]	string	*	The locale code.
data.ticket[language][flag_image]	string	*	String path to image.
data.ticket[language][is_rtl]	boolean	*	True if this is a right-to-left language.
data.ticket[language][has_user]	boolean	*	True if has user.
data.ticket[language][has_agent]	boolean	*	True if has agent.
data.ticket[language][has_admin]	boolean	*	True if has admin.
data.ticket[language][plural_categories][]	array of strings	*
data.ticket[language][plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data.ticket[language][flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`
data.ticket[brand]	object (Brand)	*
data.ticket[brand][id]	integer	*	The unique ID.
data.ticket[brand][name]	string	*	The brand name.
data.ticket[brand][slug]	string	*
data.ticket[brand][url]	string	*	The brand url.
data.ticket[brand][theme_set]	object (ThemeSet)	*
data.ticket[brand][theme_set][id]	integer	*
data.ticket[brand][theme_set][theme_id]	string	*
data.ticket[brand][theme_set][title]	string	*
data.ticket[brand][theme_set][options]		*
data.ticket[brand][edit_theme_set]	object (ThemeSet)	*
data.ticket[brand][departments][]	array of objects (Department)	*
data.ticket[brand][departments][][id]	integer	*
data.ticket[brand][departments][][parent]	object (Department)	*
data.ticket[brand][departments][][children][]	array of objects (Department)	*
data.ticket[brand][departments][][title]	string	*
data.ticket[brand][departments][][user_title]	string	*
data.ticket[brand][departments][][is_tickets_enabled]	boolean	*
data.ticket[brand][departments][][is_chat_enabled]	boolean	*
data.ticket[brand][departments][][display_order]	integer	*
data.ticket[brand][departments][][avatar]	object (Blob)	*
data.ticket[brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.ticket[brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.ticket[brand][departments][][avatar][authcode]	string	*
data.ticket[brand][departments][][avatar][blob_hash]	string	*
data.ticket[brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[brand][departments][][avatar][date_created]	DateTime	*
data.ticket[brand][departments][][avatar][is_temp]	boolean	*
data.ticket[brand][departments][][avatar][source_ref]	string	*
data.ticket[brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.ticket[brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.ticket[brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.ticket[brand][departments][][brands][]	array of objects (Brand)	*
data.ticket[brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.ticket[brand][departments][][permissions][][department]	integer id (Department)	*
data.ticket[brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.ticket[brand][departments][][permissions][][name]	string	*	The name of the permission.
data.ticket[brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.ticket[brand][departments][][permissions][][is_active]	boolean	*
data.ticket[brand][departments][][chat_queue]	object (UserChatQueue)	*
data.ticket[brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.ticket[brand][departments][][chat_queue][name]	string	*
data.ticket[brand][departments][][chat_queue][routing_model]	string	*
data.ticket[brand][departments][][chat_queue][answer_timeout]	integer	*
data.ticket[brand][departments][][chat_queue][is_all_agents]	boolean	*
data.ticket[brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.ticket[brand][departments][][chat_queue][max_queue_size]	integer	*
data.ticket[brand][departments][][chat_queue][routingModel]		*
data.ticket[brand][theme_sets][]	array of objects (ThemeSet)	*
data.ticket[department]	object (Department)	*
data.ticket[department][id]	integer	*
data.ticket[department][parent]	object (Department)	*
data.ticket[department][children][]	array of objects (Department)	*
data.ticket[department][title]	string	*
data.ticket[department][user_title]	string	*
data.ticket[department][is_tickets_enabled]	boolean	*
data.ticket[department][is_chat_enabled]	boolean	*
data.ticket[department][display_order]	integer	*
data.ticket[department][avatar]	object (Blob)	*
data.ticket[department][avatar][sys_name]	string	*	A unique system name for the blob.
data.ticket[department][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[department][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[department][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[department][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[department][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[department][avatar][file_url]	string	*	The HTTP link to download the file.
data.ticket[department][avatar][authcode]	string	*
data.ticket[department][avatar][blob_hash]	string	*
data.ticket[department][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[department][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[department][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[department][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[department][avatar][date_created]	DateTime	*
data.ticket[department][avatar][is_temp]	boolean	*
data.ticket[department][avatar][source_ref]	string	*
data.ticket[department][avatar][labels][]	array of objects (LabelBlob)	*
data.ticket[department][avatar][labels][][blob]	object (Blob)	*
data.ticket[department][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.ticket[department][brands][]	array of objects (Brand)	*
data.ticket[department][permissions][]	array of objects (DepartmentPermission)	*
data.ticket[department][permissions][][department]	integer id (Department)	*
data.ticket[department][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.ticket[department][permissions][][name]	string	*	The name of the permission.
data.ticket[department][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.ticket[department][permissions][][is_active]	boolean	*
data.ticket[department][chat_queue]	object (UserChatQueue)	*
data.ticket[department][chat_queue][id]	integer	*	The unique ID.
data.ticket[department][chat_queue][name]	string	*
data.ticket[department][chat_queue][routing_model]	string	*
data.ticket[department][chat_queue][answer_timeout]	integer	*
data.ticket[department][chat_queue][is_all_agents]	boolean	*
data.ticket[department][chat_queue][departments][]	array of objects (Department)	*
data.ticket[department][chat_queue][max_queue_size]	integer	*
data.ticket[category]	object (TicketCategory)	*
data.ticket[category][id]	integer	*	The unique ID.
data.ticket[category][parent]	integer id (TicketCategory)	*	This category parent.
data.ticket[category][title]	string	*	Category title.
data.ticket[category][display_order]	integer	*	Obviously it's display order for lists.
data.ticket[priority]	object (TicketPriority)	*
data.ticket[priority][id]	integer	*	The unique ID.
data.ticket[priority][title]	string	*	Priority title.
data.ticket[priority][priority]	integer	*	The priority itself.
data.ticket[workflow]	object (TicketWorkflow)	*
data.ticket[workflow][id]	integer	*	The unique ID.
data.ticket[workflow][title]	string	*	Workflow title.
data.ticket[workflow][display_order]	integer	*	Workflow display order.
data.ticket[product]	object (Product)	*
data.ticket[product][parent]	integer id (Product)	*	Parent of the product.
data.ticket[product][title]		*
data.ticket[person]	object (Person)	*
data.ticket[person_email]	object (PersonEmail)	*
data.ticket[person_email][id]	integer	*	The unique ID.
data.ticket[person_email][person]	integer id (Person)	*	Person owner of email.
data.ticket[person_email][email]	string	*	The email address.
data.ticket[person_email][email_domain]	string	*	The email address domain.
data.ticket[person_email][is_validated]	boolean	*	True if validation passed.
data.ticket[person_email][date_created]	DateTime	*	The original time the email was created.
data.ticket[agent]	object (Person)	*
data.ticket[agent_team]	object (AgentTeam)	*
data.ticket[agent_team][id]	integer	*	The unique ID.
data.ticket[agent_team][name]	string	*	The name of agent team.
data.ticket[agent_team][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.ticket[agent_team][members]		*
data.ticket[organization]	object (Organization)	*
data.ticket[organization][id]	integer	*	The unique ID.
data.ticket[organization][picture_blob]	object (Blob)	*	The org picture.
data.ticket[organization][picture_blob][sys_name]	string	*	A unique system name for the blob.
data.ticket[organization][picture_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[organization][picture_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[organization][picture_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[organization][picture_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[organization][picture_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[organization][picture_blob][file_url]	string	*	The HTTP link to download the file.
data.ticket[organization][picture_blob][authcode]	string	*
data.ticket[organization][picture_blob][blob_hash]	string	*
data.ticket[organization][picture_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[organization][picture_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[organization][picture_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[organization][picture_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[organization][picture_blob][date_created]	DateTime	*
data.ticket[organization][picture_blob][is_temp]	boolean	*
data.ticket[organization][picture_blob][source_ref]	string	*
data.ticket[organization][picture_blob][labels][]	array of objects (LabelBlob)	*
data.ticket[organization][picture_blob][labels][][blob]	object (Blob)	*
data.ticket[organization][icon_property]	object (IconProperty)	*
data.ticket[organization][icon_property][urn]	string	*
data.ticket[organization][icon_property][options]	array	*
data.ticket[organization][name]	string	*	The organization name.
data.ticket[organization][summary]	string	*	The summary field as filled in by agents.
data.ticket[organization][importance]	integer	*	The org importance.
data.ticket[organization][custom_data][]	array of objects (CustomDataOrganization)	*
data.ticket[organization][custom_data][][organization]	object (Organization)	*
data.ticket[organization][custom_data][][field]	object (CustomDefOrganization)	*
data.ticket[organization][custom_data][][field][parent]	object (CustomDefOrganization)	*	Field`s parent.
data.ticket[organization][custom_data][][field][children][]	array of objects (CustomDefOrganization)	*	Field children.
data.ticket[organization][custom_data][][field][title]		*
data.ticket[organization][custom_data][][root_field]	object (CustomDefOrganization)	*
data.ticket[organization][usergroups][]	array of objects (Usergroup)	*	Usergroups the user belongs to.
data.ticket[organization][usergroups][][id]	integer	*	The unique ID, DB-generated.
data.ticket[organization][usergroups][][title]	string	*	Title of the usergroup.
data.ticket[organization][usergroups][][note]	string	*	A note or description about the usergroup.
data.ticket[organization][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.ticket[organization][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.ticket[organization][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.ticket[organization][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.ticket[organization][usergroups][][permissions][][id]	integer	*	The unique ID.
data.ticket[organization][usergroups][][permissions][][name]	string	*	The name of the permission.
data.ticket[organization][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.ticket[organization][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.ticket[organization][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.ticket[organization][usergroups][][department_permissions][][department]	integer id (Department)	*
data.ticket[organization][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.ticket[organization][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.ticket[organization][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.ticket[organization][usergroups][][department_permissions][][is_active]	boolean	*
data.ticket[organization][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.ticket[organization][auto_cc_people][]	array of objects (Person)	*	Users who are set to automatically be added to tickets and other org things.
data.ticket[organization][labels][]	array of objects (LabelOrganization)	*
data.ticket[organization][labels][][organization]	object (Organization)	*
data.ticket[organization][contact_data][]	array of objects (OrganizationContactData)	*
data.ticket[organization][contact_data][][organization]		*
data.ticket[organization][contact_data][][contact_type]		*
data.ticket[organization][contact_data][][comment]		*
data.ticket[organization][contact_data][][field_1]		*
data.ticket[organization][contact_data][][field_2]		*
data.ticket[organization][contact_data][][field_3]		*
data.ticket[organization][contact_data][][field_5]		*
data.ticket[organization][contact_data][][field_9]		*
data.ticket[organization][emails][]	array of objects (OrganizationEmail)	*
data.ticket[organization][emails][][id]	integer	*	The unique log id.
data.ticket[organization][emails][][organization]	object (Organization)	*
data.ticket[organization][emails][][email]	string	*
data.ticket[organization][emails][][date_created]	DateTime	*
data.ticket[organization][email_domains][]	array of objects (OrganizationEmailDomain)	*
data.ticket[organization][email_domains][][domain]	string	*	The email domain.
data.ticket[organization][email_domains][][organization]	object (Organization)	*	The users organization.
data.ticket[organization][date_created]	DateTime	*	The date the org was inserted into the system.
data.ticket[organization][members][]	array of objects (Person)	*
data.ticket[organization][parent]	object (Organization)	*
data.ticket[organization][children][]	array of objects (Organization)	*
data.ticket[organization][tickets][]	array of objects (Ticket)	*
data.ticket[organization][organization_members][]	array of objects (OrganizationMember)	*
data.ticket[organization][organization_members][][id]	integer	*
data.ticket[organization][organization_members][][person]	integer id (Person)	*
data.ticket[organization][organization_members][][organization]	integer id (Organization)	*
data.ticket[organization][organization_members][][is_manager]	boolean	*
data.ticket[organization][organization_members][][position]	string	*
data.ticket[organization][organization_members][][created_at]	DateTime	*
data.ticket[organization][organization_members][][updated_at]	DateTime	*
data.ticket[organization][publicUsergroups]		*
data.ticket[linked_chat]	object (ChatConversation)	*
data.ticket[linked_chat][id]	integer	*	The unique id of chat conversation.
data.ticket[linked_chat][department]	object (Department)	*	Department which chat was assigned.
data.ticket[linked_chat][brand]	object (Brand)	*	Department which chat was assigned.
data.ticket[linked_chat][task_id]	integer	*
data.ticket[linked_chat][ticket]	object (Ticket)	*
data.ticket[linked_chat][labels][]	array of objects (LabelChatConversation)	*
data.ticket[linked_chat][labels][][chat]	object (ChatConversation)	*
data.ticket[linked_chat][subject]	string	*	Subject of the chat conversation.
data.ticket[linked_chat][status]	string	*	Status of the chat conversation.
data.ticket[linked_chat][agent]	object (Person)	*	If this is a user conversation, this is the agent assigned.
data.ticket[linked_chat][agent_team]	object (AgentTeam)	*	If this is a team chat, the team it is.
data.ticket[linked_chat][person]	object (Person)	*	If this is a user conversation, this is the user who started the chat.
data.ticket[linked_chat][session]	object (Session)	*	If this is a user convo, this is the users session.
data.ticket[linked_chat][session][id]	integer	*	The unique ID.
data.ticket[linked_chat][session][auth]	string	*	The authcode for the session to verify an id.
data.ticket[linked_chat][session][interface]	string	*	The Interface the session is for.
data.ticket[linked_chat][session][person]	object (Person)	*
data.ticket[linked_chat][session][user_agent]	string	*	The users user agent string.
data.ticket[linked_chat][session][visitor_id]	string	*
data.ticket[linked_chat][session][ip_address]	string	*	The users IP address.
data.ticket[linked_chat][session][data]	string	*
data.ticket[linked_chat][session][is_person]	boolean	*
data.ticket[linked_chat][session][is_bot]	boolean	*
data.ticket[linked_chat][session][is_helpdesk]	boolean	*
data.ticket[linked_chat][session][active_status]	string	*	(Agents) Status (available or away).
data.ticket[linked_chat][session][is_chat_available]	boolean	*	(Agents) Wehn status is available, if they are available for chat.
data.ticket[linked_chat][session][date_created]	DateTime	*
data.ticket[linked_chat][session][date_last]	DateTime	*
data.ticket[linked_chat][session][date_last_page]	DateTime	*
data.ticket[linked_chat][visitor_id]	string	*
data.ticket[linked_chat][person_name]	string	*	User chat: The users name, if they arent a person.
data.ticket[linked_chat][person_email]	string	*	User chat: The users email, if they aren`t a person.
data.ticket[linked_chat][participants][]	array of objects (Person)	*
data.ticket[linked_chat][messages][]	array of objects (ChatMessage)	*
data.ticket[linked_chat][messages][][id]	integer	*	The unique ID.
data.ticket[linked_chat][messages][][author_id]	integer	*	Author id (legacy).
data.ticket[linked_chat][messages][][author_type]	string	*	Author type (legacy).
data.ticket[linked_chat][messages][][conversation_id]	integer	*	Conversation id (legacy).
data.ticket[linked_chat][messages][][author]	integer id (Person)	*	Person who created the message.
data.ticket[linked_chat][messages][][content]	string	*	The message.
data.ticket[linked_chat][messages][][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.ticket[linked_chat][messages][][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.ticket[linked_chat][messages][][is_html]	boolean	*	Is the content an HTML message?
data.ticket[linked_chat][messages][][metadata]	array	*	Additional data.
data.ticket[linked_chat][messages][][date_created]	DateTime	*	Date message was created.
data.ticket[linked_chat][messages][][date_received]	DateTime	*	Date message was received.
data.ticket[linked_chat][custom_data][]	array of objects (CustomDataChat)	*
data.ticket[linked_chat][custom_data][][conversation]	object (ChatConversation)	*	The conversation the message belongs to.
data.ticket[linked_chat][custom_data][][field]	object (CustomDefChat)	*
data.ticket[linked_chat][custom_data][][field][parent]	object (CustomDefChat)	*
data.ticket[linked_chat][custom_data][][field][children][]	array of objects (CustomDefChat)	*	Field children.
data.ticket[linked_chat][custom_data][][field][title]		*
data.ticket[linked_chat][custom_data][][root_field]	object (CustomDefChat)	*
data.ticket[linked_chat][rating_response_time]	integer	*
data.ticket[linked_chat][rating_overall]	integer	*
data.ticket[linked_chat][rating_comment]	string	*
data.ticket[linked_chat][is_agent]	boolean	*	Is this an agent chat.
data.ticket[linked_chat][is_window]	boolean	*	If the chat is popped out into a window. This is used to make sure the JS widget on pages doesn't load again.
data.ticket[linked_chat][date_created]	DateTime	*	Date when chat was started.
data.ticket[linked_chat][date_user_waiting]	DateTime	*	Since when the user has started waiting (i.e., time the assignment was 0).
data.ticket[linked_chat][date_assigned]	DateTime	*
data.ticket[linked_chat][date_agent_typing]	DateTime	*	Date when agent typed last time.
data.ticket[linked_chat][date_first_agent_message]	DateTime	*
data.ticket[linked_chat][date_ended]	DateTime	*	Date when chat was ended.
data.ticket[linked_chat][total_to_ended]	integer	*
data.ticket[linked_chat][ended_by]	string	*	Who ended the chat.
data.ticket[linked_chat][should_send_transcript]	boolean	*	True if transcript should be send.
data.ticket[linked_chat][date_transcript_sent]	DateTime	*	Date when transcript was sent.
data.ticket[linked_chat][email_validation_code]	string	*
data.ticket[linked_chat][email_validated]	boolean	*
data.ticket[linked_chat][access_token]	string	*
data.ticket[attachments][]	array of objects (TicketAttachment)	*
data.ticket[attachments][][id]	integer	*	The unique ID.
data.ticket[attachments][][ticket]	integer id (Ticket)	*	Ticket this attachment belongs to.
data.ticket[attachments][][person]	integer id (Person)	*	Who created the attachment.
data.ticket[attachments][][blob]	object (Blob)	*	Actual attachment.
data.ticket[attachments][][blob][sys_name]	string	*	A unique system name for the blob.
data.ticket[attachments][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[attachments][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[attachments][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[attachments][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[attachments][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[attachments][][blob][file_url]	string	*	The HTTP link to download the file.
data.ticket[attachments][][blob][authcode]	string	*
data.ticket[attachments][][blob][blob_hash]	string	*
data.ticket[attachments][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[attachments][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[attachments][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[attachments][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[attachments][][blob][date_created]	DateTime	*
data.ticket[attachments][][blob][is_temp]	boolean	*
data.ticket[attachments][][blob][source_ref]	string	*
data.ticket[attachments][][blob][labels][]	array of objects (LabelBlob)	*
data.ticket[attachments][][blob][labels][][blob]	object (Blob)	*
data.ticket[attachments][][message]	integer id (TicketMessage)	*	Message - holder of this attachment.
data.ticket[attachments][][is_agent_note]	boolean	*	True if this attachmen just a note.
data.ticket[attachments][][is_inline]	boolean	*	Is this attachment is embed in message.
data.ticket[access_codes][]	array of objects (TicketAccessCode)	*
data.ticket[access_codes][][id]	integer	*
data.ticket[access_codes][][ticket]	object (Ticket)	*
data.ticket[access_codes][][person]	object (Person)	*
data.ticket[access_codes][][auth]	string	*
data.ticket[messages][]	array of objects (TicketMessage)	*
data.ticket[messages][][id]	integer	*	The unique id of message.
data.ticket[messages][][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data.ticket[messages][][person]	object (Person)	*	Person this message was sent by.
data.ticket[messages][][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data.ticket[messages][][email_source][id]	integer	*
data.ticket[messages][][email_source][uuid]	string	*
data.ticket[messages][][email_source][blob]	object (Blob)	*
data.ticket[messages][][email_source][blob][sys_name]	string	*	A unique system name for the blob.
data.ticket[messages][][email_source][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[messages][][email_source][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[messages][][email_source][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[messages][][email_source][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[messages][][email_source][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[messages][][email_source][blob][file_url]	string	*	The HTTP link to download the file.
data.ticket[messages][][email_source][blob][authcode]	string	*
data.ticket[messages][][email_source][blob][blob_hash]	string	*
data.ticket[messages][][email_source][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[messages][][email_source][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[messages][][email_source][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[messages][][email_source][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[messages][][email_source][blob][date_created]	DateTime	*
data.ticket[messages][][email_source][blob][is_temp]	boolean	*
data.ticket[messages][][email_source][blob][source_ref]	string	*
data.ticket[messages][][email_source][blob][labels][]	array of objects (LabelBlob)	*
data.ticket[messages][][email_source][blob][labels][][blob]	object (Blob)	*
data.ticket[messages][][email_source][object_type]	string	*	The type of object this is attached to (should be the table name of the super type, eg: tickets, people, organizations). This typically is not set until after the email is processed (ie the status is 'processed').
data.ticket[messages][][email_source][object_id]	integer	*	The ID of the object this is attached to.
data.ticket[messages][][email_source][from_email]	string	*
data.ticket[messages][][email_source][status]	string	*	The current status of the message: - inserted: Only inserted - processing: Currently processing - complete: Fully processed - error: Tried to process but there was some kind of error (see error_code).
data.ticket[messages][][email_source][date_status]	DateTime	*
data.ticket[messages][][email_source][error_code]	string	*	When status is error, this is the code that describes the error.
data.ticket[messages][][email_source][date_created]	DateTime	*
data.ticket[messages][][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.ticket[messages][][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.ticket[messages][][snippet_use_logs][][id]	integer	*	The unique ID.
data.ticket[messages][][snippet_use_logs][][snippet]	object (SnippetV2)	*	Snippet used.
data.ticket[messages][][snippet_use_logs][][snippet][id]	integer	*
data.ticket[messages][][snippet_use_logs][][snippet][title]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][author]	object (Person)	*
data.ticket[messages][][snippet_use_logs][][snippet][is_private]	boolean	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar]	object (Blob)	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][sys_name]	string	*	A unique system name for the blob.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][file_url]	string	*	The HTTP link to download the file.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][authcode]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][blob_hash]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][date_created]	DateTime	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][is_temp]	boolean	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][source_ref]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][labels][]	array of objects (LabelBlob)	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][labels][][blob]	object (Blob)	*
data.ticket[messages][][snippet_use_logs][][snippet][status]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][shortcut_codes]	array	*
data.ticket[messages][][snippet_use_logs][][snippet][inline_translations]	array	*
data.ticket[messages][][snippet_use_logs][][snippet][translations][]	array of objects (SnippetV2Translation)	*
data.ticket[messages][][snippet_use_logs][][snippet][translations][][id]	integer	*	The unique ID.
data.ticket[messages][][snippet_use_logs][][snippet][translations][][snippet]	object (SnippetV2)	*	Snippet translated.
data.ticket[messages][][snippet_use_logs][][snippet][translations][][language]	object (Language)	*
data.ticket[messages][][snippet_use_logs][][snippet][translations][][content]	array	*	Snippet content.
data.ticket[messages][][snippet_use_logs][][snippet][translations][][blobs][]	array of objects (Blob)	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][]	array of objects (SnippetV2Category)	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][id]	integer	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][title]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][is_global]	boolean	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][display_order]	integer	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][parent]	object (SnippetV2Category)	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][agent_teams][]	array of objects (AgentTeam)	*
data.ticket[messages][][snippet_use_logs][][snippet][display_order]	integer	*
data.ticket[messages][][snippet_use_logs][][snippet][date_created]	DateTime	*
data.ticket[messages][][snippet_use_logs][][ticket_message]	object (TicketMessage)	*	Ticket Message where the snippet was used.
data.ticket[messages][][snippet_use_logs][][chat_message]	object (ChatMessage)	*	Chat Message where the snippet was used.
data.ticket[messages][][snippet_use_logs][][chat_message][id]	integer	*	The unique ID.
data.ticket[messages][][snippet_use_logs][][chat_message][author_id]	integer	*	Author id (legacy).
data.ticket[messages][][snippet_use_logs][][chat_message][author_type]	string	*	Author type (legacy).
data.ticket[messages][][snippet_use_logs][][chat_message][conversation_id]	integer	*	Conversation id (legacy).
data.ticket[messages][][snippet_use_logs][][chat_message][author]	integer id (Person)	*	Person who created the message.
data.ticket[messages][][snippet_use_logs][][chat_message][content]	string	*	The message.
data.ticket[messages][][snippet_use_logs][][chat_message][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.ticket[messages][][snippet_use_logs][][chat_message][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.ticket[messages][][snippet_use_logs][][chat_message][is_html]	boolean	*	Is the content an HTML message?
data.ticket[messages][][snippet_use_logs][][chat_message][metadata]	array	*	Additional data.
data.ticket[messages][][snippet_use_logs][][chat_message][date_created]	DateTime	*	Date message was created.
data.ticket[messages][][snippet_use_logs][][chat_message][date_received]	DateTime	*	Date message was received.
data.ticket[messages][][snippet_use_logs][][language]	object (Language)	*	Snippet translated.
data.ticket[messages][][snippet_use_logs][][person]	object (Person)	*
data.ticket[messages][][snippet_use_logs][][rating]	integer	*
data.ticket[messages][][snippet_use_logs][][rating_person]	object (Person)	*
data.ticket[messages][][snippet_use_logs][][rating_message]	string	*
data.ticket[messages][][snippet_use_logs][][date_created]	DateTime	*
data.ticket[messages][][date_created]	DateTime	*	Date when message was created.
data.ticket[messages][][is_agent_note]	boolean	*	Is this message agent note?
data.ticket[messages][][is_hidden]	boolean	*	Is this message hidden?
data.ticket[messages][][creation_system]	string	*	How this message was created.
data.ticket[messages][][ip_address]	string	*	An ip address from which message was sent.
data.ticket[messages][][visitor_id]	string	*	Unique ID of visitor left this message.
data.ticket[messages][][hostname]	string	*	Host from which message was left.
data.ticket[messages][][geo_country]	string	*	Country message is from (deprecated).
data.ticket[messages][][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.ticket[messages][][message_hash]	string	*	An unique hash of message.
data.ticket[messages][][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.ticket[messages][][primary_translation][id]	integer	*
data.ticket[messages][][primary_translation][ticket]	object (Ticket)	*
data.ticket[messages][][primary_translation][ticket_message]	object (TicketMessage)	*
data.ticket[messages][][primary_translation][from_lang_code]	string	*
data.ticket[messages][][primary_translation][lang_code]	string	*
data.ticket[messages][][primary_translation][message]	string	*
data.ticket[messages][][primary_translation][date_created]	DateTime	*
data.ticket[messages][][message]	string	*	The message, will be in HTML!
data.ticket[messages][][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.ticket[messages][][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.ticket[messages][][message_source]	string	*	The message source.
data.ticket[messages][][message_source_type]	string	*	The message source type.
data.ticket[messages][][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.ticket[messages][][lang_code]	string	*	The set/detected lang code.
data.ticket[messages][][email_message_id][]	array of objects (TicketMessageEmailId)	*
data.ticket[messages][][email_message_id][][id]	integer	*
data.ticket[messages][][email_message_id][][message]	object (TicketMessage)	*
data.ticket[messages][][email_message_id][][email_id]	string	*
data.ticket[messages][][ticket_feedback][]	array of objects (TicketFeedback)	*
data.ticket[messages][][ticket_feedback][][id]	integer	*
data.ticket[messages][][ticket_feedback][][ticket]	object (Ticket)	*
data.ticket[messages][][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data.ticket[messages][][ticket_feedback][][person]	object (Person)	*
data.ticket[messages][][ticket_feedback][][rating]	integer	*
data.ticket[messages][][ticket_feedback][][message]	string	*
data.ticket[messages][][ticket_feedback][][date_created]	DateTime	*
data.ticket[messages][][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data.ticket[messages][][ticket_message_forwards][][id]	integer	*
data.ticket[messages][][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data.ticket[messages][][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data.ticket[messages][][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data.ticket[messages][][ticket_message_forwards][][subject]	string	*
data.ticket[messages][][ticket_message_forwards][][from_email]	string	*
data.ticket[messages][][ticket_message_forwards][][tos]	array	*
data.ticket[messages][][ticket_message_forwards][][ccs]	array	*
data.ticket[messages][][ticket_message_forwards][][bccs]	array	*
data.ticket[messages][][ticket_message_forwards][][message]	string	*
data.ticket[messages][][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data.ticket[messages][][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data.ticket[messages][][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[messages][][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[messages][][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[messages][][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[messages][][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[messages][][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data.ticket[messages][][ticket_message_forwards][][blobs][][authcode]	string	*
data.ticket[messages][][ticket_message_forwards][][blobs][][blob_hash]	string	*
data.ticket[messages][][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[messages][][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[messages][][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[messages][][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[messages][][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data.ticket[messages][][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data.ticket[messages][][ticket_message_forwards][][blobs][][source_ref]	string	*
data.ticket[messages][][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data.ticket[messages][][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data.ticket[messages][][ticket_message_forwards][][date_created]	DateTime	*
data.ticket[messages][][channel_message]	object (TicketMessageChannelMessage)	*
data.ticket[messages][][channel_message][id]	integer	*	@var int The unique id of message.
data.ticket[messages][][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data.ticket[messages][][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data.ticket[messages][][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data.ticket[messages][][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data.ticket[messages][][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data.ticket[messages][][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data.ticket[messages][][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data.ticket[messages][][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data.ticket[messages][][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data.ticket[sms_messages][]	array of objects (TicketSms)	*
data.ticket[sms_messages][][id]	integer	*
data.ticket[sms_messages][][ticket]	object (Ticket)	*
data.ticket[sms_messages][][person]	object (Person)	*
data.ticket[sms_messages][][sms_account]	object (SmsAccount)	*
data.ticket[sms_messages][][sms_account][id]	integer	*	The unique ID.
data.ticket[sms_messages][][sms_account][type]	string	*
data.ticket[sms_messages][][sms_account][params]	array	*
data.ticket[sms_messages][][sms_account][identifier]	string	*
data.ticket[sms_messages][][sms_account][is_enabled]	boolean	*
data.ticket[sms_messages][][sms_account][is_connected]	boolean	*
data.ticket[sms_messages][][sms_account][is_tested]	boolean	*
data.ticket[sms_messages][][sms_account][test_code]	string	*
data.ticket[sms_messages][][job]	object (Job)	*
data.ticket[sms_messages][][job][id]	integer	*	The unique job id.
data.ticket[sms_messages][][job][type]	string	*	The job type, used by the Job Router to find the right Job Processor.
data.ticket[sms_messages][][job][status]	string	*	The status of the job.
data.ticket[sms_messages][][job][status_code]	string	*	Any code to further classify the status.
data.ticket[sms_messages][][job][date_touch]	DateTime	*	Date the last time a process "touched" this ticket.
data.ticket[sms_messages][][job][date_created]	DateTime	*	Date this job entered the "jobs" table.
data.ticket[sms_messages][][job][date_last_try]	DateTime	*	Last time we processed this job.
data.ticket[sms_messages][][job][date_next_try]	DateTime	*	If this DateTime is in the future, it won't be selected for execution.
data.ticket[sms_messages][][job][num_tries]	integer	*	The number of times this job has been executed Job Processor (usually indicated failures if > 1).
data.ticket[sms_messages][][job][log_summary]	string	*	A human readable summary of the job's execution.
data.ticket[sms_messages][][job][log]	string	*	A more verbose log.
data.ticket[sms_messages][][job][data]	array	*	An array of data, or payload, that the job processor needs to execute this job (stored in the db as json). This MUST always be an array, even if its an empty array
data.ticket[sms_messages][][job][original_job]	integer	*	Null unless the job was created as a retry - if so, the originating job ID is stored here so we can query it later. Note: You MUST specify the originating job, do not create a linked list of failed jobs.
data.ticket[sms_messages][][date_created]	DateTime	*
data.ticket[sms_messages][][from_number]	string	*	Permanent record of the phone number that sent this SMS. (Won't change even if Person changes their phone number).
data.ticket[sms_messages][][to_number]	string	*	Permanent record of the phone number that this SMS was sent to.
data.ticket[sms_messages][][message]	string	*	The SMS message.
data.ticket[sms_messages][][direction]	string	*	Just a system flag for reporting.
data.ticket[topic_links][]	array of objects (TicketCommunityTopicLink)	*
data.ticket[topic_links][][id]	integer	*	The unique filter ID.
data.ticket[topic_links][][ticket]	integer id (Ticket)	*
data.ticket[topic_links][][topic]	integer id (CommunityTopic)	*
data.ticket[topic_links][][person]	integer id (Person)	*
data.ticket[topic_links][][date_created]	DateTime	*
data.ticket[custom_data][]	array of objects (CustomDataTicket)	*
data.ticket[custom_data][][ticket]	object (Ticket)	*
data.ticket[custom_data][][field]	object (CustomDefTicket)	*
data.ticket[custom_data][][field][parent]	object (CustomDefTicket)	*
data.ticket[custom_data][][field][children][]	array of objects (CustomDefTicket)	*	Field children.
data.ticket[custom_data][][field][title]		*
data.ticket[custom_data][][root_field]	object (CustomDefTicket)	*
data.ticket[labels][]	array of objects (LabelTicket)	*
data.ticket[labels][][ticket]	object (Ticket)	*
data.ticket[sent_to_address]	string	*	The email address the ticket was sent to if it came in via a gateway. This is a full string (e.g., including CC's) of the original.
data.ticket[email_account]	object (EmailAccount)	*	The gateway this ticket originated from.
data.ticket[email_account][id]	integer	*
data.ticket[email_account][account_type]	string	*
data.ticket[email_account][is_enabled]	boolean	*
data.ticket[email_account][address]	string	*
data.ticket[email_account][cert_blob]	object (Blob)	*
data.ticket[email_account][cert_blob][sys_name]	string	*	A unique system name for the blob.
data.ticket[email_account][cert_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[email_account][cert_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[email_account][cert_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[email_account][cert_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[email_account][cert_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[email_account][cert_blob][file_url]	string	*	The HTTP link to download the file.
data.ticket[email_account][cert_blob][authcode]	string	*
data.ticket[email_account][cert_blob][blob_hash]	string	*
data.ticket[email_account][cert_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[email_account][cert_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[email_account][cert_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[email_account][cert_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[email_account][cert_blob][date_created]	DateTime	*
data.ticket[email_account][cert_blob][is_temp]	boolean	*
data.ticket[email_account][cert_blob][source_ref]	string	*
data.ticket[email_account][cert_blob][labels][]	array of objects (LabelBlob)	*
data.ticket[email_account][cert_blob][labels][][blob]	object (Blob)	*
data.ticket[email_account][key_blob]	object (Blob)	*
data.ticket[email_account_address]	string	*	The email address (from list of to/cc) that matched with the email account.
data.ticket[creation_system]	string	*
data.ticket[creation_system_option]	string	*	Optional information about the creation system. For example, source URL the ticket came from.
data.ticket[ticket_hash]	string	*
data.ticket[status]	string	*
data.ticket[ticket_status]	object (TicketStatus)	*
data.ticket[ticket_status][id]	integer	*
data.ticket[ticket_status][status_type]	string	*
data.ticket[ticket_status][status_code]	string	*
data.ticket[ticket_status][sys_id]	string	*
data.ticket[ticket_status][title]	string	*
data.ticket[ticket_status][display_order]	integer	*
data.ticket[ticket_status][pending_waiting_time_mode]	string	*	Where to count time spending in pending status. Check PENDING_WAITING_TIME_MODE_ constants
data.ticket[ticket_status][children][]	array of objects (TicketStatus)	*
data.ticket[ticket_status][options]	array	*
data.ticket[ticket_status][statusType]		*
data.ticket[ticket_status][displayOrder]	integer	*
data.ticket[urgency]	integer	*
data.ticket[feedback_rating]	integer	*
data.ticket[date_feedback_rating]	DateTime	*
data.ticket[date_created]	DateTime	*
data.ticket[date_resolved]	DateTime	*
data.ticket[date_archived]	DateTime	*
data.ticket[date_first_agent_assign]	DateTime	*
data.ticket[date_first_agent_reply]	DateTime	*
data.ticket[date_last_agent_reply]	DateTime	*
data.ticket[date_last_user_reply]	DateTime	*
data.ticket[date_agent_waiting]	DateTime	*
data.ticket[date_user_waiting]	DateTime	*
data.ticket[date_status]	DateTime	*
data.ticket[date_on_hold]	DateTime	*
data.ticket[total_user_waiting]	integer	*
data.ticket[total_to_first_reply]	integer	*
data.ticket[total_user_waiting_wh_start]	DateTime	*
data.ticket[total_user_waiting_wh]	integer	*
data.ticket[total_to_first_reply_wh]	integer	*
data.ticket[locked_by_agent]	object (Person)	*
data.ticket[date_locked]	DateTime	*
data.ticket[has_attachments]	boolean	*
data.ticket[subject]	string	*
data.ticket[original_subject]	string	*
data.ticket[properties]	array	*
data.ticket[count_agent_replies]	integer	*
data.ticket[count_user_replies]	integer	*
data.ticket[worst_sla_status]	string	*
data.ticket[waiting_times]	array	*	Used to track ticket status changes and how much time ticket was in status Add new item every time status changed This is optimisation over TicketLog.
data.ticket[participants][]	array of objects (TicketParticipant)	*
data.ticket[participants][][id]	integer	*
data.ticket[participants][][ticket]	object (Ticket)	*
data.ticket[participants][][person]	object (Person)	*
data.ticket[participants][][access_code]	object (TicketAccessCode)	*
data.ticket[participants][][person_email]	object (PersonEmail)	*
data.ticket[participants][][default_on]	boolean	*	Default checkbox status of the user.
data.ticket[charges][]	array of objects (TicketCharge)	*
data.ticket[charges][][id]	integer	*
data.ticket[charges][][charge_time]	integer	*
data.ticket[charges][][amount]	float	*
data.ticket[charges][][date_created]	DateTime	*
data.ticket[charges][][ticket]	object (Ticket)	*
data.ticket[charges][][person]	object (Person)	*
data.ticket[charges][][organization]	object (Organization)	*
data.ticket[charges][][agent]	object (Person)	*
data.ticket[charges][][custom_data][]	array of objects (CustomDataBilling)	*
data.ticket[charges][][custom_data][][ticket_charge]	object (TicketCharge)	*
data.ticket[charges][][custom_data][][field]	object (CustomDefBilling)	*
data.ticket[charges][][custom_data][][field][parent]	object (CustomDefBilling)	*
data.ticket[charges][][custom_data][][field][children][]	array of objects (CustomDefBilling)	*	Field children.
data.ticket[charges][][custom_data][][field][title]		*
data.ticket[charges][][custom_data][][root_field]	object (CustomDefBilling)	*
data.ticket[ticket_slas][]	array of objects (TicketSla)	*
data.ticket[ticket_slas][][id]	integer	*	The unique ID.
data.ticket[ticket_slas][][sla_status]	string	*	The SLA status.
data.ticket[ticket_slas][][warn_date]	DateTime	*	The SLA warn date.
data.ticket[ticket_slas][][fail_date]	DateTime	*	The SLA fail date.
data.ticket[ticket_slas][][is_completed]	boolean	*	Is the SLA completed?
data.ticket[ticket_slas][][is_completed_set]	boolean	*	Completed by automated action.
data.ticket[ticket_slas][][completed_time_taken]	integer	*	Time taken.
data.ticket[ticket_slas][][ticket]	integer id (Ticket)	*	Ticket.
data.ticket[ticket_slas][][sla]	integer id (Sla)	*	SLA.
data.ticket[ticket_slas][][date_applied]	DateTime	*	time and date when SLA was applied to the ticket.
data.ticket[ticket_slas][][date_completed]	DateTime	*	time when SLA status became OK.
data.ticket[jira_issues][]	array of objects (JiraIssue)	*	linked jira issues.
data.ticket[jira_issues][][id]	integer	*	The unique ID.
data.ticket[jira_issues][][ticket]	object (Ticket)	*	The associated DeskPRO ticket.
data.ticket[jira_issues][][issue_id]	integer	*
data.ticket[jira_issues][][status_id]	integer	*
data.ticket[jira_issues][][created]	DateTime	*	Export time.
data.ticket[problems][]	array of objects (Problem)	*
data.ticket[problems][][id]	integer	*	The unique ID.
data.ticket[problems][][title]	string	*	Problem title.
data.ticket[problems][][creator]	integer id (Person)	*	Person who created the problem.
data.ticket[problems][][created]	DateTime	*	Date when the problem was created.
data.ticket[problems][][is_open]	boolean	*	Is problem still has no solution?
data.ticket[problems][][tickets][]	array of integer ids (Ticket)	*	Tickets associated with problem.
data.ticket[stars][]	array of objects (TicketFlagged)	*
data.ticket[stars][][ticket]	object (Ticket)	*
data.ticket[stars][][person_id]	integer	*
data.ticket[stars][][color]	string	*
data.ticket[follow_ups][]	array of objects (TicketFollowUp)	*
data.ticket[follow_ups][][id]	integer	*	The unique ID.
data.ticket[follow_ups][][person]	integer id (Person)	*
data.ticket[follow_ups][][actions]	array	*
data.ticket[follow_ups][][cancel_if_user_reply]	boolean	*
data.ticket[follow_ups][][cancel_if_agent_reply]	boolean	*
data.ticket[follow_ups][][status]	string	*
data.ticket[follow_ups][][date_created]	DateTime	*
data.ticket[follow_ups][][date_to_run]	DateTime	*
data.ticket[follow_ups][][date_did_run]	DateTime	*
data.ticket[follow_ups][][dateToRun]		*
data.ticket[logs][]	array of objects (TicketLog)	*
data.ticket[logs][][id]	integer	*
data.ticket[logs][][parent]	object (TicketLog)	*
data.ticket[logs][][ticket]	object (Ticket)	*
data.ticket[logs][][person]	object (Person)	*
data.ticket[logs][][action_type]	string	*
data.ticket[logs][][id_object]	integer	*	If the log involves a specific thing in a ticket (eg a message that was moved), then that is this id.
data.ticket[logs][][id_before]	integer	*	The ID of the previous entity changed, or any other numeric value.
data.ticket[logs][][id_after]	integer	*	The ID of the new entity, or any other numeric value.
data.ticket[logs][][trigger_id]	integer	*	If the change was caused by a trigger, the trigger id. Note this is the integer ID (not a FK relation) so the record is kept even if the trigger itself is deleted.
data.ticket[logs][][escalation_id]	integer	*	If the change was caused by an escalation Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.ticket[logs][][macro_id]	integer	*	If the change was caused by an v2 macro Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.ticket[logs][][sla]	object (Sla)	*	If the change was caused by an SLA, the SLA.
data.ticket[logs][][sla][id]	integer	*	The unique ID.
data.ticket[logs][][sla][title]	string	*	SLA title.
data.ticket[logs][][sla][sla_type]	string	*	Type of SLA - first_response, resolution, waiting_time.
data.ticket[logs][][sla][active_time]	string	*	Whether active all the time (all) or during work hours only (work_hours) or use the default ticket-wide settings (default).
data.ticket[logs][][sla][work_start]	integer	*	When the work day starts. This is stored as the number of seconds after 00:00:00.
data.ticket[logs][][sla][work_end]	integer	*	When the work day ends. This is stored as the number of seconds after 00:00:00.
data.ticket[logs][][sla][work_days]	array	*	Array of work days, stored with keys corresponding to day numbers. Values are true. 0 = Sunday, 6 = Saturday (same as PHP, easy to convert to MySQL which is 1 = Sunday, 7 = Saturday).
data.ticket[logs][][sla][work_timezone]	string	*	Timezone for work hours/days to be considered in.
data.ticket[logs][][sla][work_holidays]	array	*	List of work holidays.
data.ticket[logs][][sla][apply_type]	string	*	Controls how the SLA is applied to tickets: all, terms, terms_before_triggers, manual.
data.ticket[logs][][sla][apply_terms]	object (TriggerTerms)	*	Conditions to apply.
data.ticket[logs][][sla][apply_terms][version]	integer	*	Terms version.
data.ticket[logs][][sla][apply_terms][terms]	array	*	Terms themselves.
data.ticket[logs][][sla][trigger_terms]	object (TriggerTerms)	*	Conditions to consider sla completed.
data.ticket[logs][][sla][warn_time]	integer	*	Warn time integer.
data.ticket[logs][][sla][warn_time_unit]	string	*	And it's unit (see warn time).
data.ticket[logs][][sla][warn_actions]	object (TriggerActions)	*	How to warn about SLA will fail.
data.ticket[logs][][sla][warn_actions][version]	integer	*	Actions version.
data.ticket[logs][][sla][warn_actions][actions]	array	*	Actions array representation.
data.ticket[logs][][sla][fail_time]	integer	*	Fail time integer.
data.ticket[logs][][sla][fail_time_unit]	string	*	And it's measuring unit (see fail_time).
data.ticket[logs][][sla][fail_actions]	object (TriggerActions)	*	What to do if SLA failed.
data.ticket[logs][][sla][exclude_ticket_statuses]	array	*	This SLA will not apply while tickets are in these pending statuses.
data.ticket[logs][][sla_status]	string	*
data.ticket[logs][][details]	array	*
data.ticket[logs][][date_created]	DateTime	*
data.ticket[chats][]	array of objects (ChatConversation)	*
data.ticket[created_with_channel]	string	*
data.ticket[last_channel_used]	string	*
data.ticket[channels]	array	*
data.ticket[pending_articles][]	array of objects (ArticlePendingCreate)	*
data.ticket[pending_articles][][id]	integer	*
data.ticket[pending_articles][][person]	integer id (Person)	*
data.ticket[pending_articles][][assigned_person]	integer id (Person)	*
data.ticket[pending_articles][][ticket]	integer id (Ticket)	*
data.ticket[pending_articles][][message]	integer id (TicketMessage)	*
data.ticket[pending_articles][][comment]	string	*
data.ticket[pending_articles][][date_created]	DateTime	*
data.ticket[summary]	object (TicketSummary)	*
data.ticket[summary][id]	integer	*
data.ticket[summary][ticket]	object (Ticket)	*
data.ticket[summary][summary]	string	*
data.ticket[summary][summary_input]	string	*
data.ticket[summary][date_created]	DateTime	*
data.person	object (Person)	*	Person this message was sent by.
data.person[emails]		*
data.person[labels]		*
data.person[teams]		*
data.person[primary_team]		*
data.person[agentData]		*
data.person[publicUsergroups]		*
data.person[publicAgentgroups]		*
data.email_source	object (EmailSource)	*	Info about email source, if message comes from such source.
data.email_source[id]	integer	*
data.email_source[uuid]	string	*
data.email_source[blob]	object (Blob)	*
data.email_source[blob][sys_name]	string	*	A unique system name for the blob.
data.email_source[blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.email_source[blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.email_source[blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.email_source[blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.email_source[blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.email_source[blob][file_url]	string	*	The HTTP link to download the file.
data.email_source[blob][authcode]	string	*
data.email_source[blob][blob_hash]	string	*
data.email_source[blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.email_source[blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.email_source[blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.email_source[blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.email_source[blob][date_created]	DateTime	*
data.email_source[blob][is_temp]	boolean	*
data.email_source[blob][source_ref]	string	*
data.email_source[blob][labels][]	array of objects (LabelBlob)	*
data.email_source[blob][labels][][blob]	object (Blob)	*
data.email_source[object_type]	string	*	The type of object this is attached to (should be the table name of the super type, eg: tickets, people, organizations). This typically is not set until after the email is processed (ie the status is 'processed').
data.email_source[object_id]	integer	*	The ID of the object this is attached to.
data.email_source[from_email]	string	*
data.email_source[status]	string	*	The current status of the message: - inserted: Only inserted - processing: Currently processing - complete: Fully processed - error: Tried to process but there was some kind of error (see error_code).
data.email_source[date_status]	DateTime	*
data.email_source[error_code]	string	*	When status is error, this is the code that describes the error.
data.email_source[date_created]	DateTime	*
data.date_created	DateTime	*	Date when message was created.
data.is_agent_note	boolean	*	Is this message agent note?
data.is_hidden	boolean	*	Is this message hidden?
data.creation_system	string	*	How this message was created.
data.ip_address	string	*	An ip address from which message was sent.
data.visitor_id	string	*	Unique ID of visitor left this message.
data.hostname	string	*	Host from which message was left.
data.geo_country	string	*	Country message is from (deprecated).
data.email	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.message_hash	string	*	An unique hash of message.
data.message	string	*	The message, will be in HTML!
data.message_full	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.message_raw	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.message_source	string	*	The message source.
data.message_source_type	string	*	The message source type.
data.show_full_hint	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.lang_code	string	*	The set/detected lang code.
data.email_message_id[]	array of objects (TicketMessageEmailId)	*
data.email_message_id[][id]	integer	*
data.email_message_id[][message]	object (TicketMessage)	*
data.email_message_id[][message][id]	integer	*	The unique id of message.
data.email_message_id[][message][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data.email_message_id[][message][person]	object (Person)	*	Person this message was sent by.
data.email_message_id[][message][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data.email_message_id[][message][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.email_message_id[][message][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.email_message_id[][message][date_created]	DateTime	*	Date when message was created.
data.email_message_id[][message][is_agent_note]	boolean	*	Is this message agent note?
data.email_message_id[][message][is_hidden]	boolean	*	Is this message hidden?
data.email_message_id[][message][creation_system]	string	*	How this message was created.
data.email_message_id[][message][ip_address]	string	*	An ip address from which message was sent.
data.email_message_id[][message][visitor_id]	string	*	Unique ID of visitor left this message.
data.email_message_id[][message][hostname]	string	*	Host from which message was left.
data.email_message_id[][message][geo_country]	string	*	Country message is from (deprecated).
data.email_message_id[][message][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.email_message_id[][message][message_hash]	string	*	An unique hash of message.
data.email_message_id[][message][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.email_message_id[][message][message]	string	*	The message, will be in HTML!
data.email_message_id[][message][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.email_message_id[][message][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.email_message_id[][message][message_source]	string	*	The message source.
data.email_message_id[][message][message_source_type]	string	*	The message source type.
data.email_message_id[][message][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.email_message_id[][message][lang_code]	string	*	The set/detected lang code.
data.email_message_id[][message][email_message_id][]	array of objects (TicketMessageEmailId)	*
data.email_message_id[][message][ticket_feedback][]	array of objects (TicketFeedback)	*
data.email_message_id[][message][ticket_feedback][][id]	integer	*
data.email_message_id[][message][ticket_feedback][][ticket]	object (Ticket)	*
data.email_message_id[][message][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data.email_message_id[][message][ticket_feedback][][person]	object (Person)	*
data.email_message_id[][message][ticket_feedback][][rating]	integer	*
data.email_message_id[][message][ticket_feedback][][message]	string	*
data.email_message_id[][message][ticket_feedback][][date_created]	DateTime	*
data.email_message_id[][message][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data.email_message_id[][message][ticket_message_forwards][][id]	integer	*
data.email_message_id[][message][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data.email_message_id[][message][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data.email_message_id[][message][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data.email_message_id[][message][ticket_message_forwards][][subject]	string	*
data.email_message_id[][message][ticket_message_forwards][][from_email]	string	*
data.email_message_id[][message][ticket_message_forwards][][tos]	array	*
data.email_message_id[][message][ticket_message_forwards][][ccs]	array	*
data.email_message_id[][message][ticket_message_forwards][][bccs]	array	*
data.email_message_id[][message][ticket_message_forwards][][message]	string	*
data.email_message_id[][message][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data.email_message_id[][message][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data.email_message_id[][message][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.email_message_id[][message][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.email_message_id[][message][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.email_message_id[][message][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.email_message_id[][message][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data.email_message_id[][message][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data.email_message_id[][message][ticket_message_forwards][][blobs][][authcode]	string	*
data.email_message_id[][message][ticket_message_forwards][][blobs][][blob_hash]	string	*
data.email_message_id[][message][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.email_message_id[][message][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data.email_message_id[][message][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data.email_message_id[][message][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data.email_message_id[][message][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data.email_message_id[][message][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data.email_message_id[][message][ticket_message_forwards][][blobs][][source_ref]	string	*
data.email_message_id[][message][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data.email_message_id[][message][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data.email_message_id[][message][ticket_message_forwards][][date_created]	DateTime	*
data.email_message_id[][message][channel_message]	object (TicketMessageChannelMessage)	*
data.email_message_id[][message][channel_message][id]	integer	*	@var int The unique id of message.
data.email_message_id[][message][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data.email_message_id[][message][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data.email_message_id[][message][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data.email_message_id[][message][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data.email_message_id[][message][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data.email_message_id[][message][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data.email_message_id[][message][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data.email_message_id[][message][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data.email_message_id[][message][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data.email_message_id[][email_id]	string	*
data.ticket_feedback[]	array of objects (TicketFeedback)	*
data.ticket_feedback[][id]	integer	*
data.ticket_feedback[][ticket]	object (Ticket)	*
data.ticket_feedback[][ticket_message]	object (TicketMessage)	*
data.ticket_feedback[][ticket_message][id]	integer	*	The unique id of message.
data.ticket_feedback[][ticket_message][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data.ticket_feedback[][ticket_message][person]	object (Person)	*	Person this message was sent by.
data.ticket_feedback[][ticket_message][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data.ticket_feedback[][ticket_message][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.ticket_feedback[][ticket_message][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.ticket_feedback[][ticket_message][date_created]	DateTime	*	Date when message was created.
data.ticket_feedback[][ticket_message][is_agent_note]	boolean	*	Is this message agent note?
data.ticket_feedback[][ticket_message][is_hidden]	boolean	*	Is this message hidden?
data.ticket_feedback[][ticket_message][creation_system]	string	*	How this message was created.
data.ticket_feedback[][ticket_message][ip_address]	string	*	An ip address from which message was sent.
data.ticket_feedback[][ticket_message][visitor_id]	string	*	Unique ID of visitor left this message.
data.ticket_feedback[][ticket_message][hostname]	string	*	Host from which message was left.
data.ticket_feedback[][ticket_message][geo_country]	string	*	Country message is from (deprecated).
data.ticket_feedback[][ticket_message][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.ticket_feedback[][ticket_message][message_hash]	string	*	An unique hash of message.
data.ticket_feedback[][ticket_message][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.ticket_feedback[][ticket_message][message]	string	*	The message, will be in HTML!
data.ticket_feedback[][ticket_message][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.ticket_feedback[][ticket_message][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.ticket_feedback[][ticket_message][message_source]	string	*	The message source.
data.ticket_feedback[][ticket_message][message_source_type]	string	*	The message source type.
data.ticket_feedback[][ticket_message][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.ticket_feedback[][ticket_message][lang_code]	string	*	The set/detected lang code.
data.ticket_feedback[][ticket_message][email_message_id][]	array of objects (TicketMessageEmailId)	*
data.ticket_feedback[][ticket_message][ticket_feedback][]	array of objects (TicketFeedback)	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][id]	integer	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][subject]	string	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][from_email]	string	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][tos]	array	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][ccs]	array	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][bccs]	array	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][message]	string	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][authcode]	string	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][blob_hash]	string	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][source_ref]	string	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][date_created]	DateTime	*
data.ticket_feedback[][ticket_message][channel_message]	object (TicketMessageChannelMessage)	*
data.ticket_feedback[][ticket_message][channel_message][id]	integer	*	@var int The unique id of message.
data.ticket_feedback[][ticket_message][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data.ticket_feedback[][ticket_message][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data.ticket_feedback[][ticket_message][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data.ticket_feedback[][ticket_message][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data.ticket_feedback[][ticket_message][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data.ticket_feedback[][ticket_message][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data.ticket_feedback[][ticket_message][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data.ticket_feedback[][ticket_message][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data.ticket_feedback[][ticket_message][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data.ticket_feedback[][person]	object (Person)	*
data.ticket_feedback[][rating]	integer	*
data.ticket_feedback[][message]	string	*
data.ticket_feedback[][date_created]	DateTime	*
data.ticket_message_forwards[]	array of objects (TicketMessageForward)	*
data.ticket_message_forwards[][id]	integer	*
data.ticket_message_forwards[][ticket_message]	object (TicketMessage)	*
data.ticket_message_forwards[][ticket_message][id]	integer	*	The unique id of message.
data.ticket_message_forwards[][ticket_message][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data.ticket_message_forwards[][ticket_message][person]	object (Person)	*	Person this message was sent by.
data.ticket_message_forwards[][ticket_message][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data.ticket_message_forwards[][ticket_message][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.ticket_message_forwards[][ticket_message][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.ticket_message_forwards[][ticket_message][date_created]	DateTime	*	Date when message was created.
data.ticket_message_forwards[][ticket_message][is_agent_note]	boolean	*	Is this message agent note?
data.ticket_message_forwards[][ticket_message][is_hidden]	boolean	*	Is this message hidden?
data.ticket_message_forwards[][ticket_message][creation_system]	string	*	How this message was created.
data.ticket_message_forwards[][ticket_message][ip_address]	string	*	An ip address from which message was sent.
data.ticket_message_forwards[][ticket_message][visitor_id]	string	*	Unique ID of visitor left this message.
data.ticket_message_forwards[][ticket_message][hostname]	string	*	Host from which message was left.
data.ticket_message_forwards[][ticket_message][geo_country]	string	*	Country message is from (deprecated).
data.ticket_message_forwards[][ticket_message][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.ticket_message_forwards[][ticket_message][message_hash]	string	*	An unique hash of message.
data.ticket_message_forwards[][ticket_message][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.ticket_message_forwards[][ticket_message][message]	string	*	The message, will be in HTML!
data.ticket_message_forwards[][ticket_message][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.ticket_message_forwards[][ticket_message][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.ticket_message_forwards[][ticket_message][message_source]	string	*	The message source.
data.ticket_message_forwards[][ticket_message][message_source_type]	string	*	The message source type.
data.ticket_message_forwards[][ticket_message][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.ticket_message_forwards[][ticket_message][lang_code]	string	*	The set/detected lang code.
data.ticket_message_forwards[][ticket_message][email_message_id][]	array of objects (TicketMessageEmailId)	*
data.ticket_message_forwards[][ticket_message][ticket_feedback][]	array of objects (TicketFeedback)	*
data.ticket_message_forwards[][ticket_message][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data.ticket_message_forwards[][ticket_message][channel_message]	object (TicketMessageChannelMessage)	*
data.ticket_message_forwards[][ticket_message][channel_message][id]	integer	*	@var int The unique id of message.
data.ticket_message_forwards[][ticket_message][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data.ticket_message_forwards[][ticket_message][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data.ticket_message_forwards[][ticket_message][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data.ticket_message_forwards[][ticket_message][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data.ticket_message_forwards[][ticket_message][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data.ticket_message_forwards[][ticket_message][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data.ticket_message_forwards[][ticket_message][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data.ticket_message_forwards[][ticket_message][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data.ticket_message_forwards[][ticket_message][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data.ticket_message_forwards[][new_ticket]	object (Ticket)	*
data.ticket_message_forwards[][new_ticket_message]	object (TicketMessage)	*
data.ticket_message_forwards[][subject]	string	*
data.ticket_message_forwards[][from_email]	string	*
data.ticket_message_forwards[][tos]	array	*
data.ticket_message_forwards[][ccs]	array	*
data.ticket_message_forwards[][bccs]	array	*
data.ticket_message_forwards[][message]	string	*
data.ticket_message_forwards[][blobs][]	array of objects (Blob)	*
data.ticket_message_forwards[][blobs][][sys_name]	string	*	A unique system name for the blob.
data.ticket_message_forwards[][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket_message_forwards[][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket_message_forwards[][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket_message_forwards[][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket_message_forwards[][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket_message_forwards[][blobs][][file_url]	string	*	The HTTP link to download the file.
data.ticket_message_forwards[][blobs][][authcode]	string	*
data.ticket_message_forwards[][blobs][][blob_hash]	string	*
data.ticket_message_forwards[][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket_message_forwards[][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket_message_forwards[][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket_message_forwards[][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket_message_forwards[][blobs][][date_created]	DateTime	*
data.ticket_message_forwards[][blobs][][is_temp]	boolean	*
data.ticket_message_forwards[][blobs][][source_ref]	string	*
data.ticket_message_forwards[][blobs][][labels][]	array of objects (LabelBlob)	*
data.ticket_message_forwards[][blobs][][labels][][blob]	object (Blob)	*
data.ticket_message_forwards[][date_created]	DateTime	*
data.channel_message	object (TicketMessageChannelMessage)	*
data.channel_message[id]	integer	*	@var int The unique id of message.
data.channel_message[ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data.channel_message[ticket_message][id]	integer	*	The unique id of message.
data.channel_message[ticket_message][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data.channel_message[ticket_message][person]	object (Person)	*	Person this message was sent by.
data.channel_message[ticket_message][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data.channel_message[ticket_message][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.channel_message[ticket_message][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.channel_message[ticket_message][date_created]	DateTime	*	Date when message was created.
data.channel_message[ticket_message][is_agent_note]	boolean	*	Is this message agent note?
data.channel_message[ticket_message][is_hidden]	boolean	*	Is this message hidden?
data.channel_message[ticket_message][creation_system]	string	*	How this message was created.
data.channel_message[ticket_message][ip_address]	string	*	An ip address from which message was sent.
data.channel_message[ticket_message][visitor_id]	string	*	Unique ID of visitor left this message.
data.channel_message[ticket_message][hostname]	string	*	Host from which message was left.
data.channel_message[ticket_message][geo_country]	string	*	Country message is from (deprecated).
data.channel_message[ticket_message][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.channel_message[ticket_message][message_hash]	string	*	An unique hash of message.
data.channel_message[ticket_message][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.channel_message[ticket_message][message]	string	*	The message, will be in HTML!
data.channel_message[ticket_message][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.channel_message[ticket_message][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.channel_message[ticket_message][message_source]	string	*	The message source.
data.channel_message[ticket_message][message_source_type]	string	*	The message source type.
data.channel_message[ticket_message][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.channel_message[ticket_message][lang_code]	string	*	The set/detected lang code.
data.channel_message[ticket_message][email_message_id][]	array of objects (TicketMessageEmailId)	*
data.channel_message[ticket_message][ticket_feedback][]	array of objects (TicketFeedback)	*
data.channel_message[ticket_message][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data.channel_message[ticket_message][channel_message]	object (TicketMessageChannelMessage)	*
data.channel_message[provider]	string	*	@var string name of the provider from the ticket-channel service
data.channel_message[platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data.channel_message[channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data.channel_message[message_id]	string	*	@var string ID of the message from the ticket-channel service
data.channel_message[message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data.channel_message[channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data.channel_message[message_type]	string	*	@var string name of the message type from the ticket-channel service
data.channel_message[created_at]	DateTime	*	@var \DateTime Date when channel message was created.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/tickets/{parentId}/messages/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_messages.count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/tickets/{parentId}/messages/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_messages.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/tickets/{parentId}/messages/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_messages.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Versions	Description
data.attachments[]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.attachments[][id]	integer	*	The unique ID.
data.attachments[][ticket]	integer id (Ticket)	*	Ticket this attachment belongs to.
data.attachments[][person]	integer id (Person)	*	Who created the attachment.
data.attachments[][blob]	object (Blob)	*	Actual attachment.
data.attachments[][blob][sys_name]	string	*	A unique system name for the blob.
data.attachments[][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.attachments[][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.attachments[][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.attachments[][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.attachments[][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.attachments[][blob][file_url]	string	*	The HTTP link to download the file.
data.attachments[][blob][authcode]	string	*
data.attachments[][blob][blob_hash]	string	*
data.attachments[][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.attachments[][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.attachments[][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.attachments[][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.attachments[][blob][date_created]	DateTime	*
data.attachments[][blob][is_temp]	boolean	*
data.attachments[][blob][source_ref]	string	*
data.attachments[][blob][labels][]	array of objects (LabelBlob)	*
data.attachments[][blob][labels][][blob]	object (Blob)	*
data.attachments[][message]	integer id (TicketMessage)	*	Message - holder of this attachment.
data.attachments[][is_agent_note]	boolean	*	True if this attachmen just a note.
data.attachments[][is_inline]	boolean	*	Is this attachment is embed in message.
data.snippet_use_logs[]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.snippet_use_logs[][id]	integer	*	The unique ID.
data.snippet_use_logs[][snippet]	object (SnippetV2)	*	Snippet used.
data.snippet_use_logs[][snippet][id]	integer	*
data.snippet_use_logs[][snippet][title]	string	*
data.snippet_use_logs[][snippet][author]	object (Person)	*
data.snippet_use_logs[][snippet][is_private]	boolean	*
data.snippet_use_logs[][snippet][avatar]	object (Blob)	*
data.snippet_use_logs[][snippet][avatar][sys_name]	string	*	A unique system name for the blob.
data.snippet_use_logs[][snippet][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.snippet_use_logs[][snippet][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.snippet_use_logs[][snippet][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.snippet_use_logs[][snippet][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.snippet_use_logs[][snippet][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.snippet_use_logs[][snippet][avatar][file_url]	string	*	The HTTP link to download the file.
data.snippet_use_logs[][snippet][avatar][authcode]	string	*
data.snippet_use_logs[][snippet][avatar][blob_hash]	string	*
data.snippet_use_logs[][snippet][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.snippet_use_logs[][snippet][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.snippet_use_logs[][snippet][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.snippet_use_logs[][snippet][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.snippet_use_logs[][snippet][avatar][date_created]	DateTime	*
data.snippet_use_logs[][snippet][avatar][is_temp]	boolean	*
data.snippet_use_logs[][snippet][avatar][source_ref]	string	*
data.snippet_use_logs[][snippet][avatar][labels][]	array of objects (LabelBlob)	*
data.snippet_use_logs[][snippet][avatar][labels][][blob]	object (Blob)	*
data.snippet_use_logs[][snippet][status]	string	*
data.snippet_use_logs[][snippet][shortcut_codes]	array	*
data.snippet_use_logs[][snippet][inline_translations]	array	*
data.snippet_use_logs[][snippet][translations][]	array of objects (SnippetV2Translation)	*
data.snippet_use_logs[][snippet][translations][][id]	integer	*	The unique ID.
data.snippet_use_logs[][snippet][translations][][snippet]	object (SnippetV2)	*	Snippet translated.
data.snippet_use_logs[][snippet][translations][][language]	object (Language)	*
data.snippet_use_logs[][snippet][translations][][language][id]	integer	*	The unique ID.
data.snippet_use_logs[][snippet][translations][][language][sys_name]	string	*	The unique sys name assigned to the language.
data.snippet_use_logs[][snippet][translations][][language][title]	string	*	Title of the language.
data.snippet_use_logs[][snippet][translations][][language][title_local]	string	*	Title of the language.
data.snippet_use_logs[][snippet][translations][][language][base_filepath]	string	*	The base filepath for default phrases for this lang.
data.snippet_use_logs[][snippet][translations][][language][locale]	string	*	The locale code.
data.snippet_use_logs[][snippet][translations][][language][flag_image]	string	*	String path to image.
data.snippet_use_logs[][snippet][translations][][language][is_rtl]	boolean	*	True if this is a right-to-left language.
data.snippet_use_logs[][snippet][translations][][language][has_user]	boolean	*	True if has user.
data.snippet_use_logs[][snippet][translations][][language][has_agent]	boolean	*	True if has agent.
data.snippet_use_logs[][snippet][translations][][language][has_admin]	boolean	*	True if has admin.
data.snippet_use_logs[][snippet][translations][][language][plural_categories][]	array of strings	*
data.snippet_use_logs[][snippet][translations][][language][plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data.snippet_use_logs[][snippet][translations][][language][flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`
data.snippet_use_logs[][snippet][translations][][content]	array	*	Snippet content.
data.snippet_use_logs[][snippet][translations][][blobs][]	array of objects (Blob)	*
data.snippet_use_logs[][snippet][categories][]	array of objects (SnippetV2Category)	*
data.snippet_use_logs[][snippet][categories][][id]	integer	*
data.snippet_use_logs[][snippet][categories][][title]	string	*
data.snippet_use_logs[][snippet][categories][][is_global]	boolean	*
data.snippet_use_logs[][snippet][categories][][display_order]	integer	*
data.snippet_use_logs[][snippet][categories][][parent]	object (SnippetV2Category)	*
data.snippet_use_logs[][snippet][categories][][agent_teams][]	array of objects (AgentTeam)	*
data.snippet_use_logs[][snippet][categories][][agent_teams][][id]	integer	*	The unique ID.
data.snippet_use_logs[][snippet][categories][][agent_teams][][name]	string	*	The name of agent team.
data.snippet_use_logs[][snippet][categories][][agent_teams][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.snippet_use_logs[][snippet][display_order]	integer	*
data.snippet_use_logs[][snippet][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message]	object (TicketMessage)	*	Ticket Message where the snippet was used.
data.snippet_use_logs[][ticket_message][id]	integer	*	The unique id of message.
data.snippet_use_logs[][ticket_message][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data.snippet_use_logs[][ticket_message][ticket][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][ref]	string	*
data.snippet_use_logs[][ticket_message][ticket][auth]	string	*
data.snippet_use_logs[][ticket_message][ticket][parent_ticket]	object (Ticket)	*	Parent ticket.
data.snippet_use_logs[][ticket_message][ticket][children_tickets][]	array of objects (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][language]	object (Language)	*	The language the ticket is in.
data.snippet_use_logs[][ticket_message][ticket][language][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][language][sys_name]	string	*	The unique sys name assigned to the language.
data.snippet_use_logs[][ticket_message][ticket][language][title]	string	*	Title of the language.
data.snippet_use_logs[][ticket_message][ticket][language][title_local]	string	*	Title of the language.
data.snippet_use_logs[][ticket_message][ticket][language][base_filepath]	string	*	The base filepath for default phrases for this lang.
data.snippet_use_logs[][ticket_message][ticket][language][locale]	string	*	The locale code.
data.snippet_use_logs[][ticket_message][ticket][language][flag_image]	string	*	String path to image.
data.snippet_use_logs[][ticket_message][ticket][language][is_rtl]	boolean	*	True if this is a right-to-left language.
data.snippet_use_logs[][ticket_message][ticket][language][has_user]	boolean	*	True if has user.
data.snippet_use_logs[][ticket_message][ticket][language][has_agent]	boolean	*	True if has agent.
data.snippet_use_logs[][ticket_message][ticket][language][has_admin]	boolean	*	True if has admin.
data.snippet_use_logs[][ticket_message][ticket][language][plural_categories][]	array of strings	*
data.snippet_use_logs[][ticket_message][ticket][language][plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data.snippet_use_logs[][ticket_message][ticket][language][flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`
data.snippet_use_logs[][ticket_message][ticket][brand]	object (Brand)	*
data.snippet_use_logs[][ticket_message][ticket][brand][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][brand][name]	string	*	The brand name.
data.snippet_use_logs[][ticket_message][ticket][brand][slug]	string	*
data.snippet_use_logs[][ticket_message][ticket][brand][url]	string	*	The brand url.
data.snippet_use_logs[][ticket_message][ticket][brand][theme_set]	object (ThemeSet)	*
data.snippet_use_logs[][ticket_message][ticket][brand][theme_set][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][brand][theme_set][theme_id]	string	*
data.snippet_use_logs[][ticket_message][ticket][brand][theme_set][title]	string	*
data.snippet_use_logs[][ticket_message][ticket][brand][edit_theme_set]	object (ThemeSet)	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][]	array of objects (Department)	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][parent]	object (Department)	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][children][]	array of objects (Department)	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][title]	string	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][user_title]	string	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][is_tickets_enabled]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][is_chat_enabled]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][display_order]	integer	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar]	object (Blob)	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][authcode]	string	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][blob_hash]	string	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][is_temp]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][source_ref]	string	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][brands][]	array of objects (Brand)	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][permissions][][department]	integer id (Department)	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][permissions][][name]	string	*	The name of the permission.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][permissions][][is_active]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][chat_queue]	object (UserChatQueue)	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][chat_queue][name]	string	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][chat_queue][routing_model]	string	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][chat_queue][answer_timeout]	integer	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][chat_queue][is_all_agents]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][chat_queue][max_queue_size]	integer	*
data.snippet_use_logs[][ticket_message][ticket][brand][theme_sets][]	array of objects (ThemeSet)	*
data.snippet_use_logs[][ticket_message][ticket][department]	object (Department)	*
data.snippet_use_logs[][ticket_message][ticket][department][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][department][parent]	object (Department)	*
data.snippet_use_logs[][ticket_message][ticket][department][children][]	array of objects (Department)	*
data.snippet_use_logs[][ticket_message][ticket][department][title]	string	*
data.snippet_use_logs[][ticket_message][ticket][department][user_title]	string	*
data.snippet_use_logs[][ticket_message][ticket][department][is_tickets_enabled]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][department][is_chat_enabled]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][department][display_order]	integer	*
data.snippet_use_logs[][ticket_message][ticket][department][avatar]	object (Blob)	*
data.snippet_use_logs[][ticket_message][ticket][department][avatar][sys_name]	string	*	A unique system name for the blob.
data.snippet_use_logs[][ticket_message][ticket][department][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.snippet_use_logs[][ticket_message][ticket][department][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.snippet_use_logs[][ticket_message][ticket][department][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.snippet_use_logs[][ticket_message][ticket][department][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.snippet_use_logs[][ticket_message][ticket][department][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.snippet_use_logs[][ticket_message][ticket][department][avatar][file_url]	string	*	The HTTP link to download the file.
data.snippet_use_logs[][ticket_message][ticket][department][avatar][authcode]	string	*
data.snippet_use_logs[][ticket_message][ticket][department][avatar][blob_hash]	string	*
data.snippet_use_logs[][ticket_message][ticket][department][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.snippet_use_logs[][ticket_message][ticket][department][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.snippet_use_logs[][ticket_message][ticket][department][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.snippet_use_logs[][ticket_message][ticket][department][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.snippet_use_logs[][ticket_message][ticket][department][avatar][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][department][avatar][is_temp]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][department][avatar][source_ref]	string	*
data.snippet_use_logs[][ticket_message][ticket][department][avatar][labels][]	array of objects (LabelBlob)	*
data.snippet_use_logs[][ticket_message][ticket][department][avatar][labels][][blob]	object (Blob)	*
data.snippet_use_logs[][ticket_message][ticket][department][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.snippet_use_logs[][ticket_message][ticket][department][brands][]	array of objects (Brand)	*
data.snippet_use_logs[][ticket_message][ticket][department][permissions][]	array of objects (DepartmentPermission)	*
data.snippet_use_logs[][ticket_message][ticket][department][permissions][][department]	integer id (Department)	*
data.snippet_use_logs[][ticket_message][ticket][department][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.snippet_use_logs[][ticket_message][ticket][department][permissions][][name]	string	*	The name of the permission.
data.snippet_use_logs[][ticket_message][ticket][department][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.snippet_use_logs[][ticket_message][ticket][department][permissions][][is_active]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][department][chat_queue]	object (UserChatQueue)	*
data.snippet_use_logs[][ticket_message][ticket][department][chat_queue][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][department][chat_queue][name]	string	*
data.snippet_use_logs[][ticket_message][ticket][department][chat_queue][routing_model]	string	*
data.snippet_use_logs[][ticket_message][ticket][department][chat_queue][answer_timeout]	integer	*
data.snippet_use_logs[][ticket_message][ticket][department][chat_queue][is_all_agents]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][department][chat_queue][departments][]	array of objects (Department)	*
data.snippet_use_logs[][ticket_message][ticket][department][chat_queue][max_queue_size]	integer	*
data.snippet_use_logs[][ticket_message][ticket][category]	object (TicketCategory)	*
data.snippet_use_logs[][ticket_message][ticket][category][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][category][parent]	integer id (TicketCategory)	*	This category parent.
data.snippet_use_logs[][ticket_message][ticket][category][title]	string	*	Category title.
data.snippet_use_logs[][ticket_message][ticket][category][display_order]	integer	*	Obviously it's display order for lists.
data.snippet_use_logs[][ticket_message][ticket][priority]	object (TicketPriority)	*
data.snippet_use_logs[][ticket_message][ticket][priority][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][priority][title]	string	*	Priority title.
data.snippet_use_logs[][ticket_message][ticket][priority][priority]	integer	*	The priority itself.
data.snippet_use_logs[][ticket_message][ticket][workflow]	object (TicketWorkflow)	*
data.snippet_use_logs[][ticket_message][ticket][workflow][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][workflow][title]	string	*	Workflow title.
data.snippet_use_logs[][ticket_message][ticket][workflow][display_order]	integer	*	Workflow display order.
data.snippet_use_logs[][ticket_message][ticket][product]	object (Product)	*
data.snippet_use_logs[][ticket_message][ticket][product][parent]	integer id (Product)	*	Parent of the product.
data.snippet_use_logs[][ticket_message][ticket][person]	object (Person)	*
data.snippet_use_logs[][ticket_message][ticket][person_email]	object (PersonEmail)	*
data.snippet_use_logs[][ticket_message][ticket][person_email][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][person_email][person]	integer id (Person)	*	Person owner of email.
data.snippet_use_logs[][ticket_message][ticket][person_email][email]	string	*	The email address.
data.snippet_use_logs[][ticket_message][ticket][person_email][email_domain]	string	*	The email address domain.
data.snippet_use_logs[][ticket_message][ticket][person_email][is_validated]	boolean	*	True if validation passed.
data.snippet_use_logs[][ticket_message][ticket][person_email][date_created]	DateTime	*	The original time the email was created.
data.snippet_use_logs[][ticket_message][ticket][agent]	object (Person)	*
data.snippet_use_logs[][ticket_message][ticket][agent_team]	object (AgentTeam)	*
data.snippet_use_logs[][ticket_message][ticket][agent_team][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][agent_team][name]	string	*	The name of agent team.
data.snippet_use_logs[][ticket_message][ticket][agent_team][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.snippet_use_logs[][ticket_message][ticket][organization]	object (Organization)	*
data.snippet_use_logs[][ticket_message][ticket][organization][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob]	object (Blob)	*	The org picture.
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][sys_name]	string	*	A unique system name for the blob.
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][file_url]	string	*	The HTTP link to download the file.
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][authcode]	string	*
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][blob_hash]	string	*
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][is_temp]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][source_ref]	string	*
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][labels][]	array of objects (LabelBlob)	*
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][labels][][blob]	object (Blob)	*
data.snippet_use_logs[][ticket_message][ticket][organization][icon_property]	object (IconProperty)	*
data.snippet_use_logs[][ticket_message][ticket][organization][icon_property][urn]	string	*
data.snippet_use_logs[][ticket_message][ticket][organization][icon_property][options]	array	*
data.snippet_use_logs[][ticket_message][ticket][organization][name]	string	*	The organization name.
data.snippet_use_logs[][ticket_message][ticket][organization][summary]	string	*	The summary field as filled in by agents.
data.snippet_use_logs[][ticket_message][ticket][organization][importance]	integer	*	The org importance.
data.snippet_use_logs[][ticket_message][ticket][organization][custom_data][]	array of objects (CustomDataOrganization)	*
data.snippet_use_logs[][ticket_message][ticket][organization][custom_data][][organization]	object (Organization)	*
data.snippet_use_logs[][ticket_message][ticket][organization][custom_data][][field]	object (CustomDefOrganization)	*
data.snippet_use_logs[][ticket_message][ticket][organization][custom_data][][field][parent]	object (CustomDefOrganization)	*	Field`s parent.
data.snippet_use_logs[][ticket_message][ticket][organization][custom_data][][field][children][]	array of objects (CustomDefOrganization)	*	Field children.
data.snippet_use_logs[][ticket_message][ticket][organization][custom_data][][root_field]	object (CustomDefOrganization)	*
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][]	array of objects (Usergroup)	*	Usergroups the user belongs to.
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][id]	integer	*	The unique ID, DB-generated.
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][title]	string	*	Title of the usergroup.
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][note]	string	*	A note or description about the usergroup.
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][permissions][][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][permissions][][name]	string	*	The name of the permission.
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][department_permissions][][department]	integer id (Department)	*
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][department_permissions][][is_active]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.snippet_use_logs[][ticket_message][ticket][organization][auto_cc_people][]	array of objects (Person)	*	Users who are set to automatically be added to tickets and other org things.
data.snippet_use_logs[][ticket_message][ticket][organization][labels][]	array of objects (LabelOrganization)	*
data.snippet_use_logs[][ticket_message][ticket][organization][labels][][organization]	object (Organization)	*
data.snippet_use_logs[][ticket_message][ticket][organization][contact_data][]	array of objects (OrganizationContactData)	*
data.snippet_use_logs[][ticket_message][ticket][organization][emails][]	array of objects (OrganizationEmail)	*
data.snippet_use_logs[][ticket_message][ticket][organization][emails][][id]	integer	*	The unique log id.
data.snippet_use_logs[][ticket_message][ticket][organization][emails][][organization]	object (Organization)	*
data.snippet_use_logs[][ticket_message][ticket][organization][emails][][email]	string	*
data.snippet_use_logs[][ticket_message][ticket][organization][emails][][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][organization][email_domains][]	array of objects (OrganizationEmailDomain)	*
data.snippet_use_logs[][ticket_message][ticket][organization][email_domains][][domain]	string	*	The email domain.
data.snippet_use_logs[][ticket_message][ticket][organization][email_domains][][organization]	object (Organization)	*	The users organization.
data.snippet_use_logs[][ticket_message][ticket][organization][date_created]	DateTime	*	The date the org was inserted into the system.
data.snippet_use_logs[][ticket_message][ticket][organization][members][]	array of objects (Person)	*
data.snippet_use_logs[][ticket_message][ticket][organization][parent]	object (Organization)	*
data.snippet_use_logs[][ticket_message][ticket][organization][children][]	array of objects (Organization)	*
data.snippet_use_logs[][ticket_message][ticket][organization][tickets][]	array of objects (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][organization][organization_members][]	array of objects (OrganizationMember)	*
data.snippet_use_logs[][ticket_message][ticket][organization][organization_members][][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][organization][organization_members][][person]	integer id (Person)	*
data.snippet_use_logs[][ticket_message][ticket][organization][organization_members][][organization]	integer id (Organization)	*
data.snippet_use_logs[][ticket_message][ticket][organization][organization_members][][is_manager]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][organization][organization_members][][position]	string	*
data.snippet_use_logs[][ticket_message][ticket][organization][organization_members][][created_at]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][organization][organization_members][][updated_at]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat]	object (ChatConversation)	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][id]	integer	*	The unique id of chat conversation.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][department]	object (Department)	*	Department which chat was assigned.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][brand]	object (Brand)	*	Department which chat was assigned.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][task_id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][ticket]	object (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][labels][]	array of objects (LabelChatConversation)	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][labels][][chat]	object (ChatConversation)	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][subject]	string	*	Subject of the chat conversation.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][status]	string	*	Status of the chat conversation.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][agent]	object (Person)	*	If this is a user conversation, this is the agent assigned.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][agent_team]	object (AgentTeam)	*	If this is a team chat, the team it is.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][person]	object (Person)	*	If this is a user conversation, this is the user who started the chat.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session]	object (Session)	*	If this is a user convo, this is the users session.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][auth]	string	*	The authcode for the session to verify an id.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][interface]	string	*	The Interface the session is for.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][person]	object (Person)	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][user_agent]	string	*	The users user agent string.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][visitor_id]	string	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][ip_address]	string	*	The users IP address.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][data]	string	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][is_person]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][is_bot]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][is_helpdesk]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][active_status]	string	*	(Agents) Status (available or away).
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][is_chat_available]	boolean	*	(Agents) Wehn status is available, if they are available for chat.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][date_last]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][date_last_page]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][visitor_id]	string	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][person_name]	string	*	User chat: The users name, if they arent a person.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][person_email]	string	*	User chat: The users email, if they aren`t a person.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][participants][]	array of objects (Person)	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][]	array of objects (ChatMessage)	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][author_id]	integer	*	Author id (legacy).
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][author_type]	string	*	Author type (legacy).
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][conversation_id]	integer	*	Conversation id (legacy).
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][author]	integer id (Person)	*	Person who created the message.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][content]	string	*	The message.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][is_html]	boolean	*	Is the content an HTML message?
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][metadata]	array	*	Additional data.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][date_created]	DateTime	*	Date message was created.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][date_received]	DateTime	*	Date message was received.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][custom_data][]	array of objects (CustomDataChat)	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][custom_data][][conversation]	object (ChatConversation)	*	The conversation the message belongs to.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][custom_data][][field]	object (CustomDefChat)	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][custom_data][][field][parent]	object (CustomDefChat)	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][custom_data][][field][children][]	array of objects (CustomDefChat)	*	Field children.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][custom_data][][root_field]	object (CustomDefChat)	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][rating_response_time]	integer	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][rating_overall]	integer	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][rating_comment]	string	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][is_agent]	boolean	*	Is this an agent chat.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][is_window]	boolean	*	If the chat is popped out into a window. This is used to make sure the JS widget on pages doesn't load again.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][date_created]	DateTime	*	Date when chat was started.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][date_user_waiting]	DateTime	*	Since when the user has started waiting (i.e., time the assignment was 0).
data.snippet_use_logs[][ticket_message][ticket][linked_chat][date_assigned]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][date_agent_typing]	DateTime	*	Date when agent typed last time.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][date_first_agent_message]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][date_ended]	DateTime	*	Date when chat was ended.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][total_to_ended]	integer	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][ended_by]	string	*	Who ended the chat.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][should_send_transcript]	boolean	*	True if transcript should be send.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][date_transcript_sent]	DateTime	*	Date when transcript was sent.
data.snippet_use_logs[][ticket_message][ticket][linked_chat][email_validation_code]	string	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][email_validated]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][linked_chat][access_token]	string	*
data.snippet_use_logs[][ticket_message][ticket][attachments][]	array of objects (TicketAttachment)	*
data.snippet_use_logs[][ticket_message][ticket][access_codes][]	array of objects (TicketAccessCode)	*
data.snippet_use_logs[][ticket_message][ticket][access_codes][][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][access_codes][][ticket]	object (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][access_codes][][person]	object (Person)	*
data.snippet_use_logs[][ticket_message][ticket][access_codes][][auth]	string	*
data.snippet_use_logs[][ticket_message][ticket][messages][]	array of objects (TicketMessage)	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][]	array of objects (TicketSms)	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][ticket]	object (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][person]	object (Person)	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][sms_account]	object (SmsAccount)	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][sms_account][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][sms_account][type]	string	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][sms_account][params]	array	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][sms_account][identifier]	string	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][sms_account][is_enabled]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][sms_account][is_connected]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][sms_account][is_tested]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][sms_account][test_code]	string	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job]	object (Job)	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][id]	integer	*	The unique job id.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][type]	string	*	The job type, used by the Job Router to find the right Job Processor.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][status]	string	*	The status of the job.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][status_code]	string	*	Any code to further classify the status.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][date_touch]	DateTime	*	Date the last time a process "touched" this ticket.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][date_created]	DateTime	*	Date this job entered the "jobs" table.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][date_last_try]	DateTime	*	Last time we processed this job.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][date_next_try]	DateTime	*	If this DateTime is in the future, it won't be selected for execution.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][num_tries]	integer	*	The number of times this job has been executed Job Processor (usually indicated failures if > 1).
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][log_summary]	string	*	A human readable summary of the job's execution.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][log]	string	*	A more verbose log.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][data]	array	*	An array of data, or payload, that the job processor needs to execute this job (stored in the db as json). This MUST always be an array, even if its an empty array
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][original_job]	integer	*	Null unless the job was created as a retry - if so, the originating job ID is stored here so we can query it later. Note: You MUST specify the originating job, do not create a linked list of failed jobs.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][from_number]	string	*	Permanent record of the phone number that sent this SMS. (Won't change even if Person changes their phone number).
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][to_number]	string	*	Permanent record of the phone number that this SMS was sent to.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][message]	string	*	The SMS message.
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][direction]	string	*	Just a system flag for reporting.
data.snippet_use_logs[][ticket_message][ticket][topic_links][]	array of objects (TicketCommunityTopicLink)	*
data.snippet_use_logs[][ticket_message][ticket][topic_links][][id]	integer	*	The unique filter ID.
data.snippet_use_logs[][ticket_message][ticket][topic_links][][ticket]	integer id (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][topic_links][][topic]	integer id (CommunityTopic)	*
data.snippet_use_logs[][ticket_message][ticket][topic_links][][person]	integer id (Person)	*
data.snippet_use_logs[][ticket_message][ticket][topic_links][][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][custom_data][]	array of objects (CustomDataTicket)	*
data.snippet_use_logs[][ticket_message][ticket][custom_data][][ticket]	object (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][custom_data][][field]	object (CustomDefTicket)	*
data.snippet_use_logs[][ticket_message][ticket][custom_data][][field][parent]	object (CustomDefTicket)	*
data.snippet_use_logs[][ticket_message][ticket][custom_data][][field][children][]	array of objects (CustomDefTicket)	*	Field children.
data.snippet_use_logs[][ticket_message][ticket][custom_data][][root_field]	object (CustomDefTicket)	*
data.snippet_use_logs[][ticket_message][ticket][labels][]	array of objects (LabelTicket)	*
data.snippet_use_logs[][ticket_message][ticket][labels][][ticket]	object (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][sent_to_address]	string	*	The email address the ticket was sent to if it came in via a gateway. This is a full string (e.g., including CC's) of the original.
data.snippet_use_logs[][ticket_message][ticket][email_account]	object (EmailAccount)	*	The gateway this ticket originated from.
data.snippet_use_logs[][ticket_message][ticket][email_account][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][email_account][account_type]	string	*
data.snippet_use_logs[][ticket_message][ticket][email_account][is_enabled]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][email_account][address]	string	*
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob]	object (Blob)	*
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][sys_name]	string	*	A unique system name for the blob.
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][file_url]	string	*	The HTTP link to download the file.
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][authcode]	string	*
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][blob_hash]	string	*
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][is_temp]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][source_ref]	string	*
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][labels][]	array of objects (LabelBlob)	*
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][labels][][blob]	object (Blob)	*
data.snippet_use_logs[][ticket_message][ticket][email_account][key_blob]	object (Blob)	*
data.snippet_use_logs[][ticket_message][ticket][email_account_address]	string	*	The email address (from list of to/cc) that matched with the email account.
data.snippet_use_logs[][ticket_message][ticket][creation_system]	string	*
data.snippet_use_logs[][ticket_message][ticket][creation_system_option]	string	*	Optional information about the creation system. For example, source URL the ticket came from.
data.snippet_use_logs[][ticket_message][ticket][ticket_hash]	string	*
data.snippet_use_logs[][ticket_message][ticket][status]	string	*
data.snippet_use_logs[][ticket_message][ticket][ticket_status]	object (TicketStatus)	*
data.snippet_use_logs[][ticket_message][ticket][ticket_status][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][ticket_status][status_type]	string	*
data.snippet_use_logs[][ticket_message][ticket][ticket_status][status_code]	string	*
data.snippet_use_logs[][ticket_message][ticket][ticket_status][sys_id]	string	*
data.snippet_use_logs[][ticket_message][ticket][ticket_status][title]	string	*
data.snippet_use_logs[][ticket_message][ticket][ticket_status][display_order]	integer	*
data.snippet_use_logs[][ticket_message][ticket][ticket_status][pending_waiting_time_mode]	string	*	Where to count time spending in pending status. Check PENDING_WAITING_TIME_MODE_ constants
data.snippet_use_logs[][ticket_message][ticket][ticket_status][children][]	array of objects (TicketStatus)	*
data.snippet_use_logs[][ticket_message][ticket][ticket_status][options]	array	*
data.snippet_use_logs[][ticket_message][ticket][urgency]	integer	*
data.snippet_use_logs[][ticket_message][ticket][feedback_rating]	integer	*
data.snippet_use_logs[][ticket_message][ticket][date_feedback_rating]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][date_resolved]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][date_archived]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][date_first_agent_assign]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][date_first_agent_reply]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][date_last_agent_reply]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][date_last_user_reply]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][date_agent_waiting]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][date_user_waiting]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][date_status]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][date_on_hold]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][total_user_waiting]	integer	*
data.snippet_use_logs[][ticket_message][ticket][total_to_first_reply]	integer	*
data.snippet_use_logs[][ticket_message][ticket][total_user_waiting_wh_start]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][total_user_waiting_wh]	integer	*
data.snippet_use_logs[][ticket_message][ticket][total_to_first_reply_wh]	integer	*
data.snippet_use_logs[][ticket_message][ticket][locked_by_agent]	object (Person)	*
data.snippet_use_logs[][ticket_message][ticket][date_locked]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][has_attachments]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][subject]	string	*
data.snippet_use_logs[][ticket_message][ticket][original_subject]	string	*
data.snippet_use_logs[][ticket_message][ticket][properties]	array	*
data.snippet_use_logs[][ticket_message][ticket][count_agent_replies]	integer	*
data.snippet_use_logs[][ticket_message][ticket][count_user_replies]	integer	*
data.snippet_use_logs[][ticket_message][ticket][worst_sla_status]	string	*
data.snippet_use_logs[][ticket_message][ticket][waiting_times]	array	*	Used to track ticket status changes and how much time ticket was in status Add new item every time status changed This is optimisation over TicketLog.
data.snippet_use_logs[][ticket_message][ticket][participants][]	array of objects (TicketParticipant)	*
data.snippet_use_logs[][ticket_message][ticket][participants][][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][participants][][ticket]	object (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][participants][][person]	object (Person)	*
data.snippet_use_logs[][ticket_message][ticket][participants][][access_code]	object (TicketAccessCode)	*
data.snippet_use_logs[][ticket_message][ticket][participants][][person_email]	object (PersonEmail)	*
data.snippet_use_logs[][ticket_message][ticket][participants][][default_on]	boolean	*	Default checkbox status of the user.
data.snippet_use_logs[][ticket_message][ticket][charges][]	array of objects (TicketCharge)	*
data.snippet_use_logs[][ticket_message][ticket][charges][][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][charges][][charge_time]	integer	*
data.snippet_use_logs[][ticket_message][ticket][charges][][amount]	float	*
data.snippet_use_logs[][ticket_message][ticket][charges][][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][charges][][ticket]	object (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][charges][][person]	object (Person)	*
data.snippet_use_logs[][ticket_message][ticket][charges][][organization]	object (Organization)	*
data.snippet_use_logs[][ticket_message][ticket][charges][][agent]	object (Person)	*
data.snippet_use_logs[][ticket_message][ticket][charges][][custom_data][]	array of objects (CustomDataBilling)	*
data.snippet_use_logs[][ticket_message][ticket][charges][][custom_data][][ticket_charge]	object (TicketCharge)	*
data.snippet_use_logs[][ticket_message][ticket][charges][][custom_data][][field]	object (CustomDefBilling)	*
data.snippet_use_logs[][ticket_message][ticket][charges][][custom_data][][field][parent]	object (CustomDefBilling)	*
data.snippet_use_logs[][ticket_message][ticket][charges][][custom_data][][field][children][]	array of objects (CustomDefBilling)	*	Field children.
data.snippet_use_logs[][ticket_message][ticket][charges][][custom_data][][root_field]	object (CustomDefBilling)	*
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][]	array of objects (TicketSla)	*
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][sla_status]	string	*	The SLA status.
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][warn_date]	DateTime	*	The SLA warn date.
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][fail_date]	DateTime	*	The SLA fail date.
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][is_completed]	boolean	*	Is the SLA completed?
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][is_completed_set]	boolean	*	Completed by automated action.
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][completed_time_taken]	integer	*	Time taken.
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][ticket]	integer id (Ticket)	*	Ticket.
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][sla]	integer id (Sla)	*	SLA.
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][date_applied]	DateTime	*	time and date when SLA was applied to the ticket.
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][date_completed]	DateTime	*	time when SLA status became OK.
data.snippet_use_logs[][ticket_message][ticket][jira_issues][]	array of objects (JiraIssue)	*	linked jira issues.
data.snippet_use_logs[][ticket_message][ticket][jira_issues][][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][jira_issues][][ticket]	object (Ticket)	*	The associated DeskPRO ticket.
data.snippet_use_logs[][ticket_message][ticket][jira_issues][][issue_id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][jira_issues][][status_id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][jira_issues][][created]	DateTime	*	Export time.
data.snippet_use_logs[][ticket_message][ticket][problems][]	array of objects (Problem)	*
data.snippet_use_logs[][ticket_message][ticket][problems][][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][problems][][title]	string	*	Problem title.
data.snippet_use_logs[][ticket_message][ticket][problems][][creator]	integer id (Person)	*	Person who created the problem.
data.snippet_use_logs[][ticket_message][ticket][problems][][created]	DateTime	*	Date when the problem was created.
data.snippet_use_logs[][ticket_message][ticket][problems][][is_open]	boolean	*	Is problem still has no solution?
data.snippet_use_logs[][ticket_message][ticket][problems][][tickets][]	array of integer ids (Ticket)	*	Tickets associated with problem.
data.snippet_use_logs[][ticket_message][ticket][stars][]	array of objects (TicketFlagged)	*
data.snippet_use_logs[][ticket_message][ticket][stars][][ticket]	object (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][stars][][person_id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][stars][][color]	string	*
data.snippet_use_logs[][ticket_message][ticket][follow_ups][]	array of objects (TicketFollowUp)	*
data.snippet_use_logs[][ticket_message][ticket][follow_ups][][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][follow_ups][][person]	integer id (Person)	*
data.snippet_use_logs[][ticket_message][ticket][follow_ups][][actions]	array	*
data.snippet_use_logs[][ticket_message][ticket][follow_ups][][cancel_if_user_reply]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][follow_ups][][cancel_if_agent_reply]	boolean	*
data.snippet_use_logs[][ticket_message][ticket][follow_ups][][status]	string	*
data.snippet_use_logs[][ticket_message][ticket][follow_ups][][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][follow_ups][][date_to_run]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][follow_ups][][date_did_run]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][logs][]	array of objects (TicketLog)	*
data.snippet_use_logs[][ticket_message][ticket][logs][][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][logs][][parent]	object (TicketLog)	*
data.snippet_use_logs[][ticket_message][ticket][logs][][ticket]	object (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][logs][][person]	object (Person)	*
data.snippet_use_logs[][ticket_message][ticket][logs][][action_type]	string	*
data.snippet_use_logs[][ticket_message][ticket][logs][][id_object]	integer	*	If the log involves a specific thing in a ticket (eg a message that was moved), then that is this id.
data.snippet_use_logs[][ticket_message][ticket][logs][][id_before]	integer	*	The ID of the previous entity changed, or any other numeric value.
data.snippet_use_logs[][ticket_message][ticket][logs][][id_after]	integer	*	The ID of the new entity, or any other numeric value.
data.snippet_use_logs[][ticket_message][ticket][logs][][trigger_id]	integer	*	If the change was caused by a trigger, the trigger id. Note this is the integer ID (not a FK relation) so the record is kept even if the trigger itself is deleted.
data.snippet_use_logs[][ticket_message][ticket][logs][][escalation_id]	integer	*	If the change was caused by an escalation Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.snippet_use_logs[][ticket_message][ticket][logs][][macro_id]	integer	*	If the change was caused by an v2 macro Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla]	object (Sla)	*	If the change was caused by an SLA, the SLA.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][id]	integer	*	The unique ID.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][title]	string	*	SLA title.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][sla_type]	string	*	Type of SLA - first_response, resolution, waiting_time.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][active_time]	string	*	Whether active all the time (all) or during work hours only (work_hours) or use the default ticket-wide settings (default).
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][work_start]	integer	*	When the work day starts. This is stored as the number of seconds after 00:00:00.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][work_end]	integer	*	When the work day ends. This is stored as the number of seconds after 00:00:00.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][work_days]	array	*	Array of work days, stored with keys corresponding to day numbers. Values are true. 0 = Sunday, 6 = Saturday (same as PHP, easy to convert to MySQL which is 1 = Sunday, 7 = Saturday).
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][work_timezone]	string	*	Timezone for work hours/days to be considered in.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][work_holidays]	array	*	List of work holidays.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][apply_type]	string	*	Controls how the SLA is applied to tickets: all, terms, terms_before_triggers, manual.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][apply_terms]	object (TriggerTerms)	*	Conditions to apply.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][apply_terms][version]	integer	*	Terms version.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][apply_terms][terms]	array	*	Terms themselves.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][trigger_terms]	object (TriggerTerms)	*	Conditions to consider sla completed.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][warn_time]	integer	*	Warn time integer.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][warn_time_unit]	string	*	And it's unit (see warn time).
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][warn_actions]	object (TriggerActions)	*	How to warn about SLA will fail.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][warn_actions][version]	integer	*	Actions version.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][warn_actions][actions]	array	*	Actions array representation.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][fail_time]	integer	*	Fail time integer.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][fail_time_unit]	string	*	And it's measuring unit (see fail_time).
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][fail_actions]	object (TriggerActions)	*	What to do if SLA failed.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][exclude_ticket_statuses]	array	*	This SLA will not apply while tickets are in these pending statuses.
data.snippet_use_logs[][ticket_message][ticket][logs][][sla_status]	string	*
data.snippet_use_logs[][ticket_message][ticket][logs][][details]	array	*
data.snippet_use_logs[][ticket_message][ticket][logs][][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][chats][]	array of objects (ChatConversation)	*
data.snippet_use_logs[][ticket_message][ticket][created_with_channel]	string	*
data.snippet_use_logs[][ticket_message][ticket][last_channel_used]	string	*
data.snippet_use_logs[][ticket_message][ticket][channels]	array	*
data.snippet_use_logs[][ticket_message][ticket][pending_articles][]	array of objects (ArticlePendingCreate)	*
data.snippet_use_logs[][ticket_message][ticket][pending_articles][][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][pending_articles][][person]	integer id (Person)	*
data.snippet_use_logs[][ticket_message][ticket][pending_articles][][assigned_person]	integer id (Person)	*
data.snippet_use_logs[][ticket_message][ticket][pending_articles][][ticket]	integer id (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][pending_articles][][message]	integer id (TicketMessage)	*
data.snippet_use_logs[][ticket_message][ticket][pending_articles][][comment]	string	*
data.snippet_use_logs[][ticket_message][ticket][pending_articles][][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket][summary]	object (TicketSummary)	*
data.snippet_use_logs[][ticket_message][ticket][summary][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket][summary][ticket]	object (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket][summary][summary]	string	*
data.snippet_use_logs[][ticket_message][ticket][summary][summary_input]	string	*
data.snippet_use_logs[][ticket_message][ticket][summary][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][person]	object (Person)	*	Person this message was sent by.
data.snippet_use_logs[][ticket_message][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data.snippet_use_logs[][ticket_message][email_source][id]	integer	*
data.snippet_use_logs[][ticket_message][email_source][uuid]	string	*
data.snippet_use_logs[][ticket_message][email_source][blob]	object (Blob)	*
data.snippet_use_logs[][ticket_message][email_source][blob][sys_name]	string	*	A unique system name for the blob.
data.snippet_use_logs[][ticket_message][email_source][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.snippet_use_logs[][ticket_message][email_source][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.snippet_use_logs[][ticket_message][email_source][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.snippet_use_logs[][ticket_message][email_source][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.snippet_use_logs[][ticket_message][email_source][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.snippet_use_logs[][ticket_message][email_source][blob][file_url]	string	*	The HTTP link to download the file.
data.snippet_use_logs[][ticket_message][email_source][blob][authcode]	string	*
data.snippet_use_logs[][ticket_message][email_source][blob][blob_hash]	string	*
data.snippet_use_logs[][ticket_message][email_source][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.snippet_use_logs[][ticket_message][email_source][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.snippet_use_logs[][ticket_message][email_source][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.snippet_use_logs[][ticket_message][email_source][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.snippet_use_logs[][ticket_message][email_source][blob][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][email_source][blob][is_temp]	boolean	*
data.snippet_use_logs[][ticket_message][email_source][blob][source_ref]	string	*
data.snippet_use_logs[][ticket_message][email_source][blob][labels][]	array of objects (LabelBlob)	*
data.snippet_use_logs[][ticket_message][email_source][blob][labels][][blob]	object (Blob)	*
data.snippet_use_logs[][ticket_message][email_source][object_type]	string	*	The type of object this is attached to (should be the table name of the super type, eg: tickets, people, organizations). This typically is not set until after the email is processed (ie the status is 'processed').
data.snippet_use_logs[][ticket_message][email_source][object_id]	integer	*	The ID of the object this is attached to.
data.snippet_use_logs[][ticket_message][email_source][from_email]	string	*
data.snippet_use_logs[][ticket_message][email_source][status]	string	*	The current status of the message: - inserted: Only inserted - processing: Currently processing - complete: Fully processed - error: Tried to process but there was some kind of error (see error_code).
data.snippet_use_logs[][ticket_message][email_source][date_status]	DateTime	*
data.snippet_use_logs[][ticket_message][email_source][error_code]	string	*	When status is error, this is the code that describes the error.
data.snippet_use_logs[][ticket_message][email_source][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.snippet_use_logs[][ticket_message][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.snippet_use_logs[][ticket_message][date_created]	DateTime	*	Date when message was created.
data.snippet_use_logs[][ticket_message][is_agent_note]	boolean	*	Is this message agent note?
data.snippet_use_logs[][ticket_message][is_hidden]	boolean	*	Is this message hidden?
data.snippet_use_logs[][ticket_message][creation_system]	string	*	How this message was created.
data.snippet_use_logs[][ticket_message][ip_address]	string	*	An ip address from which message was sent.
data.snippet_use_logs[][ticket_message][visitor_id]	string	*	Unique ID of visitor left this message.
data.snippet_use_logs[][ticket_message][hostname]	string	*	Host from which message was left.
data.snippet_use_logs[][ticket_message][geo_country]	string	*	Country message is from (deprecated).
data.snippet_use_logs[][ticket_message][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.snippet_use_logs[][ticket_message][message_hash]	string	*	An unique hash of message.
data.snippet_use_logs[][ticket_message][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.snippet_use_logs[][ticket_message][primary_translation][id]	integer	*
data.snippet_use_logs[][ticket_message][primary_translation][ticket]	object (Ticket)	*
data.snippet_use_logs[][ticket_message][primary_translation][ticket_message]	object (TicketMessage)	*
data.snippet_use_logs[][ticket_message][primary_translation][from_lang_code]	string	*
data.snippet_use_logs[][ticket_message][primary_translation][lang_code]	string	*
data.snippet_use_logs[][ticket_message][primary_translation][message]	string	*
data.snippet_use_logs[][ticket_message][primary_translation][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][message]	string	*	The message, will be in HTML!
data.snippet_use_logs[][ticket_message][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.snippet_use_logs[][ticket_message][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.snippet_use_logs[][ticket_message][message_source]	string	*	The message source.
data.snippet_use_logs[][ticket_message][message_source_type]	string	*	The message source type.
data.snippet_use_logs[][ticket_message][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.snippet_use_logs[][ticket_message][lang_code]	string	*	The set/detected lang code.
data.snippet_use_logs[][ticket_message][email_message_id][]	array of objects (TicketMessageEmailId)	*
data.snippet_use_logs[][ticket_message][email_message_id][][id]	integer	*
data.snippet_use_logs[][ticket_message][email_message_id][][message]	object (TicketMessage)	*
data.snippet_use_logs[][ticket_message][email_message_id][][email_id]	string	*
data.snippet_use_logs[][ticket_message][ticket_feedback][]	array of objects (TicketFeedback)	*
data.snippet_use_logs[][ticket_message][ticket_feedback][][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket_feedback][][ticket]	object (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data.snippet_use_logs[][ticket_message][ticket_feedback][][person]	object (Person)	*
data.snippet_use_logs[][ticket_message][ticket_feedback][][rating]	integer	*
data.snippet_use_logs[][ticket_message][ticket_feedback][][message]	string	*
data.snippet_use_logs[][ticket_message][ticket_feedback][][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][id]	integer	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][subject]	string	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][from_email]	string	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][tos]	array	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][ccs]	array	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][bccs]	array	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][message]	string	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][authcode]	string	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][blob_hash]	string	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][source_ref]	string	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][date_created]	DateTime	*
data.snippet_use_logs[][ticket_message][channel_message]	object (TicketMessageChannelMessage)	*
data.snippet_use_logs[][ticket_message][channel_message][id]	integer	*	@var int The unique id of message.
data.snippet_use_logs[][ticket_message][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data.snippet_use_logs[][ticket_message][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data.snippet_use_logs[][ticket_message][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data.snippet_use_logs[][ticket_message][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data.snippet_use_logs[][ticket_message][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data.snippet_use_logs[][ticket_message][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data.snippet_use_logs[][ticket_message][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data.snippet_use_logs[][ticket_message][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data.snippet_use_logs[][ticket_message][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data.snippet_use_logs[][chat_message]	object (ChatMessage)	*	Chat Message where the snippet was used.
data.snippet_use_logs[][chat_message][id]	integer	*	The unique ID.
data.snippet_use_logs[][chat_message][author_id]	integer	*	Author id (legacy).
data.snippet_use_logs[][chat_message][author_type]	string	*	Author type (legacy).
data.snippet_use_logs[][chat_message][conversation_id]	integer	*	Conversation id (legacy).
data.snippet_use_logs[][chat_message][author]	integer id (Person)	*	Person who created the message.
data.snippet_use_logs[][chat_message][content]	string	*	The message.
data.snippet_use_logs[][chat_message][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.snippet_use_logs[][chat_message][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.snippet_use_logs[][chat_message][is_html]	boolean	*	Is the content an HTML message?
data.snippet_use_logs[][chat_message][metadata]	array	*	Additional data.
data.snippet_use_logs[][chat_message][date_created]	DateTime	*	Date message was created.
data.snippet_use_logs[][chat_message][date_received]	DateTime	*	Date message was received.
data.snippet_use_logs[][language]	object (Language)	*	Snippet translated.
data.snippet_use_logs[][language][id]	integer	*	The unique ID.
data.snippet_use_logs[][language][sys_name]	string	*	The unique sys name assigned to the language.
data.snippet_use_logs[][language][title]	string	*	Title of the language.
data.snippet_use_logs[][language][title_local]	string	*	Title of the language.
data.snippet_use_logs[][language][base_filepath]	string	*	The base filepath for default phrases for this lang.
data.snippet_use_logs[][language][locale]	string	*	The locale code.
data.snippet_use_logs[][language][flag_image]	string	*	String path to image.
data.snippet_use_logs[][language][is_rtl]	boolean	*	True if this is a right-to-left language.
data.snippet_use_logs[][language][has_user]	boolean	*	True if has user.
data.snippet_use_logs[][language][has_agent]	boolean	*	True if has agent.
data.snippet_use_logs[][language][has_admin]	boolean	*	True if has admin.
data.snippet_use_logs[][language][plural_categories][]	array of strings	*
data.snippet_use_logs[][language][plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data.snippet_use_logs[][language][flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`
data.snippet_use_logs[][person]	object (Person)	*
data.snippet_use_logs[][rating]	integer	*
data.snippet_use_logs[][rating_person]	object (Person)	*
data.snippet_use_logs[][rating_message]	string	*
data.snippet_use_logs[][date_created]	DateTime	*
data.primary_translation	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.primary_translation[id]	integer	*
data.primary_translation[ticket]	object (Ticket)	*
data.primary_translation[ticket][id]	integer	*
data.primary_translation[ticket][ref]	string	*
data.primary_translation[ticket][auth]	string	*
data.primary_translation[ticket][parent_ticket]	object (Ticket)	*	Parent ticket.
data.primary_translation[ticket][children_tickets][]	array of objects (Ticket)	*
data.primary_translation[ticket][language]	object (Language)	*	The language the ticket is in.
data.primary_translation[ticket][language][id]	integer	*	The unique ID.
data.primary_translation[ticket][language][sys_name]	string	*	The unique sys name assigned to the language.
data.primary_translation[ticket][language][title]	string	*	Title of the language.
data.primary_translation[ticket][language][title_local]	string	*	Title of the language.
data.primary_translation[ticket][language][base_filepath]	string	*	The base filepath for default phrases for this lang.
data.primary_translation[ticket][language][locale]	string	*	The locale code.
data.primary_translation[ticket][language][flag_image]	string	*	String path to image.
data.primary_translation[ticket][language][is_rtl]	boolean	*	True if this is a right-to-left language.
data.primary_translation[ticket][language][has_user]	boolean	*	True if has user.
data.primary_translation[ticket][language][has_agent]	boolean	*	True if has agent.
data.primary_translation[ticket][language][has_admin]	boolean	*	True if has admin.
data.primary_translation[ticket][language][plural_categories][]	array of strings	*
data.primary_translation[ticket][language][plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data.primary_translation[ticket][language][flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`
data.primary_translation[ticket][brand]	object (Brand)	*
data.primary_translation[ticket][brand][id]	integer	*	The unique ID.
data.primary_translation[ticket][brand][name]	string	*	The brand name.
data.primary_translation[ticket][brand][slug]	string	*
data.primary_translation[ticket][brand][url]	string	*	The brand url.
data.primary_translation[ticket][brand][theme_set]	object (ThemeSet)	*
data.primary_translation[ticket][brand][theme_set][id]	integer	*
data.primary_translation[ticket][brand][theme_set][theme_id]	string	*
data.primary_translation[ticket][brand][theme_set][title]	string	*
data.primary_translation[ticket][brand][edit_theme_set]	object (ThemeSet)	*
data.primary_translation[ticket][brand][departments][]	array of objects (Department)	*
data.primary_translation[ticket][brand][departments][][id]	integer	*
data.primary_translation[ticket][brand][departments][][parent]	object (Department)	*
data.primary_translation[ticket][brand][departments][][children][]	array of objects (Department)	*
data.primary_translation[ticket][brand][departments][][title]	string	*
data.primary_translation[ticket][brand][departments][][user_title]	string	*
data.primary_translation[ticket][brand][departments][][is_tickets_enabled]	boolean	*
data.primary_translation[ticket][brand][departments][][is_chat_enabled]	boolean	*
data.primary_translation[ticket][brand][departments][][display_order]	integer	*
data.primary_translation[ticket][brand][departments][][avatar]	object (Blob)	*
data.primary_translation[ticket][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.primary_translation[ticket][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.primary_translation[ticket][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.primary_translation[ticket][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.primary_translation[ticket][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.primary_translation[ticket][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.primary_translation[ticket][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.primary_translation[ticket][brand][departments][][avatar][authcode]	string	*
data.primary_translation[ticket][brand][departments][][avatar][blob_hash]	string	*
data.primary_translation[ticket][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.primary_translation[ticket][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.primary_translation[ticket][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.primary_translation[ticket][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.primary_translation[ticket][brand][departments][][avatar][date_created]	DateTime	*
data.primary_translation[ticket][brand][departments][][avatar][is_temp]	boolean	*
data.primary_translation[ticket][brand][departments][][avatar][source_ref]	string	*
data.primary_translation[ticket][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.primary_translation[ticket][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.primary_translation[ticket][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.primary_translation[ticket][brand][departments][][brands][]	array of objects (Brand)	*
data.primary_translation[ticket][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.primary_translation[ticket][brand][departments][][permissions][][department]	integer id (Department)	*
data.primary_translation[ticket][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.primary_translation[ticket][brand][departments][][permissions][][name]	string	*	The name of the permission.
data.primary_translation[ticket][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.primary_translation[ticket][brand][departments][][permissions][][is_active]	boolean	*
data.primary_translation[ticket][brand][departments][][chat_queue]	object (UserChatQueue)	*
data.primary_translation[ticket][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.primary_translation[ticket][brand][departments][][chat_queue][name]	string	*
data.primary_translation[ticket][brand][departments][][chat_queue][routing_model]	string	*
data.primary_translation[ticket][brand][departments][][chat_queue][answer_timeout]	integer	*
data.primary_translation[ticket][brand][departments][][chat_queue][is_all_agents]	boolean	*
data.primary_translation[ticket][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.primary_translation[ticket][brand][departments][][chat_queue][max_queue_size]	integer	*
data.primary_translation[ticket][brand][theme_sets][]	array of objects (ThemeSet)	*
data.primary_translation[ticket][department]	object (Department)	*
data.primary_translation[ticket][department][id]	integer	*
data.primary_translation[ticket][department][parent]	object (Department)	*
data.primary_translation[ticket][department][children][]	array of objects (Department)	*
data.primary_translation[ticket][department][title]	string	*
data.primary_translation[ticket][department][user_title]	string	*
data.primary_translation[ticket][department][is_tickets_enabled]	boolean	*
data.primary_translation[ticket][department][is_chat_enabled]	boolean	*
data.primary_translation[ticket][department][display_order]	integer	*
data.primary_translation[ticket][department][avatar]	object (Blob)	*
data.primary_translation[ticket][department][avatar][sys_name]	string	*	A unique system name for the blob.
data.primary_translation[ticket][department][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.primary_translation[ticket][department][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.primary_translation[ticket][department][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.primary_translation[ticket][department][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.primary_translation[ticket][department][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.primary_translation[ticket][department][avatar][file_url]	string	*	The HTTP link to download the file.
data.primary_translation[ticket][department][avatar][authcode]	string	*
data.primary_translation[ticket][department][avatar][blob_hash]	string	*
data.primary_translation[ticket][department][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.primary_translation[ticket][department][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.primary_translation[ticket][department][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.primary_translation[ticket][department][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.primary_translation[ticket][department][avatar][date_created]	DateTime	*
data.primary_translation[ticket][department][avatar][is_temp]	boolean	*
data.primary_translation[ticket][department][avatar][source_ref]	string	*
data.primary_translation[ticket][department][avatar][labels][]	array of objects (LabelBlob)	*
data.primary_translation[ticket][department][avatar][labels][][blob]	object (Blob)	*
data.primary_translation[ticket][department][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.primary_translation[ticket][department][brands][]	array of objects (Brand)	*
data.primary_translation[ticket][department][permissions][]	array of objects (DepartmentPermission)	*
data.primary_translation[ticket][department][permissions][][department]	integer id (Department)	*
data.primary_translation[ticket][department][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.primary_translation[ticket][department][permissions][][name]	string	*	The name of the permission.
data.primary_translation[ticket][department][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.primary_translation[ticket][department][permissions][][is_active]	boolean	*
data.primary_translation[ticket][department][chat_queue]	object (UserChatQueue)	*
data.primary_translation[ticket][department][chat_queue][id]	integer	*	The unique ID.
data.primary_translation[ticket][department][chat_queue][name]	string	*
data.primary_translation[ticket][department][chat_queue][routing_model]	string	*
data.primary_translation[ticket][department][chat_queue][answer_timeout]	integer	*
data.primary_translation[ticket][department][chat_queue][is_all_agents]	boolean	*
data.primary_translation[ticket][department][chat_queue][departments][]	array of objects (Department)	*
data.primary_translation[ticket][department][chat_queue][max_queue_size]	integer	*
data.primary_translation[ticket][category]	object (TicketCategory)	*
data.primary_translation[ticket][category][id]	integer	*	The unique ID.
data.primary_translation[ticket][category][parent]	integer id (TicketCategory)	*	This category parent.
data.primary_translation[ticket][category][title]	string	*	Category title.
data.primary_translation[ticket][category][display_order]	integer	*	Obviously it's display order for lists.
data.primary_translation[ticket][priority]	object (TicketPriority)	*
data.primary_translation[ticket][priority][id]	integer	*	The unique ID.
data.primary_translation[ticket][priority][title]	string	*	Priority title.
data.primary_translation[ticket][priority][priority]	integer	*	The priority itself.
data.primary_translation[ticket][workflow]	object (TicketWorkflow)	*
data.primary_translation[ticket][workflow][id]	integer	*	The unique ID.
data.primary_translation[ticket][workflow][title]	string	*	Workflow title.
data.primary_translation[ticket][workflow][display_order]	integer	*	Workflow display order.
data.primary_translation[ticket][product]	object (Product)	*
data.primary_translation[ticket][product][parent]	integer id (Product)	*	Parent of the product.
data.primary_translation[ticket][person]	object (Person)	*
data.primary_translation[ticket][person_email]	object (PersonEmail)	*
data.primary_translation[ticket][person_email][id]	integer	*	The unique ID.
data.primary_translation[ticket][person_email][person]	integer id (Person)	*	Person owner of email.
data.primary_translation[ticket][person_email][email]	string	*	The email address.
data.primary_translation[ticket][person_email][email_domain]	string	*	The email address domain.
data.primary_translation[ticket][person_email][is_validated]	boolean	*	True if validation passed.
data.primary_translation[ticket][person_email][date_created]	DateTime	*	The original time the email was created.
data.primary_translation[ticket][agent]	object (Person)	*
data.primary_translation[ticket][agent_team]	object (AgentTeam)	*
data.primary_translation[ticket][agent_team][id]	integer	*	The unique ID.
data.primary_translation[ticket][agent_team][name]	string	*	The name of agent team.
data.primary_translation[ticket][agent_team][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.primary_translation[ticket][organization]	object (Organization)	*
data.primary_translation[ticket][organization][id]	integer	*	The unique ID.
data.primary_translation[ticket][organization][picture_blob]	object (Blob)	*	The org picture.
data.primary_translation[ticket][organization][picture_blob][sys_name]	string	*	A unique system name for the blob.
data.primary_translation[ticket][organization][picture_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.primary_translation[ticket][organization][picture_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.primary_translation[ticket][organization][picture_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.primary_translation[ticket][organization][picture_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.primary_translation[ticket][organization][picture_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.primary_translation[ticket][organization][picture_blob][file_url]	string	*	The HTTP link to download the file.
data.primary_translation[ticket][organization][picture_blob][authcode]	string	*
data.primary_translation[ticket][organization][picture_blob][blob_hash]	string	*
data.primary_translation[ticket][organization][picture_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.primary_translation[ticket][organization][picture_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.primary_translation[ticket][organization][picture_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.primary_translation[ticket][organization][picture_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.primary_translation[ticket][organization][picture_blob][date_created]	DateTime	*
data.primary_translation[ticket][organization][picture_blob][is_temp]	boolean	*
data.primary_translation[ticket][organization][picture_blob][source_ref]	string	*
data.primary_translation[ticket][organization][picture_blob][labels][]	array of objects (LabelBlob)	*
data.primary_translation[ticket][organization][picture_blob][labels][][blob]	object (Blob)	*
data.primary_translation[ticket][organization][icon_property]	object (IconProperty)	*
data.primary_translation[ticket][organization][icon_property][urn]	string	*
data.primary_translation[ticket][organization][icon_property][options]	array	*
data.primary_translation[ticket][organization][name]	string	*	The organization name.
data.primary_translation[ticket][organization][summary]	string	*	The summary field as filled in by agents.
data.primary_translation[ticket][organization][importance]	integer	*	The org importance.
data.primary_translation[ticket][organization][custom_data][]	array of objects (CustomDataOrganization)	*
data.primary_translation[ticket][organization][custom_data][][organization]	object (Organization)	*
data.primary_translation[ticket][organization][custom_data][][field]	object (CustomDefOrganization)	*
data.primary_translation[ticket][organization][custom_data][][field][parent]	object (CustomDefOrganization)	*	Field`s parent.
data.primary_translation[ticket][organization][custom_data][][field][children][]	array of objects (CustomDefOrganization)	*	Field children.
data.primary_translation[ticket][organization][custom_data][][root_field]	object (CustomDefOrganization)	*
data.primary_translation[ticket][organization][usergroups][]	array of objects (Usergroup)	*	Usergroups the user belongs to.
data.primary_translation[ticket][organization][usergroups][][id]	integer	*	The unique ID, DB-generated.
data.primary_translation[ticket][organization][usergroups][][title]	string	*	Title of the usergroup.
data.primary_translation[ticket][organization][usergroups][][note]	string	*	A note or description about the usergroup.
data.primary_translation[ticket][organization][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.primary_translation[ticket][organization][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.primary_translation[ticket][organization][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.primary_translation[ticket][organization][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.primary_translation[ticket][organization][usergroups][][permissions][][id]	integer	*	The unique ID.
data.primary_translation[ticket][organization][usergroups][][permissions][][name]	string	*	The name of the permission.
data.primary_translation[ticket][organization][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.primary_translation[ticket][organization][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.primary_translation[ticket][organization][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.primary_translation[ticket][organization][usergroups][][department_permissions][][department]	integer id (Department)	*
data.primary_translation[ticket][organization][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.primary_translation[ticket][organization][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.primary_translation[ticket][organization][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.primary_translation[ticket][organization][usergroups][][department_permissions][][is_active]	boolean	*
data.primary_translation[ticket][organization][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.primary_translation[ticket][organization][auto_cc_people][]	array of objects (Person)	*	Users who are set to automatically be added to tickets and other org things.
data.primary_translation[ticket][organization][labels][]	array of objects (LabelOrganization)	*
data.primary_translation[ticket][organization][labels][][organization]	object (Organization)	*
data.primary_translation[ticket][organization][contact_data][]	array of objects (OrganizationContactData)	*
data.primary_translation[ticket][organization][emails][]	array of objects (OrganizationEmail)	*
data.primary_translation[ticket][organization][emails][][id]	integer	*	The unique log id.
data.primary_translation[ticket][organization][emails][][organization]	object (Organization)	*
data.primary_translation[ticket][organization][emails][][email]	string	*
data.primary_translation[ticket][organization][emails][][date_created]	DateTime	*
data.primary_translation[ticket][organization][email_domains][]	array of objects (OrganizationEmailDomain)	*
data.primary_translation[ticket][organization][email_domains][][domain]	string	*	The email domain.
data.primary_translation[ticket][organization][email_domains][][organization]	object (Organization)	*	The users organization.
data.primary_translation[ticket][organization][date_created]	DateTime	*	The date the org was inserted into the system.
data.primary_translation[ticket][organization][members][]	array of objects (Person)	*
data.primary_translation[ticket][organization][parent]	object (Organization)	*
data.primary_translation[ticket][organization][children][]	array of objects (Organization)	*
data.primary_translation[ticket][organization][tickets][]	array of objects (Ticket)	*
data.primary_translation[ticket][organization][organization_members][]	array of objects (OrganizationMember)	*
data.primary_translation[ticket][organization][organization_members][][id]	integer	*
data.primary_translation[ticket][organization][organization_members][][person]	integer id (Person)	*
data.primary_translation[ticket][organization][organization_members][][organization]	integer id (Organization)	*
data.primary_translation[ticket][organization][organization_members][][is_manager]	boolean	*
data.primary_translation[ticket][organization][organization_members][][position]	string	*
data.primary_translation[ticket][organization][organization_members][][created_at]	DateTime	*
data.primary_translation[ticket][organization][organization_members][][updated_at]	DateTime	*
data.primary_translation[ticket][linked_chat]	object (ChatConversation)	*
data.primary_translation[ticket][linked_chat][id]	integer	*	The unique id of chat conversation.
data.primary_translation[ticket][linked_chat][department]	object (Department)	*	Department which chat was assigned.
data.primary_translation[ticket][linked_chat][brand]	object (Brand)	*	Department which chat was assigned.
data.primary_translation[ticket][linked_chat][task_id]	integer	*
data.primary_translation[ticket][linked_chat][ticket]	object (Ticket)	*
data.primary_translation[ticket][linked_chat][labels][]	array of objects (LabelChatConversation)	*
data.primary_translation[ticket][linked_chat][labels][][chat]	object (ChatConversation)	*
data.primary_translation[ticket][linked_chat][subject]	string	*	Subject of the chat conversation.
data.primary_translation[ticket][linked_chat][status]	string	*	Status of the chat conversation.
data.primary_translation[ticket][linked_chat][agent]	object (Person)	*	If this is a user conversation, this is the agent assigned.
data.primary_translation[ticket][linked_chat][agent_team]	object (AgentTeam)	*	If this is a team chat, the team it is.
data.primary_translation[ticket][linked_chat][person]	object (Person)	*	If this is a user conversation, this is the user who started the chat.
data.primary_translation[ticket][linked_chat][session]	object (Session)	*	If this is a user convo, this is the users session.
data.primary_translation[ticket][linked_chat][session][id]	integer	*	The unique ID.
data.primary_translation[ticket][linked_chat][session][auth]	string	*	The authcode for the session to verify an id.
data.primary_translation[ticket][linked_chat][session][interface]	string	*	The Interface the session is for.
data.primary_translation[ticket][linked_chat][session][person]	object (Person)	*
data.primary_translation[ticket][linked_chat][session][user_agent]	string	*	The users user agent string.
data.primary_translation[ticket][linked_chat][session][visitor_id]	string	*
data.primary_translation[ticket][linked_chat][session][ip_address]	string	*	The users IP address.
data.primary_translation[ticket][linked_chat][session][data]	string	*
data.primary_translation[ticket][linked_chat][session][is_person]	boolean	*
data.primary_translation[ticket][linked_chat][session][is_bot]	boolean	*
data.primary_translation[ticket][linked_chat][session][is_helpdesk]	boolean	*
data.primary_translation[ticket][linked_chat][session][active_status]	string	*	(Agents) Status (available or away).
data.primary_translation[ticket][linked_chat][session][is_chat_available]	boolean	*	(Agents) Wehn status is available, if they are available for chat.
data.primary_translation[ticket][linked_chat][session][date_created]	DateTime	*
data.primary_translation[ticket][linked_chat][session][date_last]	DateTime	*
data.primary_translation[ticket][linked_chat][session][date_last_page]	DateTime	*
data.primary_translation[ticket][linked_chat][visitor_id]	string	*
data.primary_translation[ticket][linked_chat][person_name]	string	*	User chat: The users name, if they arent a person.
data.primary_translation[ticket][linked_chat][person_email]	string	*	User chat: The users email, if they aren`t a person.
data.primary_translation[ticket][linked_chat][participants][]	array of objects (Person)	*
data.primary_translation[ticket][linked_chat][messages][]	array of objects (ChatMessage)	*
data.primary_translation[ticket][linked_chat][messages][][id]	integer	*	The unique ID.
data.primary_translation[ticket][linked_chat][messages][][author_id]	integer	*	Author id (legacy).
data.primary_translation[ticket][linked_chat][messages][][author_type]	string	*	Author type (legacy).
data.primary_translation[ticket][linked_chat][messages][][conversation_id]	integer	*	Conversation id (legacy).
data.primary_translation[ticket][linked_chat][messages][][author]	integer id (Person)	*	Person who created the message.
data.primary_translation[ticket][linked_chat][messages][][content]	string	*	The message.
data.primary_translation[ticket][linked_chat][messages][][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.primary_translation[ticket][linked_chat][messages][][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.primary_translation[ticket][linked_chat][messages][][is_html]	boolean	*	Is the content an HTML message?
data.primary_translation[ticket][linked_chat][messages][][metadata]	array	*	Additional data.
data.primary_translation[ticket][linked_chat][messages][][date_created]	DateTime	*	Date message was created.
data.primary_translation[ticket][linked_chat][messages][][date_received]	DateTime	*	Date message was received.
data.primary_translation[ticket][linked_chat][custom_data][]	array of objects (CustomDataChat)	*
data.primary_translation[ticket][linked_chat][custom_data][][conversation]	object (ChatConversation)	*	The conversation the message belongs to.
data.primary_translation[ticket][linked_chat][custom_data][][field]	object (CustomDefChat)	*
data.primary_translation[ticket][linked_chat][custom_data][][field][parent]	object (CustomDefChat)	*
data.primary_translation[ticket][linked_chat][custom_data][][field][children][]	array of objects (CustomDefChat)	*	Field children.
data.primary_translation[ticket][linked_chat][custom_data][][root_field]	object (CustomDefChat)	*
data.primary_translation[ticket][linked_chat][rating_response_time]	integer	*
data.primary_translation[ticket][linked_chat][rating_overall]	integer	*
data.primary_translation[ticket][linked_chat][rating_comment]	string	*
data.primary_translation[ticket][linked_chat][is_agent]	boolean	*	Is this an agent chat.
data.primary_translation[ticket][linked_chat][is_window]	boolean	*	If the chat is popped out into a window. This is used to make sure the JS widget on pages doesn't load again.
data.primary_translation[ticket][linked_chat][date_created]	DateTime	*	Date when chat was started.
data.primary_translation[ticket][linked_chat][date_user_waiting]	DateTime	*	Since when the user has started waiting (i.e., time the assignment was 0).
data.primary_translation[ticket][linked_chat][date_assigned]	DateTime	*
data.primary_translation[ticket][linked_chat][date_agent_typing]	DateTime	*	Date when agent typed last time.
data.primary_translation[ticket][linked_chat][date_first_agent_message]	DateTime	*
data.primary_translation[ticket][linked_chat][date_ended]	DateTime	*	Date when chat was ended.
data.primary_translation[ticket][linked_chat][total_to_ended]	integer	*
data.primary_translation[ticket][linked_chat][ended_by]	string	*	Who ended the chat.
data.primary_translation[ticket][linked_chat][should_send_transcript]	boolean	*	True if transcript should be send.
data.primary_translation[ticket][linked_chat][date_transcript_sent]	DateTime	*	Date when transcript was sent.
data.primary_translation[ticket][linked_chat][email_validation_code]	string	*
data.primary_translation[ticket][linked_chat][email_validated]	boolean	*
data.primary_translation[ticket][linked_chat][access_token]	string	*
data.primary_translation[ticket][attachments][]	array of objects (TicketAttachment)	*
data.primary_translation[ticket][access_codes][]	array of objects (TicketAccessCode)	*
data.primary_translation[ticket][access_codes][][id]	integer	*
data.primary_translation[ticket][access_codes][][ticket]	object (Ticket)	*
data.primary_translation[ticket][access_codes][][person]	object (Person)	*
data.primary_translation[ticket][access_codes][][auth]	string	*
data.primary_translation[ticket][messages][]	array of objects (TicketMessage)	*
data.primary_translation[ticket][messages][][id]	integer	*	The unique id of message.
data.primary_translation[ticket][messages][][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data.primary_translation[ticket][messages][][person]	object (Person)	*	Person this message was sent by.
data.primary_translation[ticket][messages][][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data.primary_translation[ticket][messages][][email_source][id]	integer	*
data.primary_translation[ticket][messages][][email_source][uuid]	string	*
data.primary_translation[ticket][messages][][email_source][blob]	object (Blob)	*
data.primary_translation[ticket][messages][][email_source][blob][sys_name]	string	*	A unique system name for the blob.
data.primary_translation[ticket][messages][][email_source][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.primary_translation[ticket][messages][][email_source][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.primary_translation[ticket][messages][][email_source][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.primary_translation[ticket][messages][][email_source][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.primary_translation[ticket][messages][][email_source][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.primary_translation[ticket][messages][][email_source][blob][file_url]	string	*	The HTTP link to download the file.
data.primary_translation[ticket][messages][][email_source][blob][authcode]	string	*
data.primary_translation[ticket][messages][][email_source][blob][blob_hash]	string	*
data.primary_translation[ticket][messages][][email_source][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.primary_translation[ticket][messages][][email_source][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.primary_translation[ticket][messages][][email_source][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.primary_translation[ticket][messages][][email_source][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.primary_translation[ticket][messages][][email_source][blob][date_created]	DateTime	*
data.primary_translation[ticket][messages][][email_source][blob][is_temp]	boolean	*
data.primary_translation[ticket][messages][][email_source][blob][source_ref]	string	*
data.primary_translation[ticket][messages][][email_source][blob][labels][]	array of objects (LabelBlob)	*
data.primary_translation[ticket][messages][][email_source][blob][labels][][blob]	object (Blob)	*
data.primary_translation[ticket][messages][][email_source][object_type]	string	*	The type of object this is attached to (should be the table name of the super type, eg: tickets, people, organizations). This typically is not set until after the email is processed (ie the status is 'processed').
data.primary_translation[ticket][messages][][email_source][object_id]	integer	*	The ID of the object this is attached to.
data.primary_translation[ticket][messages][][email_source][from_email]	string	*
data.primary_translation[ticket][messages][][email_source][status]	string	*	The current status of the message: - inserted: Only inserted - processing: Currently processing - complete: Fully processed - error: Tried to process but there was some kind of error (see error_code).
data.primary_translation[ticket][messages][][email_source][date_status]	DateTime	*
data.primary_translation[ticket][messages][][email_source][error_code]	string	*	When status is error, this is the code that describes the error.
data.primary_translation[ticket][messages][][email_source][date_created]	DateTime	*
data.primary_translation[ticket][messages][][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.primary_translation[ticket][messages][][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.primary_translation[ticket][messages][][date_created]	DateTime	*	Date when message was created.
data.primary_translation[ticket][messages][][is_agent_note]	boolean	*	Is this message agent note?
data.primary_translation[ticket][messages][][is_hidden]	boolean	*	Is this message hidden?
data.primary_translation[ticket][messages][][creation_system]	string	*	How this message was created.
data.primary_translation[ticket][messages][][ip_address]	string	*	An ip address from which message was sent.
data.primary_translation[ticket][messages][][visitor_id]	string	*	Unique ID of visitor left this message.
data.primary_translation[ticket][messages][][hostname]	string	*	Host from which message was left.
data.primary_translation[ticket][messages][][geo_country]	string	*	Country message is from (deprecated).
data.primary_translation[ticket][messages][][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.primary_translation[ticket][messages][][message_hash]	string	*	An unique hash of message.
data.primary_translation[ticket][messages][][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.primary_translation[ticket][messages][][message]	string	*	The message, will be in HTML!
data.primary_translation[ticket][messages][][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.primary_translation[ticket][messages][][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.primary_translation[ticket][messages][][message_source]	string	*	The message source.
data.primary_translation[ticket][messages][][message_source_type]	string	*	The message source type.
data.primary_translation[ticket][messages][][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.primary_translation[ticket][messages][][lang_code]	string	*	The set/detected lang code.
data.primary_translation[ticket][messages][][email_message_id][]	array of objects (TicketMessageEmailId)	*
data.primary_translation[ticket][messages][][email_message_id][][id]	integer	*
data.primary_translation[ticket][messages][][email_message_id][][message]	object (TicketMessage)	*
data.primary_translation[ticket][messages][][email_message_id][][email_id]	string	*
data.primary_translation[ticket][messages][][ticket_feedback][]	array of objects (TicketFeedback)	*
data.primary_translation[ticket][messages][][ticket_feedback][][id]	integer	*
data.primary_translation[ticket][messages][][ticket_feedback][][ticket]	object (Ticket)	*
data.primary_translation[ticket][messages][][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data.primary_translation[ticket][messages][][ticket_feedback][][person]	object (Person)	*
data.primary_translation[ticket][messages][][ticket_feedback][][rating]	integer	*
data.primary_translation[ticket][messages][][ticket_feedback][][message]	string	*
data.primary_translation[ticket][messages][][ticket_feedback][][date_created]	DateTime	*
data.primary_translation[ticket][messages][][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][id]	integer	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][subject]	string	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][from_email]	string	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][tos]	array	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][ccs]	array	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][bccs]	array	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][message]	string	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][authcode]	string	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][blob_hash]	string	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][source_ref]	string	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data.primary_translation[ticket][messages][][ticket_message_forwards][][date_created]	DateTime	*
data.primary_translation[ticket][messages][][channel_message]	object (TicketMessageChannelMessage)	*
data.primary_translation[ticket][messages][][channel_message][id]	integer	*	@var int The unique id of message.
data.primary_translation[ticket][messages][][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data.primary_translation[ticket][messages][][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data.primary_translation[ticket][messages][][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data.primary_translation[ticket][messages][][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data.primary_translation[ticket][messages][][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data.primary_translation[ticket][messages][][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data.primary_translation[ticket][messages][][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data.primary_translation[ticket][messages][][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data.primary_translation[ticket][messages][][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data.primary_translation[ticket][sms_messages][]	array of objects (TicketSms)	*
data.primary_translation[ticket][sms_messages][][id]	integer	*
data.primary_translation[ticket][sms_messages][][ticket]	object (Ticket)	*
data.primary_translation[ticket][sms_messages][][person]	object (Person)	*
data.primary_translation[ticket][sms_messages][][sms_account]	object (SmsAccount)	*
data.primary_translation[ticket][sms_messages][][sms_account][id]	integer	*	The unique ID.
data.primary_translation[ticket][sms_messages][][sms_account][type]	string	*
data.primary_translation[ticket][sms_messages][][sms_account][params]	array	*
data.primary_translation[ticket][sms_messages][][sms_account][identifier]	string	*
data.primary_translation[ticket][sms_messages][][sms_account][is_enabled]	boolean	*
data.primary_translation[ticket][sms_messages][][sms_account][is_connected]	boolean	*
data.primary_translation[ticket][sms_messages][][sms_account][is_tested]	boolean	*
data.primary_translation[ticket][sms_messages][][sms_account][test_code]	string	*
data.primary_translation[ticket][sms_messages][][job]	object (Job)	*
data.primary_translation[ticket][sms_messages][][job][id]	integer	*	The unique job id.
data.primary_translation[ticket][sms_messages][][job][type]	string	*	The job type, used by the Job Router to find the right Job Processor.
data.primary_translation[ticket][sms_messages][][job][status]	string	*	The status of the job.
data.primary_translation[ticket][sms_messages][][job][status_code]	string	*	Any code to further classify the status.
data.primary_translation[ticket][sms_messages][][job][date_touch]	DateTime	*	Date the last time a process "touched" this ticket.
data.primary_translation[ticket][sms_messages][][job][date_created]	DateTime	*	Date this job entered the "jobs" table.
data.primary_translation[ticket][sms_messages][][job][date_last_try]	DateTime	*	Last time we processed this job.
data.primary_translation[ticket][sms_messages][][job][date_next_try]	DateTime	*	If this DateTime is in the future, it won't be selected for execution.
data.primary_translation[ticket][sms_messages][][job][num_tries]	integer	*	The number of times this job has been executed Job Processor (usually indicated failures if > 1).
data.primary_translation[ticket][sms_messages][][job][log_summary]	string	*	A human readable summary of the job's execution.
data.primary_translation[ticket][sms_messages][][job][log]	string	*	A more verbose log.
data.primary_translation[ticket][sms_messages][][job][data]	array	*	An array of data, or payload, that the job processor needs to execute this job (stored in the db as json). This MUST always be an array, even if its an empty array
data.primary_translation[ticket][sms_messages][][job][original_job]	integer	*	Null unless the job was created as a retry - if so, the originating job ID is stored here so we can query it later. Note: You MUST specify the originating job, do not create a linked list of failed jobs.
data.primary_translation[ticket][sms_messages][][date_created]	DateTime	*
data.primary_translation[ticket][sms_messages][][from_number]	string	*	Permanent record of the phone number that sent this SMS. (Won't change even if Person changes their phone number).
data.primary_translation[ticket][sms_messages][][to_number]	string	*	Permanent record of the phone number that this SMS was sent to.
data.primary_translation[ticket][sms_messages][][message]	string	*	The SMS message.
data.primary_translation[ticket][sms_messages][][direction]	string	*	Just a system flag for reporting.
data.primary_translation[ticket][topic_links][]	array of objects (TicketCommunityTopicLink)	*
data.primary_translation[ticket][topic_links][][id]	integer	*	The unique filter ID.
data.primary_translation[ticket][topic_links][][ticket]	integer id (Ticket)	*
data.primary_translation[ticket][topic_links][][topic]	integer id (CommunityTopic)	*
data.primary_translation[ticket][topic_links][][person]	integer id (Person)	*
data.primary_translation[ticket][topic_links][][date_created]	DateTime	*
data.primary_translation[ticket][custom_data][]	array of objects (CustomDataTicket)	*
data.primary_translation[ticket][custom_data][][ticket]	object (Ticket)	*
data.primary_translation[ticket][custom_data][][field]	object (CustomDefTicket)	*
data.primary_translation[ticket][custom_data][][field][parent]	object (CustomDefTicket)	*
data.primary_translation[ticket][custom_data][][field][children][]	array of objects (CustomDefTicket)	*	Field children.
data.primary_translation[ticket][custom_data][][root_field]	object (CustomDefTicket)	*
data.primary_translation[ticket][labels][]	array of objects (LabelTicket)	*
data.primary_translation[ticket][labels][][ticket]	object (Ticket)	*
data.primary_translation[ticket][sent_to_address]	string	*	The email address the ticket was sent to if it came in via a gateway. This is a full string (e.g., including CC's) of the original.
data.primary_translation[ticket][email_account]	object (EmailAccount)	*	The gateway this ticket originated from.
data.primary_translation[ticket][email_account][id]	integer	*
data.primary_translation[ticket][email_account][account_type]	string	*
data.primary_translation[ticket][email_account][is_enabled]	boolean	*
data.primary_translation[ticket][email_account][address]	string	*
data.primary_translation[ticket][email_account][cert_blob]	object (Blob)	*
data.primary_translation[ticket][email_account][cert_blob][sys_name]	string	*	A unique system name for the blob.
data.primary_translation[ticket][email_account][cert_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.primary_translation[ticket][email_account][cert_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.primary_translation[ticket][email_account][cert_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.primary_translation[ticket][email_account][cert_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.primary_translation[ticket][email_account][cert_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.primary_translation[ticket][email_account][cert_blob][file_url]	string	*	The HTTP link to download the file.
data.primary_translation[ticket][email_account][cert_blob][authcode]	string	*
data.primary_translation[ticket][email_account][cert_blob][blob_hash]	string	*
data.primary_translation[ticket][email_account][cert_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.primary_translation[ticket][email_account][cert_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.primary_translation[ticket][email_account][cert_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.primary_translation[ticket][email_account][cert_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.primary_translation[ticket][email_account][cert_blob][date_created]	DateTime	*
data.primary_translation[ticket][email_account][cert_blob][is_temp]	boolean	*
data.primary_translation[ticket][email_account][cert_blob][source_ref]	string	*
data.primary_translation[ticket][email_account][cert_blob][labels][]	array of objects (LabelBlob)	*
data.primary_translation[ticket][email_account][cert_blob][labels][][blob]	object (Blob)	*
data.primary_translation[ticket][email_account][key_blob]	object (Blob)	*
data.primary_translation[ticket][email_account_address]	string	*	The email address (from list of to/cc) that matched with the email account.
data.primary_translation[ticket][creation_system]	string	*
data.primary_translation[ticket][creation_system_option]	string	*	Optional information about the creation system. For example, source URL the ticket came from.
data.primary_translation[ticket][ticket_hash]	string	*
data.primary_translation[ticket][status]	string	*
data.primary_translation[ticket][ticket_status]	object (TicketStatus)	*
data.primary_translation[ticket][ticket_status][id]	integer	*
data.primary_translation[ticket][ticket_status][status_type]	string	*
data.primary_translation[ticket][ticket_status][status_code]	string	*
data.primary_translation[ticket][ticket_status][sys_id]	string	*
data.primary_translation[ticket][ticket_status][title]	string	*
data.primary_translation[ticket][ticket_status][display_order]	integer	*
data.primary_translation[ticket][ticket_status][pending_waiting_time_mode]	string	*	Where to count time spending in pending status. Check PENDING_WAITING_TIME_MODE_ constants
data.primary_translation[ticket][ticket_status][children][]	array of objects (TicketStatus)	*
data.primary_translation[ticket][ticket_status][options]	array	*
data.primary_translation[ticket][urgency]	integer	*
data.primary_translation[ticket][feedback_rating]	integer	*
data.primary_translation[ticket][date_feedback_rating]	DateTime	*
data.primary_translation[ticket][date_created]	DateTime	*
data.primary_translation[ticket][date_resolved]	DateTime	*
data.primary_translation[ticket][date_archived]	DateTime	*
data.primary_translation[ticket][date_first_agent_assign]	DateTime	*
data.primary_translation[ticket][date_first_agent_reply]	DateTime	*
data.primary_translation[ticket][date_last_agent_reply]	DateTime	*
data.primary_translation[ticket][date_last_user_reply]	DateTime	*
data.primary_translation[ticket][date_agent_waiting]	DateTime	*
data.primary_translation[ticket][date_user_waiting]	DateTime	*
data.primary_translation[ticket][date_status]	DateTime	*
data.primary_translation[ticket][date_on_hold]	DateTime	*
data.primary_translation[ticket][total_user_waiting]	integer	*
data.primary_translation[ticket][total_to_first_reply]	integer	*
data.primary_translation[ticket][total_user_waiting_wh_start]	DateTime	*
data.primary_translation[ticket][total_user_waiting_wh]	integer	*
data.primary_translation[ticket][total_to_first_reply_wh]	integer	*
data.primary_translation[ticket][locked_by_agent]	object (Person)	*
data.primary_translation[ticket][date_locked]	DateTime	*
data.primary_translation[ticket][has_attachments]	boolean	*
data.primary_translation[ticket][subject]	string	*
data.primary_translation[ticket][original_subject]	string	*
data.primary_translation[ticket][properties]	array	*
data.primary_translation[ticket][count_agent_replies]	integer	*
data.primary_translation[ticket][count_user_replies]	integer	*
data.primary_translation[ticket][worst_sla_status]	string	*
data.primary_translation[ticket][waiting_times]	array	*	Used to track ticket status changes and how much time ticket was in status Add new item every time status changed This is optimisation over TicketLog.
data.primary_translation[ticket][participants][]	array of objects (TicketParticipant)	*
data.primary_translation[ticket][participants][][id]	integer	*
data.primary_translation[ticket][participants][][ticket]	object (Ticket)	*
data.primary_translation[ticket][participants][][person]	object (Person)	*
data.primary_translation[ticket][participants][][access_code]	object (TicketAccessCode)	*
data.primary_translation[ticket][participants][][person_email]	object (PersonEmail)	*
data.primary_translation[ticket][participants][][default_on]	boolean	*	Default checkbox status of the user.
data.primary_translation[ticket][charges][]	array of objects (TicketCharge)	*
data.primary_translation[ticket][charges][][id]	integer	*
data.primary_translation[ticket][charges][][charge_time]	integer	*
data.primary_translation[ticket][charges][][amount]	float	*
data.primary_translation[ticket][charges][][date_created]	DateTime	*
data.primary_translation[ticket][charges][][ticket]	object (Ticket)	*
data.primary_translation[ticket][charges][][person]	object (Person)	*
data.primary_translation[ticket][charges][][organization]	object (Organization)	*
data.primary_translation[ticket][charges][][agent]	object (Person)	*
data.primary_translation[ticket][charges][][custom_data][]	array of objects (CustomDataBilling)	*
data.primary_translation[ticket][charges][][custom_data][][ticket_charge]	object (TicketCharge)	*
data.primary_translation[ticket][charges][][custom_data][][field]	object (CustomDefBilling)	*
data.primary_translation[ticket][charges][][custom_data][][field][parent]	object (CustomDefBilling)	*
data.primary_translation[ticket][charges][][custom_data][][field][children][]	array of objects (CustomDefBilling)	*	Field children.
data.primary_translation[ticket][charges][][custom_data][][root_field]	object (CustomDefBilling)	*
data.primary_translation[ticket][ticket_slas][]	array of objects (TicketSla)	*
data.primary_translation[ticket][ticket_slas][][id]	integer	*	The unique ID.
data.primary_translation[ticket][ticket_slas][][sla_status]	string	*	The SLA status.
data.primary_translation[ticket][ticket_slas][][warn_date]	DateTime	*	The SLA warn date.
data.primary_translation[ticket][ticket_slas][][fail_date]	DateTime	*	The SLA fail date.
data.primary_translation[ticket][ticket_slas][][is_completed]	boolean	*	Is the SLA completed?
data.primary_translation[ticket][ticket_slas][][is_completed_set]	boolean	*	Completed by automated action.
data.primary_translation[ticket][ticket_slas][][completed_time_taken]	integer	*	Time taken.
data.primary_translation[ticket][ticket_slas][][ticket]	integer id (Ticket)	*	Ticket.
data.primary_translation[ticket][ticket_slas][][sla]	integer id (Sla)	*	SLA.
data.primary_translation[ticket][ticket_slas][][date_applied]	DateTime	*	time and date when SLA was applied to the ticket.
data.primary_translation[ticket][ticket_slas][][date_completed]	DateTime	*	time when SLA status became OK.
data.primary_translation[ticket][jira_issues][]	array of objects (JiraIssue)	*	linked jira issues.
data.primary_translation[ticket][jira_issues][][id]	integer	*	The unique ID.
data.primary_translation[ticket][jira_issues][][ticket]	object (Ticket)	*	The associated DeskPRO ticket.
data.primary_translation[ticket][jira_issues][][issue_id]	integer	*
data.primary_translation[ticket][jira_issues][][status_id]	integer	*
data.primary_translation[ticket][jira_issues][][created]	DateTime	*	Export time.
data.primary_translation[ticket][problems][]	array of objects (Problem)	*
data.primary_translation[ticket][problems][][id]	integer	*	The unique ID.
data.primary_translation[ticket][problems][][title]	string	*	Problem title.
data.primary_translation[ticket][problems][][creator]	integer id (Person)	*	Person who created the problem.
data.primary_translation[ticket][problems][][created]	DateTime	*	Date when the problem was created.
data.primary_translation[ticket][problems][][is_open]	boolean	*	Is problem still has no solution?
data.primary_translation[ticket][problems][][tickets][]	array of integer ids (Ticket)	*	Tickets associated with problem.
data.primary_translation[ticket][stars][]	array of objects (TicketFlagged)	*
data.primary_translation[ticket][stars][][ticket]	object (Ticket)	*
data.primary_translation[ticket][stars][][person_id]	integer	*
data.primary_translation[ticket][stars][][color]	string	*
data.primary_translation[ticket][follow_ups][]	array of objects (TicketFollowUp)	*
data.primary_translation[ticket][follow_ups][][id]	integer	*	The unique ID.
data.primary_translation[ticket][follow_ups][][person]	integer id (Person)	*
data.primary_translation[ticket][follow_ups][][actions]	array	*
data.primary_translation[ticket][follow_ups][][cancel_if_user_reply]	boolean	*
data.primary_translation[ticket][follow_ups][][cancel_if_agent_reply]	boolean	*
data.primary_translation[ticket][follow_ups][][status]	string	*
data.primary_translation[ticket][follow_ups][][date_created]	DateTime	*
data.primary_translation[ticket][follow_ups][][date_to_run]	DateTime	*
data.primary_translation[ticket][follow_ups][][date_did_run]	DateTime	*
data.primary_translation[ticket][logs][]	array of objects (TicketLog)	*
data.primary_translation[ticket][logs][][id]	integer	*
data.primary_translation[ticket][logs][][parent]	object (TicketLog)	*
data.primary_translation[ticket][logs][][ticket]	object (Ticket)	*
data.primary_translation[ticket][logs][][person]	object (Person)	*
data.primary_translation[ticket][logs][][action_type]	string	*
data.primary_translation[ticket][logs][][id_object]	integer	*	If the log involves a specific thing in a ticket (eg a message that was moved), then that is this id.
data.primary_translation[ticket][logs][][id_before]	integer	*	The ID of the previous entity changed, or any other numeric value.
data.primary_translation[ticket][logs][][id_after]	integer	*	The ID of the new entity, or any other numeric value.
data.primary_translation[ticket][logs][][trigger_id]	integer	*	If the change was caused by a trigger, the trigger id. Note this is the integer ID (not a FK relation) so the record is kept even if the trigger itself is deleted.
data.primary_translation[ticket][logs][][escalation_id]	integer	*	If the change was caused by an escalation Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.primary_translation[ticket][logs][][macro_id]	integer	*	If the change was caused by an v2 macro Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.primary_translation[ticket][logs][][sla]	object (Sla)	*	If the change was caused by an SLA, the SLA.
data.primary_translation[ticket][logs][][sla][id]	integer	*	The unique ID.
data.primary_translation[ticket][logs][][sla][title]	string	*	SLA title.
data.primary_translation[ticket][logs][][sla][sla_type]	string	*	Type of SLA - first_response, resolution, waiting_time.
data.primary_translation[ticket][logs][][sla][active_time]	string	*	Whether active all the time (all) or during work hours only (work_hours) or use the default ticket-wide settings (default).
data.primary_translation[ticket][logs][][sla][work_start]	integer	*	When the work day starts. This is stored as the number of seconds after 00:00:00.
data.primary_translation[ticket][logs][][sla][work_end]	integer	*	When the work day ends. This is stored as the number of seconds after 00:00:00.
data.primary_translation[ticket][logs][][sla][work_days]	array	*	Array of work days, stored with keys corresponding to day numbers. Values are true. 0 = Sunday, 6 = Saturday (same as PHP, easy to convert to MySQL which is 1 = Sunday, 7 = Saturday).
data.primary_translation[ticket][logs][][sla][work_timezone]	string	*	Timezone for work hours/days to be considered in.
data.primary_translation[ticket][logs][][sla][work_holidays]	array	*	List of work holidays.
data.primary_translation[ticket][logs][][sla][apply_type]	string	*	Controls how the SLA is applied to tickets: all, terms, terms_before_triggers, manual.
data.primary_translation[ticket][logs][][sla][apply_terms]	object (TriggerTerms)	*	Conditions to apply.
data.primary_translation[ticket][logs][][sla][apply_terms][version]	integer	*	Terms version.
data.primary_translation[ticket][logs][][sla][apply_terms][terms]	array	*	Terms themselves.
data.primary_translation[ticket][logs][][sla][trigger_terms]	object (TriggerTerms)	*	Conditions to consider sla completed.
data.primary_translation[ticket][logs][][sla][warn_time]	integer	*	Warn time integer.
data.primary_translation[ticket][logs][][sla][warn_time_unit]	string	*	And it's unit (see warn time).
data.primary_translation[ticket][logs][][sla][warn_actions]	object (TriggerActions)	*	How to warn about SLA will fail.
data.primary_translation[ticket][logs][][sla][warn_actions][version]	integer	*	Actions version.
data.primary_translation[ticket][logs][][sla][warn_actions][actions]	array	*	Actions array representation.
data.primary_translation[ticket][logs][][sla][fail_time]	integer	*	Fail time integer.
data.primary_translation[ticket][logs][][sla][fail_time_unit]	string	*	And it's measuring unit (see fail_time).
data.primary_translation[ticket][logs][][sla][fail_actions]	object (TriggerActions)	*	What to do if SLA failed.
data.primary_translation[ticket][logs][][sla][exclude_ticket_statuses]	array	*	This SLA will not apply while tickets are in these pending statuses.
data.primary_translation[ticket][logs][][sla_status]	string	*
data.primary_translation[ticket][logs][][details]	array	*
data.primary_translation[ticket][logs][][date_created]	DateTime	*
data.primary_translation[ticket][chats][]	array of objects (ChatConversation)	*
data.primary_translation[ticket][created_with_channel]	string	*
data.primary_translation[ticket][last_channel_used]	string	*
data.primary_translation[ticket][channels]	array	*
data.primary_translation[ticket][pending_articles][]	array of objects (ArticlePendingCreate)	*
data.primary_translation[ticket][pending_articles][][id]	integer	*
data.primary_translation[ticket][pending_articles][][person]	integer id (Person)	*
data.primary_translation[ticket][pending_articles][][assigned_person]	integer id (Person)	*
data.primary_translation[ticket][pending_articles][][ticket]	integer id (Ticket)	*
data.primary_translation[ticket][pending_articles][][message]	integer id (TicketMessage)	*
data.primary_translation[ticket][pending_articles][][comment]	string	*
data.primary_translation[ticket][pending_articles][][date_created]	DateTime	*
data.primary_translation[ticket][summary]	object (TicketSummary)	*
data.primary_translation[ticket][summary][id]	integer	*
data.primary_translation[ticket][summary][ticket]	object (Ticket)	*
data.primary_translation[ticket][summary][summary]	string	*
data.primary_translation[ticket][summary][summary_input]	string	*
data.primary_translation[ticket][summary][date_created]	DateTime	*
data.primary_translation[ticket_message]	object (TicketMessage)	*
data.primary_translation[ticket_message][id]	integer	*	The unique id of message.
data.primary_translation[ticket_message][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data.primary_translation[ticket_message][person]	object (Person)	*	Person this message was sent by.
data.primary_translation[ticket_message][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data.primary_translation[ticket_message][email_source][id]	integer	*
data.primary_translation[ticket_message][email_source][uuid]	string	*
data.primary_translation[ticket_message][email_source][blob]	object (Blob)	*
data.primary_translation[ticket_message][email_source][blob][sys_name]	string	*	A unique system name for the blob.
data.primary_translation[ticket_message][email_source][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.primary_translation[ticket_message][email_source][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.primary_translation[ticket_message][email_source][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.primary_translation[ticket_message][email_source][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.primary_translation[ticket_message][email_source][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.primary_translation[ticket_message][email_source][blob][file_url]	string	*	The HTTP link to download the file.
data.primary_translation[ticket_message][email_source][blob][authcode]	string	*
data.primary_translation[ticket_message][email_source][blob][blob_hash]	string	*
data.primary_translation[ticket_message][email_source][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.primary_translation[ticket_message][email_source][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.primary_translation[ticket_message][email_source][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.primary_translation[ticket_message][email_source][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.primary_translation[ticket_message][email_source][blob][date_created]	DateTime	*
data.primary_translation[ticket_message][email_source][blob][is_temp]	boolean	*
data.primary_translation[ticket_message][email_source][blob][source_ref]	string	*
data.primary_translation[ticket_message][email_source][blob][labels][]	array of objects (LabelBlob)	*
data.primary_translation[ticket_message][email_source][blob][labels][][blob]	object (Blob)	*
data.primary_translation[ticket_message][email_source][object_type]	string	*	The type of object this is attached to (should be the table name of the super type, eg: tickets, people, organizations). This typically is not set until after the email is processed (ie the status is 'processed').
data.primary_translation[ticket_message][email_source][object_id]	integer	*	The ID of the object this is attached to.
data.primary_translation[ticket_message][email_source][from_email]	string	*
data.primary_translation[ticket_message][email_source][status]	string	*	The current status of the message: - inserted: Only inserted - processing: Currently processing - complete: Fully processed - error: Tried to process but there was some kind of error (see error_code).
data.primary_translation[ticket_message][email_source][date_status]	DateTime	*
data.primary_translation[ticket_message][email_source][error_code]	string	*	When status is error, this is the code that describes the error.
data.primary_translation[ticket_message][email_source][date_created]	DateTime	*
data.primary_translation[ticket_message][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.primary_translation[ticket_message][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.primary_translation[ticket_message][date_created]	DateTime	*	Date when message was created.
data.primary_translation[ticket_message][is_agent_note]	boolean	*	Is this message agent note?
data.primary_translation[ticket_message][is_hidden]	boolean	*	Is this message hidden?
data.primary_translation[ticket_message][creation_system]	string	*	How this message was created.
data.primary_translation[ticket_message][ip_address]	string	*	An ip address from which message was sent.
data.primary_translation[ticket_message][visitor_id]	string	*	Unique ID of visitor left this message.
data.primary_translation[ticket_message][hostname]	string	*	Host from which message was left.
data.primary_translation[ticket_message][geo_country]	string	*	Country message is from (deprecated).
data.primary_translation[ticket_message][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.primary_translation[ticket_message][message_hash]	string	*	An unique hash of message.
data.primary_translation[ticket_message][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.primary_translation[ticket_message][message]	string	*	The message, will be in HTML!
data.primary_translation[ticket_message][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.primary_translation[ticket_message][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.primary_translation[ticket_message][message_source]	string	*	The message source.
data.primary_translation[ticket_message][message_source_type]	string	*	The message source type.
data.primary_translation[ticket_message][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.primary_translation[ticket_message][lang_code]	string	*	The set/detected lang code.
data.primary_translation[ticket_message][email_message_id][]	array of objects (TicketMessageEmailId)	*
data.primary_translation[ticket_message][email_message_id][][id]	integer	*
data.primary_translation[ticket_message][email_message_id][][message]	object (TicketMessage)	*
data.primary_translation[ticket_message][email_message_id][][email_id]	string	*
data.primary_translation[ticket_message][ticket_feedback][]	array of objects (TicketFeedback)	*
data.primary_translation[ticket_message][ticket_feedback][][id]	integer	*
data.primary_translation[ticket_message][ticket_feedback][][ticket]	object (Ticket)	*
data.primary_translation[ticket_message][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data.primary_translation[ticket_message][ticket_feedback][][person]	object (Person)	*
data.primary_translation[ticket_message][ticket_feedback][][rating]	integer	*
data.primary_translation[ticket_message][ticket_feedback][][message]	string	*
data.primary_translation[ticket_message][ticket_feedback][][date_created]	DateTime	*
data.primary_translation[ticket_message][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data.primary_translation[ticket_message][ticket_message_forwards][][id]	integer	*
data.primary_translation[ticket_message][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data.primary_translation[ticket_message][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data.primary_translation[ticket_message][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data.primary_translation[ticket_message][ticket_message_forwards][][subject]	string	*
data.primary_translation[ticket_message][ticket_message_forwards][][from_email]	string	*
data.primary_translation[ticket_message][ticket_message_forwards][][tos]	array	*
data.primary_translation[ticket_message][ticket_message_forwards][][ccs]	array	*
data.primary_translation[ticket_message][ticket_message_forwards][][bccs]	array	*
data.primary_translation[ticket_message][ticket_message_forwards][][message]	string	*
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][authcode]	string	*
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][blob_hash]	string	*
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][source_ref]	string	*
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data.primary_translation[ticket_message][ticket_message_forwards][][date_created]	DateTime	*
data.primary_translation[ticket_message][channel_message]	object (TicketMessageChannelMessage)	*
data.primary_translation[ticket_message][channel_message][id]	integer	*	@var int The unique id of message.
data.primary_translation[ticket_message][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data.primary_translation[ticket_message][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data.primary_translation[ticket_message][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data.primary_translation[ticket_message][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data.primary_translation[ticket_message][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data.primary_translation[ticket_message][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data.primary_translation[ticket_message][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data.primary_translation[ticket_message][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data.primary_translation[ticket_message][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data.primary_translation[from_lang_code]	string	*
data.primary_translation[lang_code]	string	*
data.primary_translation[message]	string	*
data.primary_translation[date_created]	DateTime	*
data.id	integer	*	The unique id of message.
data.ticket	object (Ticket)	*	Ticket with which this message is associated.
data.ticket[id]	integer	*
data.ticket[ref]	string	*
data.ticket[auth]	string	*
data.ticket[parent_ticket]	object (Ticket)	*	Parent ticket.
data.ticket[children_tickets][]	array of objects (Ticket)	*
data.ticket[language]	object (Language)	*	The language the ticket is in.
data.ticket[language][id]	integer	*	The unique ID.
data.ticket[language][sys_name]	string	*	The unique sys name assigned to the language.
data.ticket[language][title]	string	*	Title of the language.
data.ticket[language][title_local]	string	*	Title of the language.
data.ticket[language][base_filepath]	string	*	The base filepath for default phrases for this lang.
data.ticket[language][locale]	string	*	The locale code.
data.ticket[language][flag_image]	string	*	String path to image.
data.ticket[language][is_rtl]	boolean	*	True if this is a right-to-left language.
data.ticket[language][has_user]	boolean	*	True if has user.
data.ticket[language][has_agent]	boolean	*	True if has agent.
data.ticket[language][has_admin]	boolean	*	True if has admin.
data.ticket[language][plural_categories][]	array of strings	*
data.ticket[language][plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data.ticket[language][flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`
data.ticket[brand]	object (Brand)	*
data.ticket[brand][id]	integer	*	The unique ID.
data.ticket[brand][name]	string	*	The brand name.
data.ticket[brand][slug]	string	*
data.ticket[brand][url]	string	*	The brand url.
data.ticket[brand][theme_set]	object (ThemeSet)	*
data.ticket[brand][theme_set][id]	integer	*
data.ticket[brand][theme_set][theme_id]	string	*
data.ticket[brand][theme_set][title]	string	*
data.ticket[brand][theme_set][options]		*
data.ticket[brand][edit_theme_set]	object (ThemeSet)	*
data.ticket[brand][departments][]	array of objects (Department)	*
data.ticket[brand][departments][][id]	integer	*
data.ticket[brand][departments][][parent]	object (Department)	*
data.ticket[brand][departments][][children][]	array of objects (Department)	*
data.ticket[brand][departments][][title]	string	*
data.ticket[brand][departments][][user_title]	string	*
data.ticket[brand][departments][][is_tickets_enabled]	boolean	*
data.ticket[brand][departments][][is_chat_enabled]	boolean	*
data.ticket[brand][departments][][display_order]	integer	*
data.ticket[brand][departments][][avatar]	object (Blob)	*
data.ticket[brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.ticket[brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.ticket[brand][departments][][avatar][authcode]	string	*
data.ticket[brand][departments][][avatar][blob_hash]	string	*
data.ticket[brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[brand][departments][][avatar][date_created]	DateTime	*
data.ticket[brand][departments][][avatar][is_temp]	boolean	*
data.ticket[brand][departments][][avatar][source_ref]	string	*
data.ticket[brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.ticket[brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.ticket[brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.ticket[brand][departments][][brands][]	array of objects (Brand)	*
data.ticket[brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.ticket[brand][departments][][permissions][][department]	integer id (Department)	*
data.ticket[brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.ticket[brand][departments][][permissions][][name]	string	*	The name of the permission.
data.ticket[brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.ticket[brand][departments][][permissions][][is_active]	boolean	*
data.ticket[brand][departments][][chat_queue]	object (UserChatQueue)	*
data.ticket[brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.ticket[brand][departments][][chat_queue][name]	string	*
data.ticket[brand][departments][][chat_queue][routing_model]	string	*
data.ticket[brand][departments][][chat_queue][answer_timeout]	integer	*
data.ticket[brand][departments][][chat_queue][is_all_agents]	boolean	*
data.ticket[brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.ticket[brand][departments][][chat_queue][max_queue_size]	integer	*
data.ticket[brand][departments][][chat_queue][routingModel]		*
data.ticket[brand][theme_sets][]	array of objects (ThemeSet)	*
data.ticket[department]	object (Department)	*
data.ticket[department][id]	integer	*
data.ticket[department][parent]	object (Department)	*
data.ticket[department][children][]	array of objects (Department)	*
data.ticket[department][title]	string	*
data.ticket[department][user_title]	string	*
data.ticket[department][is_tickets_enabled]	boolean	*
data.ticket[department][is_chat_enabled]	boolean	*
data.ticket[department][display_order]	integer	*
data.ticket[department][avatar]	object (Blob)	*
data.ticket[department][avatar][sys_name]	string	*	A unique system name for the blob.
data.ticket[department][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[department][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[department][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[department][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[department][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[department][avatar][file_url]	string	*	The HTTP link to download the file.
data.ticket[department][avatar][authcode]	string	*
data.ticket[department][avatar][blob_hash]	string	*
data.ticket[department][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[department][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[department][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[department][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[department][avatar][date_created]	DateTime	*
data.ticket[department][avatar][is_temp]	boolean	*
data.ticket[department][avatar][source_ref]	string	*
data.ticket[department][avatar][labels][]	array of objects (LabelBlob)	*
data.ticket[department][avatar][labels][][blob]	object (Blob)	*
data.ticket[department][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.ticket[department][brands][]	array of objects (Brand)	*
data.ticket[department][permissions][]	array of objects (DepartmentPermission)	*
data.ticket[department][permissions][][department]	integer id (Department)	*
data.ticket[department][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.ticket[department][permissions][][name]	string	*	The name of the permission.
data.ticket[department][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.ticket[department][permissions][][is_active]	boolean	*
data.ticket[department][chat_queue]	object (UserChatQueue)	*
data.ticket[department][chat_queue][id]	integer	*	The unique ID.
data.ticket[department][chat_queue][name]	string	*
data.ticket[department][chat_queue][routing_model]	string	*
data.ticket[department][chat_queue][answer_timeout]	integer	*
data.ticket[department][chat_queue][is_all_agents]	boolean	*
data.ticket[department][chat_queue][departments][]	array of objects (Department)	*
data.ticket[department][chat_queue][max_queue_size]	integer	*
data.ticket[category]	object (TicketCategory)	*
data.ticket[category][id]	integer	*	The unique ID.
data.ticket[category][parent]	integer id (TicketCategory)	*	This category parent.
data.ticket[category][title]	string	*	Category title.
data.ticket[category][display_order]	integer	*	Obviously it's display order for lists.
data.ticket[priority]	object (TicketPriority)	*
data.ticket[priority][id]	integer	*	The unique ID.
data.ticket[priority][title]	string	*	Priority title.
data.ticket[priority][priority]	integer	*	The priority itself.
data.ticket[workflow]	object (TicketWorkflow)	*
data.ticket[workflow][id]	integer	*	The unique ID.
data.ticket[workflow][title]	string	*	Workflow title.
data.ticket[workflow][display_order]	integer	*	Workflow display order.
data.ticket[product]	object (Product)	*
data.ticket[product][parent]	integer id (Product)	*	Parent of the product.
data.ticket[product][title]		*
data.ticket[person]	object (Person)	*
data.ticket[person_email]	object (PersonEmail)	*
data.ticket[person_email][id]	integer	*	The unique ID.
data.ticket[person_email][person]	integer id (Person)	*	Person owner of email.
data.ticket[person_email][email]	string	*	The email address.
data.ticket[person_email][email_domain]	string	*	The email address domain.
data.ticket[person_email][is_validated]	boolean	*	True if validation passed.
data.ticket[person_email][date_created]	DateTime	*	The original time the email was created.
data.ticket[agent]	object (Person)	*
data.ticket[agent_team]	object (AgentTeam)	*
data.ticket[agent_team][id]	integer	*	The unique ID.
data.ticket[agent_team][name]	string	*	The name of agent team.
data.ticket[agent_team][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.ticket[agent_team][members]		*
data.ticket[organization]	object (Organization)	*
data.ticket[organization][id]	integer	*	The unique ID.
data.ticket[organization][picture_blob]	object (Blob)	*	The org picture.
data.ticket[organization][picture_blob][sys_name]	string	*	A unique system name for the blob.
data.ticket[organization][picture_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[organization][picture_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[organization][picture_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[organization][picture_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[organization][picture_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[organization][picture_blob][file_url]	string	*	The HTTP link to download the file.
data.ticket[organization][picture_blob][authcode]	string	*
data.ticket[organization][picture_blob][blob_hash]	string	*
data.ticket[organization][picture_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[organization][picture_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[organization][picture_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[organization][picture_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[organization][picture_blob][date_created]	DateTime	*
data.ticket[organization][picture_blob][is_temp]	boolean	*
data.ticket[organization][picture_blob][source_ref]	string	*
data.ticket[organization][picture_blob][labels][]	array of objects (LabelBlob)	*
data.ticket[organization][picture_blob][labels][][blob]	object (Blob)	*
data.ticket[organization][icon_property]	object (IconProperty)	*
data.ticket[organization][icon_property][urn]	string	*
data.ticket[organization][icon_property][options]	array	*
data.ticket[organization][name]	string	*	The organization name.
data.ticket[organization][summary]	string	*	The summary field as filled in by agents.
data.ticket[organization][importance]	integer	*	The org importance.
data.ticket[organization][custom_data][]	array of objects (CustomDataOrganization)	*
data.ticket[organization][custom_data][][organization]	object (Organization)	*
data.ticket[organization][custom_data][][field]	object (CustomDefOrganization)	*
data.ticket[organization][custom_data][][field][parent]	object (CustomDefOrganization)	*	Field`s parent.
data.ticket[organization][custom_data][][field][children][]	array of objects (CustomDefOrganization)	*	Field children.
data.ticket[organization][custom_data][][field][title]		*
data.ticket[organization][custom_data][][root_field]	object (CustomDefOrganization)	*
data.ticket[organization][usergroups][]	array of objects (Usergroup)	*	Usergroups the user belongs to.
data.ticket[organization][usergroups][][id]	integer	*	The unique ID, DB-generated.
data.ticket[organization][usergroups][][title]	string	*	Title of the usergroup.
data.ticket[organization][usergroups][][note]	string	*	A note or description about the usergroup.
data.ticket[organization][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.ticket[organization][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.ticket[organization][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.ticket[organization][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.ticket[organization][usergroups][][permissions][][id]	integer	*	The unique ID.
data.ticket[organization][usergroups][][permissions][][name]	string	*	The name of the permission.
data.ticket[organization][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.ticket[organization][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.ticket[organization][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.ticket[organization][usergroups][][department_permissions][][department]	integer id (Department)	*
data.ticket[organization][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.ticket[organization][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.ticket[organization][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.ticket[organization][usergroups][][department_permissions][][is_active]	boolean	*
data.ticket[organization][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.ticket[organization][auto_cc_people][]	array of objects (Person)	*	Users who are set to automatically be added to tickets and other org things.
data.ticket[organization][labels][]	array of objects (LabelOrganization)	*
data.ticket[organization][labels][][organization]	object (Organization)	*
data.ticket[organization][contact_data][]	array of objects (OrganizationContactData)	*
data.ticket[organization][contact_data][][organization]		*
data.ticket[organization][contact_data][][contact_type]		*
data.ticket[organization][contact_data][][comment]		*
data.ticket[organization][contact_data][][field_1]		*
data.ticket[organization][contact_data][][field_2]		*
data.ticket[organization][contact_data][][field_3]		*
data.ticket[organization][contact_data][][field_5]		*
data.ticket[organization][contact_data][][field_9]		*
data.ticket[organization][emails][]	array of objects (OrganizationEmail)	*
data.ticket[organization][emails][][id]	integer	*	The unique log id.
data.ticket[organization][emails][][organization]	object (Organization)	*
data.ticket[organization][emails][][email]	string	*
data.ticket[organization][emails][][date_created]	DateTime	*
data.ticket[organization][email_domains][]	array of objects (OrganizationEmailDomain)	*
data.ticket[organization][email_domains][][domain]	string	*	The email domain.
data.ticket[organization][email_domains][][organization]	object (Organization)	*	The users organization.
data.ticket[organization][date_created]	DateTime	*	The date the org was inserted into the system.
data.ticket[organization][members][]	array of objects (Person)	*
data.ticket[organization][parent]	object (Organization)	*
data.ticket[organization][children][]	array of objects (Organization)	*
data.ticket[organization][tickets][]	array of objects (Ticket)	*
data.ticket[organization][organization_members][]	array of objects (OrganizationMember)	*
data.ticket[organization][organization_members][][id]	integer	*
data.ticket[organization][organization_members][][person]	integer id (Person)	*
data.ticket[organization][organization_members][][organization]	integer id (Organization)	*
data.ticket[organization][organization_members][][is_manager]	boolean	*
data.ticket[organization][organization_members][][position]	string	*
data.ticket[organization][organization_members][][created_at]	DateTime	*
data.ticket[organization][organization_members][][updated_at]	DateTime	*
data.ticket[organization][publicUsergroups]		*
data.ticket[linked_chat]	object (ChatConversation)	*
data.ticket[linked_chat][id]	integer	*	The unique id of chat conversation.
data.ticket[linked_chat][department]	object (Department)	*	Department which chat was assigned.
data.ticket[linked_chat][brand]	object (Brand)	*	Department which chat was assigned.
data.ticket[linked_chat][task_id]	integer	*
data.ticket[linked_chat][ticket]	object (Ticket)	*
data.ticket[linked_chat][labels][]	array of objects (LabelChatConversation)	*
data.ticket[linked_chat][labels][][chat]	object (ChatConversation)	*
data.ticket[linked_chat][subject]	string	*	Subject of the chat conversation.
data.ticket[linked_chat][status]	string	*	Status of the chat conversation.
data.ticket[linked_chat][agent]	object (Person)	*	If this is a user conversation, this is the agent assigned.
data.ticket[linked_chat][agent_team]	object (AgentTeam)	*	If this is a team chat, the team it is.
data.ticket[linked_chat][person]	object (Person)	*	If this is a user conversation, this is the user who started the chat.
data.ticket[linked_chat][session]	object (Session)	*	If this is a user convo, this is the users session.
data.ticket[linked_chat][session][id]	integer	*	The unique ID.
data.ticket[linked_chat][session][auth]	string	*	The authcode for the session to verify an id.
data.ticket[linked_chat][session][interface]	string	*	The Interface the session is for.
data.ticket[linked_chat][session][person]	object (Person)	*
data.ticket[linked_chat][session][user_agent]	string	*	The users user agent string.
data.ticket[linked_chat][session][visitor_id]	string	*
data.ticket[linked_chat][session][ip_address]	string	*	The users IP address.
data.ticket[linked_chat][session][data]	string	*
data.ticket[linked_chat][session][is_person]	boolean	*
data.ticket[linked_chat][session][is_bot]	boolean	*
data.ticket[linked_chat][session][is_helpdesk]	boolean	*
data.ticket[linked_chat][session][active_status]	string	*	(Agents) Status (available or away).
data.ticket[linked_chat][session][is_chat_available]	boolean	*	(Agents) Wehn status is available, if they are available for chat.
data.ticket[linked_chat][session][date_created]	DateTime	*
data.ticket[linked_chat][session][date_last]	DateTime	*
data.ticket[linked_chat][session][date_last_page]	DateTime	*
data.ticket[linked_chat][visitor_id]	string	*
data.ticket[linked_chat][person_name]	string	*	User chat: The users name, if they arent a person.
data.ticket[linked_chat][person_email]	string	*	User chat: The users email, if they aren`t a person.
data.ticket[linked_chat][participants][]	array of objects (Person)	*
data.ticket[linked_chat][messages][]	array of objects (ChatMessage)	*
data.ticket[linked_chat][messages][][id]	integer	*	The unique ID.
data.ticket[linked_chat][messages][][author_id]	integer	*	Author id (legacy).
data.ticket[linked_chat][messages][][author_type]	string	*	Author type (legacy).
data.ticket[linked_chat][messages][][conversation_id]	integer	*	Conversation id (legacy).
data.ticket[linked_chat][messages][][author]	integer id (Person)	*	Person who created the message.
data.ticket[linked_chat][messages][][content]	string	*	The message.
data.ticket[linked_chat][messages][][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.ticket[linked_chat][messages][][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.ticket[linked_chat][messages][][is_html]	boolean	*	Is the content an HTML message?
data.ticket[linked_chat][messages][][metadata]	array	*	Additional data.
data.ticket[linked_chat][messages][][date_created]	DateTime	*	Date message was created.
data.ticket[linked_chat][messages][][date_received]	DateTime	*	Date message was received.
data.ticket[linked_chat][custom_data][]	array of objects (CustomDataChat)	*
data.ticket[linked_chat][custom_data][][conversation]	object (ChatConversation)	*	The conversation the message belongs to.
data.ticket[linked_chat][custom_data][][field]	object (CustomDefChat)	*
data.ticket[linked_chat][custom_data][][field][parent]	object (CustomDefChat)	*
data.ticket[linked_chat][custom_data][][field][children][]	array of objects (CustomDefChat)	*	Field children.
data.ticket[linked_chat][custom_data][][field][title]		*
data.ticket[linked_chat][custom_data][][root_field]	object (CustomDefChat)	*
data.ticket[linked_chat][rating_response_time]	integer	*
data.ticket[linked_chat][rating_overall]	integer	*
data.ticket[linked_chat][rating_comment]	string	*
data.ticket[linked_chat][is_agent]	boolean	*	Is this an agent chat.
data.ticket[linked_chat][is_window]	boolean	*	If the chat is popped out into a window. This is used to make sure the JS widget on pages doesn't load again.
data.ticket[linked_chat][date_created]	DateTime	*	Date when chat was started.
data.ticket[linked_chat][date_user_waiting]	DateTime	*	Since when the user has started waiting (i.e., time the assignment was 0).
data.ticket[linked_chat][date_assigned]	DateTime	*
data.ticket[linked_chat][date_agent_typing]	DateTime	*	Date when agent typed last time.
data.ticket[linked_chat][date_first_agent_message]	DateTime	*
data.ticket[linked_chat][date_ended]	DateTime	*	Date when chat was ended.
data.ticket[linked_chat][total_to_ended]	integer	*
data.ticket[linked_chat][ended_by]	string	*	Who ended the chat.
data.ticket[linked_chat][should_send_transcript]	boolean	*	True if transcript should be send.
data.ticket[linked_chat][date_transcript_sent]	DateTime	*	Date when transcript was sent.
data.ticket[linked_chat][email_validation_code]	string	*
data.ticket[linked_chat][email_validated]	boolean	*
data.ticket[linked_chat][access_token]	string	*
data.ticket[attachments][]	array of objects (TicketAttachment)	*
data.ticket[attachments][][id]	integer	*	The unique ID.
data.ticket[attachments][][ticket]	integer id (Ticket)	*	Ticket this attachment belongs to.
data.ticket[attachments][][person]	integer id (Person)	*	Who created the attachment.
data.ticket[attachments][][blob]	object (Blob)	*	Actual attachment.
data.ticket[attachments][][blob][sys_name]	string	*	A unique system name for the blob.
data.ticket[attachments][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[attachments][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[attachments][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[attachments][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[attachments][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[attachments][][blob][file_url]	string	*	The HTTP link to download the file.
data.ticket[attachments][][blob][authcode]	string	*
data.ticket[attachments][][blob][blob_hash]	string	*
data.ticket[attachments][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[attachments][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[attachments][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[attachments][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[attachments][][blob][date_created]	DateTime	*
data.ticket[attachments][][blob][is_temp]	boolean	*
data.ticket[attachments][][blob][source_ref]	string	*
data.ticket[attachments][][blob][labels][]	array of objects (LabelBlob)	*
data.ticket[attachments][][blob][labels][][blob]	object (Blob)	*
data.ticket[attachments][][message]	integer id (TicketMessage)	*	Message - holder of this attachment.
data.ticket[attachments][][is_agent_note]	boolean	*	True if this attachmen just a note.
data.ticket[attachments][][is_inline]	boolean	*	Is this attachment is embed in message.
data.ticket[access_codes][]	array of objects (TicketAccessCode)	*
data.ticket[access_codes][][id]	integer	*
data.ticket[access_codes][][ticket]	object (Ticket)	*
data.ticket[access_codes][][person]	object (Person)	*
data.ticket[access_codes][][auth]	string	*
data.ticket[messages][]	array of objects (TicketMessage)	*
data.ticket[messages][][id]	integer	*	The unique id of message.
data.ticket[messages][][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data.ticket[messages][][person]	object (Person)	*	Person this message was sent by.
data.ticket[messages][][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data.ticket[messages][][email_source][id]	integer	*
data.ticket[messages][][email_source][uuid]	string	*
data.ticket[messages][][email_source][blob]	object (Blob)	*
data.ticket[messages][][email_source][blob][sys_name]	string	*	A unique system name for the blob.
data.ticket[messages][][email_source][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[messages][][email_source][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[messages][][email_source][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[messages][][email_source][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[messages][][email_source][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[messages][][email_source][blob][file_url]	string	*	The HTTP link to download the file.
data.ticket[messages][][email_source][blob][authcode]	string	*
data.ticket[messages][][email_source][blob][blob_hash]	string	*
data.ticket[messages][][email_source][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[messages][][email_source][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[messages][][email_source][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[messages][][email_source][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[messages][][email_source][blob][date_created]	DateTime	*
data.ticket[messages][][email_source][blob][is_temp]	boolean	*
data.ticket[messages][][email_source][blob][source_ref]	string	*
data.ticket[messages][][email_source][blob][labels][]	array of objects (LabelBlob)	*
data.ticket[messages][][email_source][blob][labels][][blob]	object (Blob)	*
data.ticket[messages][][email_source][object_type]	string	*	The type of object this is attached to (should be the table name of the super type, eg: tickets, people, organizations). This typically is not set until after the email is processed (ie the status is 'processed').
data.ticket[messages][][email_source][object_id]	integer	*	The ID of the object this is attached to.
data.ticket[messages][][email_source][from_email]	string	*
data.ticket[messages][][email_source][status]	string	*	The current status of the message: - inserted: Only inserted - processing: Currently processing - complete: Fully processed - error: Tried to process but there was some kind of error (see error_code).
data.ticket[messages][][email_source][date_status]	DateTime	*
data.ticket[messages][][email_source][error_code]	string	*	When status is error, this is the code that describes the error.
data.ticket[messages][][email_source][date_created]	DateTime	*
data.ticket[messages][][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.ticket[messages][][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.ticket[messages][][snippet_use_logs][][id]	integer	*	The unique ID.
data.ticket[messages][][snippet_use_logs][][snippet]	object (SnippetV2)	*	Snippet used.
data.ticket[messages][][snippet_use_logs][][snippet][id]	integer	*
data.ticket[messages][][snippet_use_logs][][snippet][title]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][author]	object (Person)	*
data.ticket[messages][][snippet_use_logs][][snippet][is_private]	boolean	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar]	object (Blob)	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][sys_name]	string	*	A unique system name for the blob.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][file_url]	string	*	The HTTP link to download the file.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][authcode]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][blob_hash]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[messages][][snippet_use_logs][][snippet][avatar][date_created]	DateTime	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][is_temp]	boolean	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][source_ref]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][labels][]	array of objects (LabelBlob)	*
data.ticket[messages][][snippet_use_logs][][snippet][avatar][labels][][blob]	object (Blob)	*
data.ticket[messages][][snippet_use_logs][][snippet][status]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][shortcut_codes]	array	*
data.ticket[messages][][snippet_use_logs][][snippet][inline_translations]	array	*
data.ticket[messages][][snippet_use_logs][][snippet][translations][]	array of objects (SnippetV2Translation)	*
data.ticket[messages][][snippet_use_logs][][snippet][translations][][id]	integer	*	The unique ID.
data.ticket[messages][][snippet_use_logs][][snippet][translations][][snippet]	object (SnippetV2)	*	Snippet translated.
data.ticket[messages][][snippet_use_logs][][snippet][translations][][language]	object (Language)	*
data.ticket[messages][][snippet_use_logs][][snippet][translations][][content]	array	*	Snippet content.
data.ticket[messages][][snippet_use_logs][][snippet][translations][][blobs][]	array of objects (Blob)	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][]	array of objects (SnippetV2Category)	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][id]	integer	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][title]	string	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][is_global]	boolean	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][display_order]	integer	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][parent]	object (SnippetV2Category)	*
data.ticket[messages][][snippet_use_logs][][snippet][categories][][agent_teams][]	array of objects (AgentTeam)	*
data.ticket[messages][][snippet_use_logs][][snippet][display_order]	integer	*
data.ticket[messages][][snippet_use_logs][][snippet][date_created]	DateTime	*
data.ticket[messages][][snippet_use_logs][][ticket_message]	object (TicketMessage)	*	Ticket Message where the snippet was used.
data.ticket[messages][][snippet_use_logs][][chat_message]	object (ChatMessage)	*	Chat Message where the snippet was used.
data.ticket[messages][][snippet_use_logs][][chat_message][id]	integer	*	The unique ID.
data.ticket[messages][][snippet_use_logs][][chat_message][author_id]	integer	*	Author id (legacy).
data.ticket[messages][][snippet_use_logs][][chat_message][author_type]	string	*	Author type (legacy).
data.ticket[messages][][snippet_use_logs][][chat_message][conversation_id]	integer	*	Conversation id (legacy).
data.ticket[messages][][snippet_use_logs][][chat_message][author]	integer id (Person)	*	Person who created the message.
data.ticket[messages][][snippet_use_logs][][chat_message][content]	string	*	The message.
data.ticket[messages][][snippet_use_logs][][chat_message][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.ticket[messages][][snippet_use_logs][][chat_message][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.ticket[messages][][snippet_use_logs][][chat_message][is_html]	boolean	*	Is the content an HTML message?
data.ticket[messages][][snippet_use_logs][][chat_message][metadata]	array	*	Additional data.
data.ticket[messages][][snippet_use_logs][][chat_message][date_created]	DateTime	*	Date message was created.
data.ticket[messages][][snippet_use_logs][][chat_message][date_received]	DateTime	*	Date message was received.
data.ticket[messages][][snippet_use_logs][][language]	object (Language)	*	Snippet translated.
data.ticket[messages][][snippet_use_logs][][person]	object (Person)	*
data.ticket[messages][][snippet_use_logs][][rating]	integer	*
data.ticket[messages][][snippet_use_logs][][rating_person]	object (Person)	*
data.ticket[messages][][snippet_use_logs][][rating_message]	string	*
data.ticket[messages][][snippet_use_logs][][date_created]	DateTime	*
data.ticket[messages][][date_created]	DateTime	*	Date when message was created.
data.ticket[messages][][is_agent_note]	boolean	*	Is this message agent note?
data.ticket[messages][][is_hidden]	boolean	*	Is this message hidden?
data.ticket[messages][][creation_system]	string	*	How this message was created.
data.ticket[messages][][ip_address]	string	*	An ip address from which message was sent.
data.ticket[messages][][visitor_id]	string	*	Unique ID of visitor left this message.
data.ticket[messages][][hostname]	string	*	Host from which message was left.
data.ticket[messages][][geo_country]	string	*	Country message is from (deprecated).
data.ticket[messages][][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.ticket[messages][][message_hash]	string	*	An unique hash of message.
data.ticket[messages][][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.ticket[messages][][primary_translation][id]	integer	*
data.ticket[messages][][primary_translation][ticket]	object (Ticket)	*
data.ticket[messages][][primary_translation][ticket_message]	object (TicketMessage)	*
data.ticket[messages][][primary_translation][from_lang_code]	string	*
data.ticket[messages][][primary_translation][lang_code]	string	*
data.ticket[messages][][primary_translation][message]	string	*
data.ticket[messages][][primary_translation][date_created]	DateTime	*
data.ticket[messages][][message]	string	*	The message, will be in HTML!
data.ticket[messages][][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.ticket[messages][][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.ticket[messages][][message_source]	string	*	The message source.
data.ticket[messages][][message_source_type]	string	*	The message source type.
data.ticket[messages][][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.ticket[messages][][lang_code]	string	*	The set/detected lang code.
data.ticket[messages][][email_message_id][]	array of objects (TicketMessageEmailId)	*
data.ticket[messages][][email_message_id][][id]	integer	*
data.ticket[messages][][email_message_id][][message]	object (TicketMessage)	*
data.ticket[messages][][email_message_id][][email_id]	string	*
data.ticket[messages][][ticket_feedback][]	array of objects (TicketFeedback)	*
data.ticket[messages][][ticket_feedback][][id]	integer	*
data.ticket[messages][][ticket_feedback][][ticket]	object (Ticket)	*
data.ticket[messages][][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data.ticket[messages][][ticket_feedback][][person]	object (Person)	*
data.ticket[messages][][ticket_feedback][][rating]	integer	*
data.ticket[messages][][ticket_feedback][][message]	string	*
data.ticket[messages][][ticket_feedback][][date_created]	DateTime	*
data.ticket[messages][][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data.ticket[messages][][ticket_message_forwards][][id]	integer	*
data.ticket[messages][][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data.ticket[messages][][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data.ticket[messages][][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data.ticket[messages][][ticket_message_forwards][][subject]	string	*
data.ticket[messages][][ticket_message_forwards][][from_email]	string	*
data.ticket[messages][][ticket_message_forwards][][tos]	array	*
data.ticket[messages][][ticket_message_forwards][][ccs]	array	*
data.ticket[messages][][ticket_message_forwards][][bccs]	array	*
data.ticket[messages][][ticket_message_forwards][][message]	string	*
data.ticket[messages][][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data.ticket[messages][][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data.ticket[messages][][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[messages][][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[messages][][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[messages][][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[messages][][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[messages][][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data.ticket[messages][][ticket_message_forwards][][blobs][][authcode]	string	*
data.ticket[messages][][ticket_message_forwards][][blobs][][blob_hash]	string	*
data.ticket[messages][][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[messages][][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[messages][][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[messages][][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[messages][][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data.ticket[messages][][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data.ticket[messages][][ticket_message_forwards][][blobs][][source_ref]	string	*
data.ticket[messages][][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data.ticket[messages][][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data.ticket[messages][][ticket_message_forwards][][date_created]	DateTime	*
data.ticket[messages][][channel_message]	object (TicketMessageChannelMessage)	*
data.ticket[messages][][channel_message][id]	integer	*	@var int The unique id of message.
data.ticket[messages][][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data.ticket[messages][][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data.ticket[messages][][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data.ticket[messages][][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data.ticket[messages][][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data.ticket[messages][][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data.ticket[messages][][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data.ticket[messages][][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data.ticket[messages][][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data.ticket[sms_messages][]	array of objects (TicketSms)	*
data.ticket[sms_messages][][id]	integer	*
data.ticket[sms_messages][][ticket]	object (Ticket)	*
data.ticket[sms_messages][][person]	object (Person)	*
data.ticket[sms_messages][][sms_account]	object (SmsAccount)	*
data.ticket[sms_messages][][sms_account][id]	integer	*	The unique ID.
data.ticket[sms_messages][][sms_account][type]	string	*
data.ticket[sms_messages][][sms_account][params]	array	*
data.ticket[sms_messages][][sms_account][identifier]	string	*
data.ticket[sms_messages][][sms_account][is_enabled]	boolean	*
data.ticket[sms_messages][][sms_account][is_connected]	boolean	*
data.ticket[sms_messages][][sms_account][is_tested]	boolean	*
data.ticket[sms_messages][][sms_account][test_code]	string	*
data.ticket[sms_messages][][job]	object (Job)	*
data.ticket[sms_messages][][job][id]	integer	*	The unique job id.
data.ticket[sms_messages][][job][type]	string	*	The job type, used by the Job Router to find the right Job Processor.
data.ticket[sms_messages][][job][status]	string	*	The status of the job.
data.ticket[sms_messages][][job][status_code]	string	*	Any code to further classify the status.
data.ticket[sms_messages][][job][date_touch]	DateTime	*	Date the last time a process "touched" this ticket.
data.ticket[sms_messages][][job][date_created]	DateTime	*	Date this job entered the "jobs" table.
data.ticket[sms_messages][][job][date_last_try]	DateTime	*	Last time we processed this job.
data.ticket[sms_messages][][job][date_next_try]	DateTime	*	If this DateTime is in the future, it won't be selected for execution.
data.ticket[sms_messages][][job][num_tries]	integer	*	The number of times this job has been executed Job Processor (usually indicated failures if > 1).
data.ticket[sms_messages][][job][log_summary]	string	*	A human readable summary of the job's execution.
data.ticket[sms_messages][][job][log]	string	*	A more verbose log.
data.ticket[sms_messages][][job][data]	array	*	An array of data, or payload, that the job processor needs to execute this job (stored in the db as json). This MUST always be an array, even if its an empty array
data.ticket[sms_messages][][job][original_job]	integer	*	Null unless the job was created as a retry - if so, the originating job ID is stored here so we can query it later. Note: You MUST specify the originating job, do not create a linked list of failed jobs.
data.ticket[sms_messages][][date_created]	DateTime	*
data.ticket[sms_messages][][from_number]	string	*	Permanent record of the phone number that sent this SMS. (Won't change even if Person changes their phone number).
data.ticket[sms_messages][][to_number]	string	*	Permanent record of the phone number that this SMS was sent to.
data.ticket[sms_messages][][message]	string	*	The SMS message.
data.ticket[sms_messages][][direction]	string	*	Just a system flag for reporting.
data.ticket[topic_links][]	array of objects (TicketCommunityTopicLink)	*
data.ticket[topic_links][][id]	integer	*	The unique filter ID.
data.ticket[topic_links][][ticket]	integer id (Ticket)	*
data.ticket[topic_links][][topic]	integer id (CommunityTopic)	*
data.ticket[topic_links][][person]	integer id (Person)	*
data.ticket[topic_links][][date_created]	DateTime	*
data.ticket[custom_data][]	array of objects (CustomDataTicket)	*
data.ticket[custom_data][][ticket]	object (Ticket)	*
data.ticket[custom_data][][field]	object (CustomDefTicket)	*
data.ticket[custom_data][][field][parent]	object (CustomDefTicket)	*
data.ticket[custom_data][][field][children][]	array of objects (CustomDefTicket)	*	Field children.
data.ticket[custom_data][][field][title]		*
data.ticket[custom_data][][root_field]	object (CustomDefTicket)	*
data.ticket[labels][]	array of objects (LabelTicket)	*
data.ticket[labels][][ticket]	object (Ticket)	*
data.ticket[sent_to_address]	string	*	The email address the ticket was sent to if it came in via a gateway. This is a full string (e.g., including CC's) of the original.
data.ticket[email_account]	object (EmailAccount)	*	The gateway this ticket originated from.
data.ticket[email_account][id]	integer	*
data.ticket[email_account][account_type]	string	*
data.ticket[email_account][is_enabled]	boolean	*
data.ticket[email_account][address]	string	*
data.ticket[email_account][cert_blob]	object (Blob)	*
data.ticket[email_account][cert_blob][sys_name]	string	*	A unique system name for the blob.
data.ticket[email_account][cert_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket[email_account][cert_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket[email_account][cert_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket[email_account][cert_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket[email_account][cert_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket[email_account][cert_blob][file_url]	string	*	The HTTP link to download the file.
data.ticket[email_account][cert_blob][authcode]	string	*
data.ticket[email_account][cert_blob][blob_hash]	string	*
data.ticket[email_account][cert_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket[email_account][cert_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket[email_account][cert_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket[email_account][cert_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket[email_account][cert_blob][date_created]	DateTime	*
data.ticket[email_account][cert_blob][is_temp]	boolean	*
data.ticket[email_account][cert_blob][source_ref]	string	*
data.ticket[email_account][cert_blob][labels][]	array of objects (LabelBlob)	*
data.ticket[email_account][cert_blob][labels][][blob]	object (Blob)	*
data.ticket[email_account][key_blob]	object (Blob)	*
data.ticket[email_account_address]	string	*	The email address (from list of to/cc) that matched with the email account.
data.ticket[creation_system]	string	*
data.ticket[creation_system_option]	string	*	Optional information about the creation system. For example, source URL the ticket came from.
data.ticket[ticket_hash]	string	*
data.ticket[status]	string	*
data.ticket[ticket_status]	object (TicketStatus)	*
data.ticket[ticket_status][id]	integer	*
data.ticket[ticket_status][status_type]	string	*
data.ticket[ticket_status][status_code]	string	*
data.ticket[ticket_status][sys_id]	string	*
data.ticket[ticket_status][title]	string	*
data.ticket[ticket_status][display_order]	integer	*
data.ticket[ticket_status][pending_waiting_time_mode]	string	*	Where to count time spending in pending status. Check PENDING_WAITING_TIME_MODE_ constants
data.ticket[ticket_status][children][]	array of objects (TicketStatus)	*
data.ticket[ticket_status][options]	array	*
data.ticket[ticket_status][statusType]		*
data.ticket[ticket_status][displayOrder]	integer	*
data.ticket[urgency]	integer	*
data.ticket[feedback_rating]	integer	*
data.ticket[date_feedback_rating]	DateTime	*
data.ticket[date_created]	DateTime	*
data.ticket[date_resolved]	DateTime	*
data.ticket[date_archived]	DateTime	*
data.ticket[date_first_agent_assign]	DateTime	*
data.ticket[date_first_agent_reply]	DateTime	*
data.ticket[date_last_agent_reply]	DateTime	*
data.ticket[date_last_user_reply]	DateTime	*
data.ticket[date_agent_waiting]	DateTime	*
data.ticket[date_user_waiting]	DateTime	*
data.ticket[date_status]	DateTime	*
data.ticket[date_on_hold]	DateTime	*
data.ticket[total_user_waiting]	integer	*
data.ticket[total_to_first_reply]	integer	*
data.ticket[total_user_waiting_wh_start]	DateTime	*
data.ticket[total_user_waiting_wh]	integer	*
data.ticket[total_to_first_reply_wh]	integer	*
data.ticket[locked_by_agent]	object (Person)	*
data.ticket[date_locked]	DateTime	*
data.ticket[has_attachments]	boolean	*
data.ticket[subject]	string	*
data.ticket[original_subject]	string	*
data.ticket[properties]	array	*
data.ticket[count_agent_replies]	integer	*
data.ticket[count_user_replies]	integer	*
data.ticket[worst_sla_status]	string	*
data.ticket[waiting_times]	array	*	Used to track ticket status changes and how much time ticket was in status Add new item every time status changed This is optimisation over TicketLog.
data.ticket[participants][]	array of objects (TicketParticipant)	*
data.ticket[participants][][id]	integer	*
data.ticket[participants][][ticket]	object (Ticket)	*
data.ticket[participants][][person]	object (Person)	*
data.ticket[participants][][access_code]	object (TicketAccessCode)	*
data.ticket[participants][][person_email]	object (PersonEmail)	*
data.ticket[participants][][default_on]	boolean	*	Default checkbox status of the user.
data.ticket[charges][]	array of objects (TicketCharge)	*
data.ticket[charges][][id]	integer	*
data.ticket[charges][][charge_time]	integer	*
data.ticket[charges][][amount]	float	*
data.ticket[charges][][date_created]	DateTime	*
data.ticket[charges][][ticket]	object (Ticket)	*
data.ticket[charges][][person]	object (Person)	*
data.ticket[charges][][organization]	object (Organization)	*
data.ticket[charges][][agent]	object (Person)	*
data.ticket[charges][][custom_data][]	array of objects (CustomDataBilling)	*
data.ticket[charges][][custom_data][][ticket_charge]	object (TicketCharge)	*
data.ticket[charges][][custom_data][][field]	object (CustomDefBilling)	*
data.ticket[charges][][custom_data][][field][parent]	object (CustomDefBilling)	*
data.ticket[charges][][custom_data][][field][children][]	array of objects (CustomDefBilling)	*	Field children.
data.ticket[charges][][custom_data][][field][title]		*
data.ticket[charges][][custom_data][][root_field]	object (CustomDefBilling)	*
data.ticket[ticket_slas][]	array of objects (TicketSla)	*
data.ticket[ticket_slas][][id]	integer	*	The unique ID.
data.ticket[ticket_slas][][sla_status]	string	*	The SLA status.
data.ticket[ticket_slas][][warn_date]	DateTime	*	The SLA warn date.
data.ticket[ticket_slas][][fail_date]	DateTime	*	The SLA fail date.
data.ticket[ticket_slas][][is_completed]	boolean	*	Is the SLA completed?
data.ticket[ticket_slas][][is_completed_set]	boolean	*	Completed by automated action.
data.ticket[ticket_slas][][completed_time_taken]	integer	*	Time taken.
data.ticket[ticket_slas][][ticket]	integer id (Ticket)	*	Ticket.
data.ticket[ticket_slas][][sla]	integer id (Sla)	*	SLA.
data.ticket[ticket_slas][][date_applied]	DateTime	*	time and date when SLA was applied to the ticket.
data.ticket[ticket_slas][][date_completed]	DateTime	*	time when SLA status became OK.
data.ticket[jira_issues][]	array of objects (JiraIssue)	*	linked jira issues.
data.ticket[jira_issues][][id]	integer	*	The unique ID.
data.ticket[jira_issues][][ticket]	object (Ticket)	*	The associated DeskPRO ticket.
data.ticket[jira_issues][][issue_id]	integer	*
data.ticket[jira_issues][][status_id]	integer	*
data.ticket[jira_issues][][created]	DateTime	*	Export time.
data.ticket[problems][]	array of objects (Problem)	*
data.ticket[problems][][id]	integer	*	The unique ID.
data.ticket[problems][][title]	string	*	Problem title.
data.ticket[problems][][creator]	integer id (Person)	*	Person who created the problem.
data.ticket[problems][][created]	DateTime	*	Date when the problem was created.
data.ticket[problems][][is_open]	boolean	*	Is problem still has no solution?
data.ticket[problems][][tickets][]	array of integer ids (Ticket)	*	Tickets associated with problem.
data.ticket[stars][]	array of objects (TicketFlagged)	*
data.ticket[stars][][ticket]	object (Ticket)	*
data.ticket[stars][][person_id]	integer	*
data.ticket[stars][][color]	string	*
data.ticket[follow_ups][]	array of objects (TicketFollowUp)	*
data.ticket[follow_ups][][id]	integer	*	The unique ID.
data.ticket[follow_ups][][person]	integer id (Person)	*
data.ticket[follow_ups][][actions]	array	*
data.ticket[follow_ups][][cancel_if_user_reply]	boolean	*
data.ticket[follow_ups][][cancel_if_agent_reply]	boolean	*
data.ticket[follow_ups][][status]	string	*
data.ticket[follow_ups][][date_created]	DateTime	*
data.ticket[follow_ups][][date_to_run]	DateTime	*
data.ticket[follow_ups][][date_did_run]	DateTime	*
data.ticket[follow_ups][][dateToRun]		*
data.ticket[logs][]	array of objects (TicketLog)	*
data.ticket[logs][][id]	integer	*
data.ticket[logs][][parent]	object (TicketLog)	*
data.ticket[logs][][ticket]	object (Ticket)	*
data.ticket[logs][][person]	object (Person)	*
data.ticket[logs][][action_type]	string	*
data.ticket[logs][][id_object]	integer	*	If the log involves a specific thing in a ticket (eg a message that was moved), then that is this id.
data.ticket[logs][][id_before]	integer	*	The ID of the previous entity changed, or any other numeric value.
data.ticket[logs][][id_after]	integer	*	The ID of the new entity, or any other numeric value.
data.ticket[logs][][trigger_id]	integer	*	If the change was caused by a trigger, the trigger id. Note this is the integer ID (not a FK relation) so the record is kept even if the trigger itself is deleted.
data.ticket[logs][][escalation_id]	integer	*	If the change was caused by an escalation Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.ticket[logs][][macro_id]	integer	*	If the change was caused by an v2 macro Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.ticket[logs][][sla]	object (Sla)	*	If the change was caused by an SLA, the SLA.
data.ticket[logs][][sla][id]	integer	*	The unique ID.
data.ticket[logs][][sla][title]	string	*	SLA title.
data.ticket[logs][][sla][sla_type]	string	*	Type of SLA - first_response, resolution, waiting_time.
data.ticket[logs][][sla][active_time]	string	*	Whether active all the time (all) or during work hours only (work_hours) or use the default ticket-wide settings (default).
data.ticket[logs][][sla][work_start]	integer	*	When the work day starts. This is stored as the number of seconds after 00:00:00.
data.ticket[logs][][sla][work_end]	integer	*	When the work day ends. This is stored as the number of seconds after 00:00:00.
data.ticket[logs][][sla][work_days]	array	*	Array of work days, stored with keys corresponding to day numbers. Values are true. 0 = Sunday, 6 = Saturday (same as PHP, easy to convert to MySQL which is 1 = Sunday, 7 = Saturday).
data.ticket[logs][][sla][work_timezone]	string	*	Timezone for work hours/days to be considered in.
data.ticket[logs][][sla][work_holidays]	array	*	List of work holidays.
data.ticket[logs][][sla][apply_type]	string	*	Controls how the SLA is applied to tickets: all, terms, terms_before_triggers, manual.
data.ticket[logs][][sla][apply_terms]	object (TriggerTerms)	*	Conditions to apply.
data.ticket[logs][][sla][apply_terms][version]	integer	*	Terms version.
data.ticket[logs][][sla][apply_terms][terms]	array	*	Terms themselves.
data.ticket[logs][][sla][trigger_terms]	object (TriggerTerms)	*	Conditions to consider sla completed.
data.ticket[logs][][sla][warn_time]	integer	*	Warn time integer.
data.ticket[logs][][sla][warn_time_unit]	string	*	And it's unit (see warn time).
data.ticket[logs][][sla][warn_actions]	object (TriggerActions)	*	How to warn about SLA will fail.
data.ticket[logs][][sla][warn_actions][version]	integer	*	Actions version.
data.ticket[logs][][sla][warn_actions][actions]	array	*	Actions array representation.
data.ticket[logs][][sla][fail_time]	integer	*	Fail time integer.
data.ticket[logs][][sla][fail_time_unit]	string	*	And it's measuring unit (see fail_time).
data.ticket[logs][][sla][fail_actions]	object (TriggerActions)	*	What to do if SLA failed.
data.ticket[logs][][sla][exclude_ticket_statuses]	array	*	This SLA will not apply while tickets are in these pending statuses.
data.ticket[logs][][sla_status]	string	*
data.ticket[logs][][details]	array	*
data.ticket[logs][][date_created]	DateTime	*
data.ticket[chats][]	array of objects (ChatConversation)	*
data.ticket[created_with_channel]	string	*
data.ticket[last_channel_used]	string	*
data.ticket[channels]	array	*
data.ticket[pending_articles][]	array of objects (ArticlePendingCreate)	*
data.ticket[pending_articles][][id]	integer	*
data.ticket[pending_articles][][person]	integer id (Person)	*
data.ticket[pending_articles][][assigned_person]	integer id (Person)	*
data.ticket[pending_articles][][ticket]	integer id (Ticket)	*
data.ticket[pending_articles][][message]	integer id (TicketMessage)	*
data.ticket[pending_articles][][comment]	string	*
data.ticket[pending_articles][][date_created]	DateTime	*
data.ticket[summary]	object (TicketSummary)	*
data.ticket[summary][id]	integer	*
data.ticket[summary][ticket]	object (Ticket)	*
data.ticket[summary][summary]	string	*
data.ticket[summary][summary_input]	string	*
data.ticket[summary][date_created]	DateTime	*
data.person	object (Person)	*	Person this message was sent by.
data.person[emails]		*
data.person[labels]		*
data.person[teams]		*
data.person[primary_team]		*
data.person[agentData]		*
data.person[publicUsergroups]		*
data.person[publicAgentgroups]		*
data.email_source	object (EmailSource)	*	Info about email source, if message comes from such source.
data.email_source[id]	integer	*
data.email_source[uuid]	string	*
data.email_source[blob]	object (Blob)	*
data.email_source[blob][sys_name]	string	*	A unique system name for the blob.
data.email_source[blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.email_source[blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.email_source[blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.email_source[blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.email_source[blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.email_source[blob][file_url]	string	*	The HTTP link to download the file.
data.email_source[blob][authcode]	string	*
data.email_source[blob][blob_hash]	string	*
data.email_source[blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.email_source[blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.email_source[blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.email_source[blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.email_source[blob][date_created]	DateTime	*
data.email_source[blob][is_temp]	boolean	*
data.email_source[blob][source_ref]	string	*
data.email_source[blob][labels][]	array of objects (LabelBlob)	*
data.email_source[blob][labels][][blob]	object (Blob)	*
data.email_source[object_type]	string	*	The type of object this is attached to (should be the table name of the super type, eg: tickets, people, organizations). This typically is not set until after the email is processed (ie the status is 'processed').
data.email_source[object_id]	integer	*	The ID of the object this is attached to.
data.email_source[from_email]	string	*
data.email_source[status]	string	*	The current status of the message: - inserted: Only inserted - processing: Currently processing - complete: Fully processed - error: Tried to process but there was some kind of error (see error_code).
data.email_source[date_status]	DateTime	*
data.email_source[error_code]	string	*	When status is error, this is the code that describes the error.
data.email_source[date_created]	DateTime	*
data.date_created	DateTime	*	Date when message was created.
data.is_agent_note	boolean	*	Is this message agent note?
data.is_hidden	boolean	*	Is this message hidden?
data.creation_system	string	*	How this message was created.
data.ip_address	string	*	An ip address from which message was sent.
data.visitor_id	string	*	Unique ID of visitor left this message.
data.hostname	string	*	Host from which message was left.
data.geo_country	string	*	Country message is from (deprecated).
data.email	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.message_hash	string	*	An unique hash of message.
data.message	string	*	The message, will be in HTML!
data.message_full	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.message_raw	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.message_source	string	*	The message source.
data.message_source_type	string	*	The message source type.
data.show_full_hint	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.lang_code	string	*	The set/detected lang code.
data.email_message_id[]	array of objects (TicketMessageEmailId)	*
data.email_message_id[][id]	integer	*
data.email_message_id[][message]	object (TicketMessage)	*
data.email_message_id[][message][id]	integer	*	The unique id of message.
data.email_message_id[][message][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data.email_message_id[][message][person]	object (Person)	*	Person this message was sent by.
data.email_message_id[][message][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data.email_message_id[][message][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.email_message_id[][message][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.email_message_id[][message][date_created]	DateTime	*	Date when message was created.
data.email_message_id[][message][is_agent_note]	boolean	*	Is this message agent note?
data.email_message_id[][message][is_hidden]	boolean	*	Is this message hidden?
data.email_message_id[][message][creation_system]	string	*	How this message was created.
data.email_message_id[][message][ip_address]	string	*	An ip address from which message was sent.
data.email_message_id[][message][visitor_id]	string	*	Unique ID of visitor left this message.
data.email_message_id[][message][hostname]	string	*	Host from which message was left.
data.email_message_id[][message][geo_country]	string	*	Country message is from (deprecated).
data.email_message_id[][message][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.email_message_id[][message][message_hash]	string	*	An unique hash of message.
data.email_message_id[][message][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.email_message_id[][message][message]	string	*	The message, will be in HTML!
data.email_message_id[][message][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.email_message_id[][message][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.email_message_id[][message][message_source]	string	*	The message source.
data.email_message_id[][message][message_source_type]	string	*	The message source type.
data.email_message_id[][message][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.email_message_id[][message][lang_code]	string	*	The set/detected lang code.
data.email_message_id[][message][email_message_id][]	array of objects (TicketMessageEmailId)	*
data.email_message_id[][message][ticket_feedback][]	array of objects (TicketFeedback)	*
data.email_message_id[][message][ticket_feedback][][id]	integer	*
data.email_message_id[][message][ticket_feedback][][ticket]	object (Ticket)	*
data.email_message_id[][message][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data.email_message_id[][message][ticket_feedback][][person]	object (Person)	*
data.email_message_id[][message][ticket_feedback][][rating]	integer	*
data.email_message_id[][message][ticket_feedback][][message]	string	*
data.email_message_id[][message][ticket_feedback][][date_created]	DateTime	*
data.email_message_id[][message][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data.email_message_id[][message][ticket_message_forwards][][id]	integer	*
data.email_message_id[][message][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data.email_message_id[][message][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data.email_message_id[][message][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data.email_message_id[][message][ticket_message_forwards][][subject]	string	*
data.email_message_id[][message][ticket_message_forwards][][from_email]	string	*
data.email_message_id[][message][ticket_message_forwards][][tos]	array	*
data.email_message_id[][message][ticket_message_forwards][][ccs]	array	*
data.email_message_id[][message][ticket_message_forwards][][bccs]	array	*
data.email_message_id[][message][ticket_message_forwards][][message]	string	*
data.email_message_id[][message][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data.email_message_id[][message][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data.email_message_id[][message][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.email_message_id[][message][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.email_message_id[][message][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.email_message_id[][message][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.email_message_id[][message][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data.email_message_id[][message][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data.email_message_id[][message][ticket_message_forwards][][blobs][][authcode]	string	*
data.email_message_id[][message][ticket_message_forwards][][blobs][][blob_hash]	string	*
data.email_message_id[][message][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.email_message_id[][message][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data.email_message_id[][message][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data.email_message_id[][message][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data.email_message_id[][message][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data.email_message_id[][message][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data.email_message_id[][message][ticket_message_forwards][][blobs][][source_ref]	string	*
data.email_message_id[][message][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data.email_message_id[][message][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data.email_message_id[][message][ticket_message_forwards][][date_created]	DateTime	*
data.email_message_id[][message][channel_message]	object (TicketMessageChannelMessage)	*
data.email_message_id[][message][channel_message][id]	integer	*	@var int The unique id of message.
data.email_message_id[][message][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data.email_message_id[][message][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data.email_message_id[][message][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data.email_message_id[][message][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data.email_message_id[][message][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data.email_message_id[][message][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data.email_message_id[][message][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data.email_message_id[][message][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data.email_message_id[][message][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data.email_message_id[][email_id]	string	*
data.ticket_feedback[]	array of objects (TicketFeedback)	*
data.ticket_feedback[][id]	integer	*
data.ticket_feedback[][ticket]	object (Ticket)	*
data.ticket_feedback[][ticket_message]	object (TicketMessage)	*
data.ticket_feedback[][ticket_message][id]	integer	*	The unique id of message.
data.ticket_feedback[][ticket_message][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data.ticket_feedback[][ticket_message][person]	object (Person)	*	Person this message was sent by.
data.ticket_feedback[][ticket_message][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data.ticket_feedback[][ticket_message][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.ticket_feedback[][ticket_message][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.ticket_feedback[][ticket_message][date_created]	DateTime	*	Date when message was created.
data.ticket_feedback[][ticket_message][is_agent_note]	boolean	*	Is this message agent note?
data.ticket_feedback[][ticket_message][is_hidden]	boolean	*	Is this message hidden?
data.ticket_feedback[][ticket_message][creation_system]	string	*	How this message was created.
data.ticket_feedback[][ticket_message][ip_address]	string	*	An ip address from which message was sent.
data.ticket_feedback[][ticket_message][visitor_id]	string	*	Unique ID of visitor left this message.
data.ticket_feedback[][ticket_message][hostname]	string	*	Host from which message was left.
data.ticket_feedback[][ticket_message][geo_country]	string	*	Country message is from (deprecated).
data.ticket_feedback[][ticket_message][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.ticket_feedback[][ticket_message][message_hash]	string	*	An unique hash of message.
data.ticket_feedback[][ticket_message][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.ticket_feedback[][ticket_message][message]	string	*	The message, will be in HTML!
data.ticket_feedback[][ticket_message][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.ticket_feedback[][ticket_message][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.ticket_feedback[][ticket_message][message_source]	string	*	The message source.
data.ticket_feedback[][ticket_message][message_source_type]	string	*	The message source type.
data.ticket_feedback[][ticket_message][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.ticket_feedback[][ticket_message][lang_code]	string	*	The set/detected lang code.
data.ticket_feedback[][ticket_message][email_message_id][]	array of objects (TicketMessageEmailId)	*
data.ticket_feedback[][ticket_message][ticket_feedback][]	array of objects (TicketFeedback)	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][id]	integer	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][subject]	string	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][from_email]	string	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][tos]	array	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][ccs]	array	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][bccs]	array	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][message]	string	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][authcode]	string	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][blob_hash]	string	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][source_ref]	string	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data.ticket_feedback[][ticket_message][ticket_message_forwards][][date_created]	DateTime	*
data.ticket_feedback[][ticket_message][channel_message]	object (TicketMessageChannelMessage)	*
data.ticket_feedback[][ticket_message][channel_message][id]	integer	*	@var int The unique id of message.
data.ticket_feedback[][ticket_message][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data.ticket_feedback[][ticket_message][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data.ticket_feedback[][ticket_message][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data.ticket_feedback[][ticket_message][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data.ticket_feedback[][ticket_message][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data.ticket_feedback[][ticket_message][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data.ticket_feedback[][ticket_message][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data.ticket_feedback[][ticket_message][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data.ticket_feedback[][ticket_message][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data.ticket_feedback[][person]	object (Person)	*
data.ticket_feedback[][rating]	integer	*
data.ticket_feedback[][message]	string	*
data.ticket_feedback[][date_created]	DateTime	*
data.ticket_message_forwards[]	array of objects (TicketMessageForward)	*
data.ticket_message_forwards[][id]	integer	*
data.ticket_message_forwards[][ticket_message]	object (TicketMessage)	*
data.ticket_message_forwards[][ticket_message][id]	integer	*	The unique id of message.
data.ticket_message_forwards[][ticket_message][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data.ticket_message_forwards[][ticket_message][person]	object (Person)	*	Person this message was sent by.
data.ticket_message_forwards[][ticket_message][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data.ticket_message_forwards[][ticket_message][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.ticket_message_forwards[][ticket_message][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.ticket_message_forwards[][ticket_message][date_created]	DateTime	*	Date when message was created.
data.ticket_message_forwards[][ticket_message][is_agent_note]	boolean	*	Is this message agent note?
data.ticket_message_forwards[][ticket_message][is_hidden]	boolean	*	Is this message hidden?
data.ticket_message_forwards[][ticket_message][creation_system]	string	*	How this message was created.
data.ticket_message_forwards[][ticket_message][ip_address]	string	*	An ip address from which message was sent.
data.ticket_message_forwards[][ticket_message][visitor_id]	string	*	Unique ID of visitor left this message.
data.ticket_message_forwards[][ticket_message][hostname]	string	*	Host from which message was left.
data.ticket_message_forwards[][ticket_message][geo_country]	string	*	Country message is from (deprecated).
data.ticket_message_forwards[][ticket_message][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.ticket_message_forwards[][ticket_message][message_hash]	string	*	An unique hash of message.
data.ticket_message_forwards[][ticket_message][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.ticket_message_forwards[][ticket_message][message]	string	*	The message, will be in HTML!
data.ticket_message_forwards[][ticket_message][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.ticket_message_forwards[][ticket_message][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.ticket_message_forwards[][ticket_message][message_source]	string	*	The message source.
data.ticket_message_forwards[][ticket_message][message_source_type]	string	*	The message source type.
data.ticket_message_forwards[][ticket_message][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.ticket_message_forwards[][ticket_message][lang_code]	string	*	The set/detected lang code.
data.ticket_message_forwards[][ticket_message][email_message_id][]	array of objects (TicketMessageEmailId)	*
data.ticket_message_forwards[][ticket_message][ticket_feedback][]	array of objects (TicketFeedback)	*
data.ticket_message_forwards[][ticket_message][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data.ticket_message_forwards[][ticket_message][channel_message]	object (TicketMessageChannelMessage)	*
data.ticket_message_forwards[][ticket_message][channel_message][id]	integer	*	@var int The unique id of message.
data.ticket_message_forwards[][ticket_message][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data.ticket_message_forwards[][ticket_message][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data.ticket_message_forwards[][ticket_message][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data.ticket_message_forwards[][ticket_message][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data.ticket_message_forwards[][ticket_message][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data.ticket_message_forwards[][ticket_message][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data.ticket_message_forwards[][ticket_message][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data.ticket_message_forwards[][ticket_message][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data.ticket_message_forwards[][ticket_message][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data.ticket_message_forwards[][new_ticket]	object (Ticket)	*
data.ticket_message_forwards[][new_ticket_message]	object (TicketMessage)	*
data.ticket_message_forwards[][subject]	string	*
data.ticket_message_forwards[][from_email]	string	*
data.ticket_message_forwards[][tos]	array	*
data.ticket_message_forwards[][ccs]	array	*
data.ticket_message_forwards[][bccs]	array	*
data.ticket_message_forwards[][message]	string	*
data.ticket_message_forwards[][blobs][]	array of objects (Blob)	*
data.ticket_message_forwards[][blobs][][sys_name]	string	*	A unique system name for the blob.
data.ticket_message_forwards[][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.ticket_message_forwards[][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.ticket_message_forwards[][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.ticket_message_forwards[][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.ticket_message_forwards[][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data.ticket_message_forwards[][blobs][][file_url]	string	*	The HTTP link to download the file.
data.ticket_message_forwards[][blobs][][authcode]	string	*
data.ticket_message_forwards[][blobs][][blob_hash]	string	*
data.ticket_message_forwards[][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.ticket_message_forwards[][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data.ticket_message_forwards[][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data.ticket_message_forwards[][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data.ticket_message_forwards[][blobs][][date_created]	DateTime	*
data.ticket_message_forwards[][blobs][][is_temp]	boolean	*
data.ticket_message_forwards[][blobs][][source_ref]	string	*
data.ticket_message_forwards[][blobs][][labels][]	array of objects (LabelBlob)	*
data.ticket_message_forwards[][blobs][][labels][][blob]	object (Blob)	*
data.ticket_message_forwards[][date_created]	DateTime	*
data.channel_message	object (TicketMessageChannelMessage)	*
data.channel_message[id]	integer	*	@var int The unique id of message.
data.channel_message[ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data.channel_message[ticket_message][id]	integer	*	The unique id of message.
data.channel_message[ticket_message][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data.channel_message[ticket_message][person]	object (Person)	*	Person this message was sent by.
data.channel_message[ticket_message][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data.channel_message[ticket_message][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.channel_message[ticket_message][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.channel_message[ticket_message][date_created]	DateTime	*	Date when message was created.
data.channel_message[ticket_message][is_agent_note]	boolean	*	Is this message agent note?
data.channel_message[ticket_message][is_hidden]	boolean	*	Is this message hidden?
data.channel_message[ticket_message][creation_system]	string	*	How this message was created.
data.channel_message[ticket_message][ip_address]	string	*	An ip address from which message was sent.
data.channel_message[ticket_message][visitor_id]	string	*	Unique ID of visitor left this message.
data.channel_message[ticket_message][hostname]	string	*	Host from which message was left.
data.channel_message[ticket_message][geo_country]	string	*	Country message is from (deprecated).
data.channel_message[ticket_message][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.channel_message[ticket_message][message_hash]	string	*	An unique hash of message.
data.channel_message[ticket_message][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.channel_message[ticket_message][message]	string	*	The message, will be in HTML!
data.channel_message[ticket_message][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.channel_message[ticket_message][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.channel_message[ticket_message][message_source]	string	*	The message source.
data.channel_message[ticket_message][message_source_type]	string	*	The message source type.
data.channel_message[ticket_message][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.channel_message[ticket_message][lang_code]	string	*	The set/detected lang code.
data.channel_message[ticket_message][email_message_id][]	array of objects (TicketMessageEmailId)	*
data.channel_message[ticket_message][ticket_feedback][]	array of objects (TicketFeedback)	*
data.channel_message[ticket_message][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data.channel_message[ticket_message][channel_message]	object (TicketMessageChannelMessage)	*
data.channel_message[provider]	string	*	@var string name of the provider from the ticket-channel service
data.channel_message[platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data.channel_message[channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data.channel_message[message_id]	string	*	@var string ID of the message from the ticket-channel service
data.channel_message[message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data.channel_message[channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data.channel_message[message_type]	string	*	@var string name of the message type from the ticket-channel service
data.channel_message[created_at]	DateTime	*	@var \DateTime Date when channel message was created.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/tickets/{parentId}/messages/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_messages.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Required?	Format	Description
message	string	false		Message
format	choice	false	["html","text"]
message_source_type	string	false
message_source	string	false
is_note	boolean	false
date_created	datetime	false	yyyy-MM-dd'T'HH:mm:ss

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/tickets/{parentId}/messages/{id}/attachments

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_messages.get_attachments

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
parentId
id		int

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (TicketAttachment)	*
data[][blob]	object (Blob)	*	Actual attachment.
data[][blob][sys_name]	string	*	A unique system name for the blob.
data[][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][blob][file_url]	string	*	The HTTP link to download the file.
data[][blob][authcode]	string	*
data[][blob][blob_hash]	string	*
data[][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][blob][date_created]	DateTime	*
data[][blob][is_temp]	boolean	*
data[][blob][source_ref]	string	*
data[][blob][labels][]	array of objects (LabelBlob)	*
data[][blob][labels][][blob]	object (Blob)	*
data[][message]	integer id (TicketMessage)	*	Message - holder of this attachment.
data[][id]	integer	*	The unique ID.
data[][ticket]	integer id (Ticket)	*	Ticket this attachment belongs to.
data[][person]	integer id (Person)	*	Who created the attachment.
data[][is_agent_note]	boolean	*	True if this attachmen just a note.
data[][is_inline]	boolean	*	Is this attachment is embed in message.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

GET /api/v2/tickets/{parentId}/messages/{id}/download-attachments CRUD

Download message attachments as zip file

Applicable api modes

signed

Api tags for this endpoint

tickets.ticket_messages.download_attachments

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer\|string	The id\|ref of the resource
parentId

Status Code	Description
200	Returns the requested resource
400	We will return this in case your request was malformed

GET /api/v2/tickets/{parentId}/messages/{id}/download-email CRUD

Download message email file

Applicable api modes

signed

Api tags for this endpoint

tickets.ticket_messages.download_email

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer\|string	The id\|ref of the resource
parentId

Status Code	Description
200	Returns the requested resource
400	We will return this in case your request was malformed

GET /api/v2/tickets/{parentId}/messages/{id}/download-sendmail/{sendmailId} CRUD

Download outgoing message email file

Applicable api modes

signed

Api tags for this endpoint

tickets.ticket_messages.download_sendmail

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer\|string	The id\|ref of the resource
sendmailId	\d+
parentId

Status Code	Description
200	Returns the requested resource
400	We will return this in case your request was malformed

GET /api/v2/tickets/{parentId}/ticket_slas CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_slas.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
parentId

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (TicketSla)	*
data[][id]	integer	*	The unique ID.
data[][sla_status]	string	*	The SLA status.
data[][warn_date]	DateTime	*	The SLA warn date.
data[][fail_date]	DateTime	*	The SLA fail date.
data[][is_completed]	boolean	*	Is the SLA completed?
data[][is_completed_set]	boolean	*	Completed by automated action.
data[][completed_time_taken]	integer	*	Time taken.
data[][ticket]	integer id (Ticket)	*	Ticket.
data[][sla]	integer id (Sla)	*	SLA.
data[][date_applied]	DateTime	*	time and date when SLA was applied to the ticket.
data[][date_completed]	DateTime	*	time when SLA status became OK.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/tickets/{parentId}/ticket_slas

Create Ticket SLA.

Documentation

Create Ticket SLA.

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_slas.post_single_sla

Requirements
Response

Name	Requirement	Type	Description
parentId	\d+	integer	the id of parent ticket
sla	\d+	integer	the id of parent SLA

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.sla_status	string	*	The SLA status.
data.warn_date	DateTime	*	The SLA warn date.
data.fail_date	DateTime	*	The SLA fail date.
data.is_completed	boolean	*	Is the SLA completed?
data.is_completed_set	boolean	*	Completed by automated action.
data.completed_time_taken	integer	*	Time taken.
data.ticket	integer id (Ticket)	*	Ticket.
data.sla	integer id (Sla)	*	SLA.
data.date_applied	DateTime	*	time and date when SLA was applied to the ticket.
data.date_completed	DateTime	*	time when SLA status became OK.

POST /api/v2/tickets/{parentId}/ticket_slas CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_slas.post

Requirements
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.sla_status	string	*	The SLA status.
data.warn_date	DateTime	*	The SLA warn date.
data.fail_date	DateTime	*	The SLA fail date.
data.is_completed	boolean	*	Is the SLA completed?
data.is_completed_set	boolean	*	Completed by automated action.
data.completed_time_taken	integer	*	Time taken.
data.ticket	integer id (Ticket)	*	Ticket.
data.sla	integer id (Sla)	*	SLA.
data.date_applied	DateTime	*	time and date when SLA was applied to the ticket.
data.date_completed	DateTime	*	time when SLA status became OK.

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

PUT /api/v2/tickets/{parentId}/ticket_slas

Update Ticket SLA.

DELETE /api/v2/tickets/{parentId}/ticket_slas/by_sla/{slaId}

Delete single Ticket SLA.

GET /api/v2/tickets/{parentId}/ticket_slas/by_sla/{slaId}

Retrieve single SLA for ticket by parent SLA's ID.

Documentation

Retrieve single SLA for ticket by parent SLA's ID.

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_slas.get_single_ticket_sla

Requirements
Response

Name	Requirement	Type	Description
parentId	\d+	integer	the id of parent ticket
slaId	\d+	integer	the id of parent SLA

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.sla_status	string	*	The SLA status.
data.warn_date	DateTime	*	The SLA warn date.
data.fail_date	DateTime	*	The SLA fail date.
data.is_completed	boolean	*	Is the SLA completed?
data.is_completed_set	boolean	*	Completed by automated action.
data.completed_time_taken	integer	*	Time taken.
data.ticket	integer id (Ticket)	*	Ticket.
data.sla	integer id (Sla)	*	SLA.
data.date_applied	DateTime	*	time and date when SLA was applied to the ticket.
data.date_completed	DateTime	*	time when SLA status became OK.

GET /api/v2/tickets/{parentId}/ticket_slas/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_slas.count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
parentId

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/tickets/{parentId}/ticket_slas/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_slas.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/tickets/{parentId}/ticket_slas/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_slas.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.sla_status	string	*	The SLA status.
data.warn_date	DateTime	*	The SLA warn date.
data.fail_date	DateTime	*	The SLA fail date.
data.is_completed	boolean	*	Is the SLA completed?
data.is_completed_set	boolean	*	Completed by automated action.
data.completed_time_taken	integer	*	Time taken.
data.ticket	integer id (Ticket)	*	Ticket.
data.sla	integer id (Sla)	*	SLA.
data.date_applied	DateTime	*	time and date when SLA was applied to the ticket.
data.date_completed	DateTime	*	time when SLA status became OK.

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/tickets/{parentId}/ticket_slas/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_slas.put

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
parentId

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

PUT /api/v2/tickets/{ticket}/actions/lock

Lock a ticket.

Documentation

Lock a ticket.

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_actions.lock

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
ticket		Ticket

Parameter	Type	Required?	Format	Description
	boolean	false		force apply

Status Code	Description
204	Returned in case of successful resource update
400	We will return this in case your request was malformed

PUT /api/v2/tickets/{ticket}/actions/unlock

Unlock a ticket.

Documentation

Unlock a ticket.

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_actions.unlock

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
ticket		Ticket

Parameter	Type	Required?	Format	Description
	boolean	false		force apply

Status Code	Description
204	Returned in case of successful resource update
400	We will return this in case your request was malformed

DELETE /api/v2/tickets/{ticket}/links

delete relation between two tickets

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_links.delete

Requirements
Status Codes

Name	Requirement	Type	Description
ticketId	\d+	integer	base ticket
unlinkTicketId	\d+	integer	ticket to unlink
link_type	parent\|sibling\|child	string	you have to specify relation type to unlink tickets properly
ticket		Ticket

Status Code	Description
201	Tickets was unlinked successfully
400	You are trying to unlink ticket from itself Wrong relation type
404	Ticket with 'ticketId' wasn't found Ticket with 'unlinkTicketId' wasn't found

GET /api/v2/tickets/{ticket}/links

get tickets linked with ticket under provided id

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_links.list

Requirements
Response
Status Codes

Name	Requirement	Type	Description
ticketId	\d+	integer	ticket to find id
ticket		Ticket

Parameter	Type	Versions	Description
data[]	array of objects (LinkedTickets)	*
data[][parent]	object (Ticket)	*	Parent ticket.
data[][parent][id]	integer	*
data[][parent][ref]	string	*
data[][parent][auth]	string	*
data[][parent][parent_ticket]	object (Ticket)	*	Parent ticket.
data[][parent][children_tickets][]	array of objects (Ticket)	*
data[][parent][language]	object (Language)	*	The language the ticket is in.
data[][parent][language][id]	integer	*	The unique ID.
data[][parent][language][sys_name]	string	*	The unique sys name assigned to the language.
data[][parent][language][title]	string	*	Title of the language.
data[][parent][language][title_local]	string	*	Title of the language.
data[][parent][language][base_filepath]	string	*	The base filepath for default phrases for this lang.
data[][parent][language][locale]	string	*	The locale code.
data[][parent][language][flag_image]	string	*	String path to image.
data[][parent][language][is_rtl]	boolean	*	True if this is a right-to-left language.
data[][parent][language][has_user]	boolean	*	True if has user.
data[][parent][language][has_agent]	boolean	*	True if has agent.
data[][parent][language][has_admin]	boolean	*	True if has admin.
data[][parent][language][plural_categories][]	array of strings	*
data[][parent][language][plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data[][parent][language][flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`
data[][parent][brand]	object (Brand)	*
data[][parent][brand][id]	integer	*	The unique ID.
data[][parent][brand][name]	string	*	The brand name.
data[][parent][brand][slug]	string	*
data[][parent][brand][url]	string	*	The brand url.
data[][parent][brand][theme_set]	object (ThemeSet)	*
data[][parent][brand][theme_set][id]	integer	*
data[][parent][brand][theme_set][theme_id]	string	*
data[][parent][brand][theme_set][title]	string	*
data[][parent][brand][edit_theme_set]	object (ThemeSet)	*
data[][parent][brand][departments][]	array of objects (Department)	*
data[][parent][brand][departments][][id]	integer	*
data[][parent][brand][departments][][parent]	object (Department)	*
data[][parent][brand][departments][][children][]	array of objects (Department)	*
data[][parent][brand][departments][][title]	string	*
data[][parent][brand][departments][][user_title]	string	*
data[][parent][brand][departments][][is_tickets_enabled]	boolean	*
data[][parent][brand][departments][][is_chat_enabled]	boolean	*
data[][parent][brand][departments][][display_order]	integer	*
data[][parent][brand][departments][][avatar]	object (Blob)	*
data[][parent][brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data[][parent][brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][parent][brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][parent][brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][parent][brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][parent][brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data[][parent][brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data[][parent][brand][departments][][avatar][authcode]	string	*
data[][parent][brand][departments][][avatar][blob_hash]	string	*
data[][parent][brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][parent][brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][parent][brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][parent][brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][parent][brand][departments][][avatar][date_created]	DateTime	*
data[][parent][brand][departments][][avatar][is_temp]	boolean	*
data[][parent][brand][departments][][avatar][source_ref]	string	*
data[][parent][brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data[][parent][brand][departments][][avatar][labels][][blob]	object (Blob)	*
data[][parent][brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][parent][brand][departments][][brands][]	array of objects (Brand)	*
data[][parent][brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data[][parent][brand][departments][][permissions][][department]	integer id (Department)	*
data[][parent][brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][parent][brand][departments][][permissions][][name]	string	*	The name of the permission.
data[][parent][brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][parent][brand][departments][][permissions][][is_active]	boolean	*
data[][parent][brand][departments][][chat_queue]	object (UserChatQueue)	*
data[][parent][brand][departments][][chat_queue][id]	integer	*	The unique ID.
data[][parent][brand][departments][][chat_queue][name]	string	*
data[][parent][brand][departments][][chat_queue][routing_model]	string	*
data[][parent][brand][departments][][chat_queue][answer_timeout]	integer	*
data[][parent][brand][departments][][chat_queue][is_all_agents]	boolean	*
data[][parent][brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data[][parent][brand][departments][][chat_queue][max_queue_size]	integer	*
data[][parent][brand][theme_sets][]	array of objects (ThemeSet)	*
data[][parent][department]	object (Department)	*
data[][parent][department][id]	integer	*
data[][parent][department][parent]	object (Department)	*
data[][parent][department][children][]	array of objects (Department)	*
data[][parent][department][title]	string	*
data[][parent][department][user_title]	string	*
data[][parent][department][is_tickets_enabled]	boolean	*
data[][parent][department][is_chat_enabled]	boolean	*
data[][parent][department][display_order]	integer	*
data[][parent][department][avatar]	object (Blob)	*
data[][parent][department][avatar][sys_name]	string	*	A unique system name for the blob.
data[][parent][department][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][parent][department][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][parent][department][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][parent][department][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][parent][department][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data[][parent][department][avatar][file_url]	string	*	The HTTP link to download the file.
data[][parent][department][avatar][authcode]	string	*
data[][parent][department][avatar][blob_hash]	string	*
data[][parent][department][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][parent][department][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][parent][department][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][parent][department][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][parent][department][avatar][date_created]	DateTime	*
data[][parent][department][avatar][is_temp]	boolean	*
data[][parent][department][avatar][source_ref]	string	*
data[][parent][department][avatar][labels][]	array of objects (LabelBlob)	*
data[][parent][department][avatar][labels][][blob]	object (Blob)	*
data[][parent][department][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][parent][department][brands][]	array of objects (Brand)	*
data[][parent][department][permissions][]	array of objects (DepartmentPermission)	*
data[][parent][department][permissions][][department]	integer id (Department)	*
data[][parent][department][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][parent][department][permissions][][name]	string	*	The name of the permission.
data[][parent][department][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][parent][department][permissions][][is_active]	boolean	*
data[][parent][department][chat_queue]	object (UserChatQueue)	*
data[][parent][department][chat_queue][id]	integer	*	The unique ID.
data[][parent][department][chat_queue][name]	string	*
data[][parent][department][chat_queue][routing_model]	string	*
data[][parent][department][chat_queue][answer_timeout]	integer	*
data[][parent][department][chat_queue][is_all_agents]	boolean	*
data[][parent][department][chat_queue][departments][]	array of objects (Department)	*
data[][parent][department][chat_queue][max_queue_size]	integer	*
data[][parent][category]	object (TicketCategory)	*
data[][parent][category][id]	integer	*	The unique ID.
data[][parent][category][parent]	integer id (TicketCategory)	*	This category parent.
data[][parent][category][title]	string	*	Category title.
data[][parent][category][display_order]	integer	*	Obviously it's display order for lists.
data[][parent][priority]	object (TicketPriority)	*
data[][parent][priority][id]	integer	*	The unique ID.
data[][parent][priority][title]	string	*	Priority title.
data[][parent][priority][priority]	integer	*	The priority itself.
data[][parent][workflow]	object (TicketWorkflow)	*
data[][parent][workflow][id]	integer	*	The unique ID.
data[][parent][workflow][title]	string	*	Workflow title.
data[][parent][workflow][display_order]	integer	*	Workflow display order.
data[][parent][product]	object (Product)	*
data[][parent][product][parent]	integer id (Product)	*	Parent of the product.
data[][parent][person]	object (Person)	*
data[][parent][person_email]	object (PersonEmail)	*
data[][parent][person_email][id]	integer	*	The unique ID.
data[][parent][person_email][person]	integer id (Person)	*	Person owner of email.
data[][parent][person_email][email]	string	*	The email address.
data[][parent][person_email][email_domain]	string	*	The email address domain.
data[][parent][person_email][is_validated]	boolean	*	True if validation passed.
data[][parent][person_email][date_created]	DateTime	*	The original time the email was created.
data[][parent][agent]	object (Person)	*
data[][parent][agent_team]	object (AgentTeam)	*
data[][parent][agent_team][id]	integer	*	The unique ID.
data[][parent][agent_team][name]	string	*	The name of agent team.
data[][parent][agent_team][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][parent][organization]	object (Organization)	*
data[][parent][organization][id]	integer	*	The unique ID.
data[][parent][organization][picture_blob]	object (Blob)	*	The org picture.
data[][parent][organization][picture_blob][sys_name]	string	*	A unique system name for the blob.
data[][parent][organization][picture_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][parent][organization][picture_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][parent][organization][picture_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][parent][organization][picture_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][parent][organization][picture_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][parent][organization][picture_blob][file_url]	string	*	The HTTP link to download the file.
data[][parent][organization][picture_blob][authcode]	string	*
data[][parent][organization][picture_blob][blob_hash]	string	*
data[][parent][organization][picture_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][parent][organization][picture_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][parent][organization][picture_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][parent][organization][picture_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][parent][organization][picture_blob][date_created]	DateTime	*
data[][parent][organization][picture_blob][is_temp]	boolean	*
data[][parent][organization][picture_blob][source_ref]	string	*
data[][parent][organization][picture_blob][labels][]	array of objects (LabelBlob)	*
data[][parent][organization][picture_blob][labels][][blob]	object (Blob)	*
data[][parent][organization][icon_property]	object (IconProperty)	*
data[][parent][organization][icon_property][urn]	string	*
data[][parent][organization][icon_property][options]	array	*
data[][parent][organization][name]	string	*	The organization name.
data[][parent][organization][summary]	string	*	The summary field as filled in by agents.
data[][parent][organization][importance]	integer	*	The org importance.
data[][parent][organization][custom_data][]	array of objects (CustomDataOrganization)	*
data[][parent][organization][custom_data][][organization]	object (Organization)	*
data[][parent][organization][custom_data][][field]	object (CustomDefOrganization)	*
data[][parent][organization][custom_data][][field][parent]	object (CustomDefOrganization)	*	Field`s parent.
data[][parent][organization][custom_data][][field][children][]	array of objects (CustomDefOrganization)	*	Field children.
data[][parent][organization][custom_data][][root_field]	object (CustomDefOrganization)	*
data[][parent][organization][usergroups][]	array of objects (Usergroup)	*	Usergroups the user belongs to.
data[][parent][organization][usergroups][][id]	integer	*	The unique ID, DB-generated.
data[][parent][organization][usergroups][][title]	string	*	Title of the usergroup.
data[][parent][organization][usergroups][][note]	string	*	A note or description about the usergroup.
data[][parent][organization][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data[][parent][organization][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data[][parent][organization][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data[][parent][organization][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data[][parent][organization][usergroups][][permissions][][id]	integer	*	The unique ID.
data[][parent][organization][usergroups][][permissions][][name]	string	*	The name of the permission.
data[][parent][organization][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][parent][organization][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data[][parent][organization][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data[][parent][organization][usergroups][][department_permissions][][department]	integer id (Department)	*
data[][parent][organization][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][parent][organization][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data[][parent][organization][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][parent][organization][usergroups][][department_permissions][][is_active]	boolean	*
data[][parent][organization][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data[][parent][organization][auto_cc_people][]	array of objects (Person)	*	Users who are set to automatically be added to tickets and other org things.
data[][parent][organization][labels][]	array of objects (LabelOrganization)	*
data[][parent][organization][labels][][organization]	object (Organization)	*
data[][parent][organization][contact_data][]	array of objects (OrganizationContactData)	*
data[][parent][organization][emails][]	array of objects (OrganizationEmail)	*
data[][parent][organization][emails][][id]	integer	*	The unique log id.
data[][parent][organization][emails][][organization]	object (Organization)	*
data[][parent][organization][emails][][email]	string	*
data[][parent][organization][emails][][date_created]	DateTime	*
data[][parent][organization][email_domains][]	array of objects (OrganizationEmailDomain)	*
data[][parent][organization][email_domains][][domain]	string	*	The email domain.
data[][parent][organization][email_domains][][organization]	object (Organization)	*	The users organization.
data[][parent][organization][date_created]	DateTime	*	The date the org was inserted into the system.
data[][parent][organization][members][]	array of objects (Person)	*
data[][parent][organization][parent]	object (Organization)	*
data[][parent][organization][children][]	array of objects (Organization)	*
data[][parent][organization][tickets][]	array of objects (Ticket)	*
data[][parent][organization][organization_members][]	array of objects (OrganizationMember)	*
data[][parent][organization][organization_members][][id]	integer	*
data[][parent][organization][organization_members][][person]	integer id (Person)	*
data[][parent][organization][organization_members][][organization]	integer id (Organization)	*
data[][parent][organization][organization_members][][is_manager]	boolean	*
data[][parent][organization][organization_members][][position]	string	*
data[][parent][organization][organization_members][][created_at]	DateTime	*
data[][parent][organization][organization_members][][updated_at]	DateTime	*
data[][parent][linked_chat]	object (ChatConversation)	*
data[][parent][linked_chat][id]	integer	*	The unique id of chat conversation.
data[][parent][linked_chat][department]	object (Department)	*	Department which chat was assigned.
data[][parent][linked_chat][brand]	object (Brand)	*	Department which chat was assigned.
data[][parent][linked_chat][task_id]	integer	*
data[][parent][linked_chat][ticket]	object (Ticket)	*
data[][parent][linked_chat][labels][]	array of objects (LabelChatConversation)	*
data[][parent][linked_chat][labels][][chat]	object (ChatConversation)	*
data[][parent][linked_chat][subject]	string	*	Subject of the chat conversation.
data[][parent][linked_chat][status]	string	*	Status of the chat conversation.
data[][parent][linked_chat][agent]	object (Person)	*	If this is a user conversation, this is the agent assigned.
data[][parent][linked_chat][agent_team]	object (AgentTeam)	*	If this is a team chat, the team it is.
data[][parent][linked_chat][person]	object (Person)	*	If this is a user conversation, this is the user who started the chat.
data[][parent][linked_chat][session]	object (Session)	*	If this is a user convo, this is the users session.
data[][parent][linked_chat][session][id]	integer	*	The unique ID.
data[][parent][linked_chat][session][auth]	string	*	The authcode for the session to verify an id.
data[][parent][linked_chat][session][interface]	string	*	The Interface the session is for.
data[][parent][linked_chat][session][person]	object (Person)	*
data[][parent][linked_chat][session][user_agent]	string	*	The users user agent string.
data[][parent][linked_chat][session][visitor_id]	string	*
data[][parent][linked_chat][session][ip_address]	string	*	The users IP address.
data[][parent][linked_chat][session][data]	string	*
data[][parent][linked_chat][session][is_person]	boolean	*
data[][parent][linked_chat][session][is_bot]	boolean	*
data[][parent][linked_chat][session][is_helpdesk]	boolean	*
data[][parent][linked_chat][session][active_status]	string	*	(Agents) Status (available or away).
data[][parent][linked_chat][session][is_chat_available]	boolean	*	(Agents) Wehn status is available, if they are available for chat.
data[][parent][linked_chat][session][date_created]	DateTime	*
data[][parent][linked_chat][session][date_last]	DateTime	*
data[][parent][linked_chat][session][date_last_page]	DateTime	*
data[][parent][linked_chat][visitor_id]	string	*
data[][parent][linked_chat][person_name]	string	*	User chat: The users name, if they arent a person.
data[][parent][linked_chat][person_email]	string	*	User chat: The users email, if they aren`t a person.
data[][parent][linked_chat][participants][]	array of objects (Person)	*
data[][parent][linked_chat][messages][]	array of objects (ChatMessage)	*
data[][parent][linked_chat][messages][][id]	integer	*	The unique ID.
data[][parent][linked_chat][messages][][author_id]	integer	*	Author id (legacy).
data[][parent][linked_chat][messages][][author_type]	string	*	Author type (legacy).
data[][parent][linked_chat][messages][][conversation_id]	integer	*	Conversation id (legacy).
data[][parent][linked_chat][messages][][author]	integer id (Person)	*	Person who created the message.
data[][parent][linked_chat][messages][][content]	string	*	The message.
data[][parent][linked_chat][messages][][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data[][parent][linked_chat][messages][][is_user]	boolean	*	Is this an user's message? (send from the widget).
data[][parent][linked_chat][messages][][is_html]	boolean	*	Is the content an HTML message?
data[][parent][linked_chat][messages][][metadata]	array	*	Additional data.
data[][parent][linked_chat][messages][][date_created]	DateTime	*	Date message was created.
data[][parent][linked_chat][messages][][date_received]	DateTime	*	Date message was received.
data[][parent][linked_chat][custom_data][]	array of objects (CustomDataChat)	*
data[][parent][linked_chat][custom_data][][conversation]	object (ChatConversation)	*	The conversation the message belongs to.
data[][parent][linked_chat][custom_data][][field]	object (CustomDefChat)	*
data[][parent][linked_chat][custom_data][][field][parent]	object (CustomDefChat)	*
data[][parent][linked_chat][custom_data][][field][children][]	array of objects (CustomDefChat)	*	Field children.
data[][parent][linked_chat][custom_data][][root_field]	object (CustomDefChat)	*
data[][parent][linked_chat][rating_response_time]	integer	*
data[][parent][linked_chat][rating_overall]	integer	*
data[][parent][linked_chat][rating_comment]	string	*
data[][parent][linked_chat][is_agent]	boolean	*	Is this an agent chat.
data[][parent][linked_chat][is_window]	boolean	*	If the chat is popped out into a window. This is used to make sure the JS widget on pages doesn't load again.
data[][parent][linked_chat][date_created]	DateTime	*	Date when chat was started.
data[][parent][linked_chat][date_user_waiting]	DateTime	*	Since when the user has started waiting (i.e., time the assignment was 0).
data[][parent][linked_chat][date_assigned]	DateTime	*
data[][parent][linked_chat][date_agent_typing]	DateTime	*	Date when agent typed last time.
data[][parent][linked_chat][date_first_agent_message]	DateTime	*
data[][parent][linked_chat][date_ended]	DateTime	*	Date when chat was ended.
data[][parent][linked_chat][total_to_ended]	integer	*
data[][parent][linked_chat][ended_by]	string	*	Who ended the chat.
data[][parent][linked_chat][should_send_transcript]	boolean	*	True if transcript should be send.
data[][parent][linked_chat][date_transcript_sent]	DateTime	*	Date when transcript was sent.
data[][parent][linked_chat][email_validation_code]	string	*
data[][parent][linked_chat][email_validated]	boolean	*
data[][parent][linked_chat][access_token]	string	*
data[][parent][attachments][]	array of objects (TicketAttachment)	*
data[][parent][attachments][][id]	integer	*	The unique ID.
data[][parent][attachments][][ticket]	integer id (Ticket)	*	Ticket this attachment belongs to.
data[][parent][attachments][][person]	integer id (Person)	*	Who created the attachment.
data[][parent][attachments][][blob]	object (Blob)	*	Actual attachment.
data[][parent][attachments][][blob][sys_name]	string	*	A unique system name for the blob.
data[][parent][attachments][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][parent][attachments][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][parent][attachments][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][parent][attachments][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][parent][attachments][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][parent][attachments][][blob][file_url]	string	*	The HTTP link to download the file.
data[][parent][attachments][][blob][authcode]	string	*
data[][parent][attachments][][blob][blob_hash]	string	*
data[][parent][attachments][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][parent][attachments][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][parent][attachments][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][parent][attachments][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][parent][attachments][][blob][date_created]	DateTime	*
data[][parent][attachments][][blob][is_temp]	boolean	*
data[][parent][attachments][][blob][source_ref]	string	*
data[][parent][attachments][][blob][labels][]	array of objects (LabelBlob)	*
data[][parent][attachments][][blob][labels][][blob]	object (Blob)	*
data[][parent][attachments][][message]	integer id (TicketMessage)	*	Message - holder of this attachment.
data[][parent][attachments][][is_agent_note]	boolean	*	True if this attachmen just a note.
data[][parent][attachments][][is_inline]	boolean	*	Is this attachment is embed in message.
data[][parent][access_codes][]	array of objects (TicketAccessCode)	*
data[][parent][access_codes][][id]	integer	*
data[][parent][access_codes][][ticket]	object (Ticket)	*
data[][parent][access_codes][][person]	object (Person)	*
data[][parent][access_codes][][auth]	string	*
data[][parent][messages][]	array of objects (TicketMessage)	*
data[][parent][messages][][id]	integer	*	The unique id of message.
data[][parent][messages][][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data[][parent][messages][][person]	object (Person)	*	Person this message was sent by.
data[][parent][messages][][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data[][parent][messages][][email_source][id]	integer	*
data[][parent][messages][][email_source][uuid]	string	*
data[][parent][messages][][email_source][blob]	object (Blob)	*
data[][parent][messages][][email_source][blob][sys_name]	string	*	A unique system name for the blob.
data[][parent][messages][][email_source][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][parent][messages][][email_source][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][parent][messages][][email_source][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][parent][messages][][email_source][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][parent][messages][][email_source][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][parent][messages][][email_source][blob][file_url]	string	*	The HTTP link to download the file.
data[][parent][messages][][email_source][blob][authcode]	string	*
data[][parent][messages][][email_source][blob][blob_hash]	string	*
data[][parent][messages][][email_source][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][parent][messages][][email_source][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][parent][messages][][email_source][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][parent][messages][][email_source][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][parent][messages][][email_source][blob][date_created]	DateTime	*
data[][parent][messages][][email_source][blob][is_temp]	boolean	*
data[][parent][messages][][email_source][blob][source_ref]	string	*
data[][parent][messages][][email_source][blob][labels][]	array of objects (LabelBlob)	*
data[][parent][messages][][email_source][blob][labels][][blob]	object (Blob)	*
data[][parent][messages][][email_source][object_type]	string	*	The type of object this is attached to (should be the table name of the super type, eg: tickets, people, organizations). This typically is not set until after the email is processed (ie the status is 'processed').
data[][parent][messages][][email_source][object_id]	integer	*	The ID of the object this is attached to.
data[][parent][messages][][email_source][from_email]	string	*
data[][parent][messages][][email_source][status]	string	*	The current status of the message: - inserted: Only inserted - processing: Currently processing - complete: Fully processed - error: Tried to process but there was some kind of error (see error_code).
data[][parent][messages][][email_source][date_status]	DateTime	*
data[][parent][messages][][email_source][error_code]	string	*	When status is error, this is the code that describes the error.
data[][parent][messages][][email_source][date_created]	DateTime	*
data[][parent][messages][][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data[][parent][messages][][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data[][parent][messages][][snippet_use_logs][][id]	integer	*	The unique ID.
data[][parent][messages][][snippet_use_logs][][snippet]	object (SnippetV2)	*	Snippet used.
data[][parent][messages][][snippet_use_logs][][snippet][id]	integer	*
data[][parent][messages][][snippet_use_logs][][snippet][title]	string	*
data[][parent][messages][][snippet_use_logs][][snippet][author]	object (Person)	*
data[][parent][messages][][snippet_use_logs][][snippet][is_private]	boolean	*
data[][parent][messages][][snippet_use_logs][][snippet][avatar]	object (Blob)	*
data[][parent][messages][][snippet_use_logs][][snippet][avatar][sys_name]	string	*	A unique system name for the blob.
data[][parent][messages][][snippet_use_logs][][snippet][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][parent][messages][][snippet_use_logs][][snippet][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][parent][messages][][snippet_use_logs][][snippet][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][parent][messages][][snippet_use_logs][][snippet][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][parent][messages][][snippet_use_logs][][snippet][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data[][parent][messages][][snippet_use_logs][][snippet][avatar][file_url]	string	*	The HTTP link to download the file.
data[][parent][messages][][snippet_use_logs][][snippet][avatar][authcode]	string	*
data[][parent][messages][][snippet_use_logs][][snippet][avatar][blob_hash]	string	*
data[][parent][messages][][snippet_use_logs][][snippet][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][parent][messages][][snippet_use_logs][][snippet][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][parent][messages][][snippet_use_logs][][snippet][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][parent][messages][][snippet_use_logs][][snippet][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][parent][messages][][snippet_use_logs][][snippet][avatar][date_created]	DateTime	*
data[][parent][messages][][snippet_use_logs][][snippet][avatar][is_temp]	boolean	*
data[][parent][messages][][snippet_use_logs][][snippet][avatar][source_ref]	string	*
data[][parent][messages][][snippet_use_logs][][snippet][avatar][labels][]	array of objects (LabelBlob)	*
data[][parent][messages][][snippet_use_logs][][snippet][avatar][labels][][blob]	object (Blob)	*
data[][parent][messages][][snippet_use_logs][][snippet][status]	string	*
data[][parent][messages][][snippet_use_logs][][snippet][shortcut_codes]	array	*
data[][parent][messages][][snippet_use_logs][][snippet][inline_translations]	array	*
data[][parent][messages][][snippet_use_logs][][snippet][translations][]	array of objects (SnippetV2Translation)	*
data[][parent][messages][][snippet_use_logs][][snippet][translations][][id]	integer	*	The unique ID.
data[][parent][messages][][snippet_use_logs][][snippet][translations][][snippet]	object (SnippetV2)	*	Snippet translated.
data[][parent][messages][][snippet_use_logs][][snippet][translations][][language]	object (Language)	*
data[][parent][messages][][snippet_use_logs][][snippet][translations][][content]	array	*	Snippet content.
data[][parent][messages][][snippet_use_logs][][snippet][translations][][blobs][]	array of objects (Blob)	*
data[][parent][messages][][snippet_use_logs][][snippet][categories][]	array of objects (SnippetV2Category)	*
data[][parent][messages][][snippet_use_logs][][snippet][categories][][id]	integer	*
data[][parent][messages][][snippet_use_logs][][snippet][categories][][title]	string	*
data[][parent][messages][][snippet_use_logs][][snippet][categories][][is_global]	boolean	*
data[][parent][messages][][snippet_use_logs][][snippet][categories][][display_order]	integer	*
data[][parent][messages][][snippet_use_logs][][snippet][categories][][parent]	object (SnippetV2Category)	*
data[][parent][messages][][snippet_use_logs][][snippet][categories][][agent_teams][]	array of objects (AgentTeam)	*
data[][parent][messages][][snippet_use_logs][][snippet][display_order]	integer	*
data[][parent][messages][][snippet_use_logs][][snippet][date_created]	DateTime	*
data[][parent][messages][][snippet_use_logs][][ticket_message]	object (TicketMessage)	*	Ticket Message where the snippet was used.
data[][parent][messages][][snippet_use_logs][][chat_message]	object (ChatMessage)	*	Chat Message where the snippet was used.
data[][parent][messages][][snippet_use_logs][][chat_message][id]	integer	*	The unique ID.
data[][parent][messages][][snippet_use_logs][][chat_message][author_id]	integer	*	Author id (legacy).
data[][parent][messages][][snippet_use_logs][][chat_message][author_type]	string	*	Author type (legacy).
data[][parent][messages][][snippet_use_logs][][chat_message][conversation_id]	integer	*	Conversation id (legacy).
data[][parent][messages][][snippet_use_logs][][chat_message][author]	integer id (Person)	*	Person who created the message.
data[][parent][messages][][snippet_use_logs][][chat_message][content]	string	*	The message.
data[][parent][messages][][snippet_use_logs][][chat_message][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data[][parent][messages][][snippet_use_logs][][chat_message][is_user]	boolean	*	Is this an user's message? (send from the widget).
data[][parent][messages][][snippet_use_logs][][chat_message][is_html]	boolean	*	Is the content an HTML message?
data[][parent][messages][][snippet_use_logs][][chat_message][metadata]	array	*	Additional data.
data[][parent][messages][][snippet_use_logs][][chat_message][date_created]	DateTime	*	Date message was created.
data[][parent][messages][][snippet_use_logs][][chat_message][date_received]	DateTime	*	Date message was received.
data[][parent][messages][][snippet_use_logs][][language]	object (Language)	*	Snippet translated.
data[][parent][messages][][snippet_use_logs][][person]	object (Person)	*
data[][parent][messages][][snippet_use_logs][][rating]	integer	*
data[][parent][messages][][snippet_use_logs][][rating_person]	object (Person)	*
data[][parent][messages][][snippet_use_logs][][rating_message]	string	*
data[][parent][messages][][snippet_use_logs][][date_created]	DateTime	*
data[][parent][messages][][date_created]	DateTime	*	Date when message was created.
data[][parent][messages][][is_agent_note]	boolean	*	Is this message agent note?
data[][parent][messages][][is_hidden]	boolean	*	Is this message hidden?
data[][parent][messages][][creation_system]	string	*	How this message was created.
data[][parent][messages][][ip_address]	string	*	An ip address from which message was sent.
data[][parent][messages][][visitor_id]	string	*	Unique ID of visitor left this message.
data[][parent][messages][][hostname]	string	*	Host from which message was left.
data[][parent][messages][][geo_country]	string	*	Country message is from (deprecated).
data[][parent][messages][][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data[][parent][messages][][message_hash]	string	*	An unique hash of message.
data[][parent][messages][][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data[][parent][messages][][primary_translation][id]	integer	*
data[][parent][messages][][primary_translation][ticket]	object (Ticket)	*
data[][parent][messages][][primary_translation][ticket_message]	object (TicketMessage)	*
data[][parent][messages][][primary_translation][from_lang_code]	string	*
data[][parent][messages][][primary_translation][lang_code]	string	*
data[][parent][messages][][primary_translation][message]	string	*
data[][parent][messages][][primary_translation][date_created]	DateTime	*
data[][parent][messages][][message]	string	*	The message, will be in HTML!
data[][parent][messages][][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data[][parent][messages][][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data[][parent][messages][][message_source]	string	*	The message source.
data[][parent][messages][][message_source_type]	string	*	The message source type.
data[][parent][messages][][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data[][parent][messages][][lang_code]	string	*	The set/detected lang code.
data[][parent][messages][][email_message_id][]	array of objects (TicketMessageEmailId)	*
data[][parent][messages][][email_message_id][][id]	integer	*
data[][parent][messages][][email_message_id][][message]	object (TicketMessage)	*
data[][parent][messages][][email_message_id][][email_id]	string	*
data[][parent][messages][][ticket_feedback][]	array of objects (TicketFeedback)	*
data[][parent][messages][][ticket_feedback][][id]	integer	*
data[][parent][messages][][ticket_feedback][][ticket]	object (Ticket)	*
data[][parent][messages][][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data[][parent][messages][][ticket_feedback][][person]	object (Person)	*
data[][parent][messages][][ticket_feedback][][rating]	integer	*
data[][parent][messages][][ticket_feedback][][message]	string	*
data[][parent][messages][][ticket_feedback][][date_created]	DateTime	*
data[][parent][messages][][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data[][parent][messages][][ticket_message_forwards][][id]	integer	*
data[][parent][messages][][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data[][parent][messages][][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data[][parent][messages][][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data[][parent][messages][][ticket_message_forwards][][subject]	string	*
data[][parent][messages][][ticket_message_forwards][][from_email]	string	*
data[][parent][messages][][ticket_message_forwards][][tos]	array	*
data[][parent][messages][][ticket_message_forwards][][ccs]	array	*
data[][parent][messages][][ticket_message_forwards][][bccs]	array	*
data[][parent][messages][][ticket_message_forwards][][message]	string	*
data[][parent][messages][][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data[][parent][messages][][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data[][parent][messages][][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][parent][messages][][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][parent][messages][][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][parent][messages][][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][parent][messages][][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data[][parent][messages][][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data[][parent][messages][][ticket_message_forwards][][blobs][][authcode]	string	*
data[][parent][messages][][ticket_message_forwards][][blobs][][blob_hash]	string	*
data[][parent][messages][][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][parent][messages][][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][parent][messages][][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][parent][messages][][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][parent][messages][][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data[][parent][messages][][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data[][parent][messages][][ticket_message_forwards][][blobs][][source_ref]	string	*
data[][parent][messages][][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data[][parent][messages][][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data[][parent][messages][][ticket_message_forwards][][date_created]	DateTime	*
data[][parent][messages][][channel_message]	object (TicketMessageChannelMessage)	*
data[][parent][messages][][channel_message][id]	integer	*	@var int The unique id of message.
data[][parent][messages][][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data[][parent][messages][][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data[][parent][messages][][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data[][parent][messages][][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data[][parent][messages][][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data[][parent][messages][][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data[][parent][messages][][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data[][parent][messages][][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data[][parent][messages][][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data[][parent][sms_messages][]	array of objects (TicketSms)	*
data[][parent][sms_messages][][id]	integer	*
data[][parent][sms_messages][][ticket]	object (Ticket)	*
data[][parent][sms_messages][][person]	object (Person)	*
data[][parent][sms_messages][][sms_account]	object (SmsAccount)	*
data[][parent][sms_messages][][sms_account][id]	integer	*	The unique ID.
data[][parent][sms_messages][][sms_account][type]	string	*
data[][parent][sms_messages][][sms_account][params]	array	*
data[][parent][sms_messages][][sms_account][identifier]	string	*
data[][parent][sms_messages][][sms_account][is_enabled]	boolean	*
data[][parent][sms_messages][][sms_account][is_connected]	boolean	*
data[][parent][sms_messages][][sms_account][is_tested]	boolean	*
data[][parent][sms_messages][][sms_account][test_code]	string	*
data[][parent][sms_messages][][job]	object (Job)	*
data[][parent][sms_messages][][job][id]	integer	*	The unique job id.
data[][parent][sms_messages][][job][type]	string	*	The job type, used by the Job Router to find the right Job Processor.
data[][parent][sms_messages][][job][status]	string	*	The status of the job.
data[][parent][sms_messages][][job][status_code]	string	*	Any code to further classify the status.
data[][parent][sms_messages][][job][date_touch]	DateTime	*	Date the last time a process "touched" this ticket.
data[][parent][sms_messages][][job][date_created]	DateTime	*	Date this job entered the "jobs" table.
data[][parent][sms_messages][][job][date_last_try]	DateTime	*	Last time we processed this job.
data[][parent][sms_messages][][job][date_next_try]	DateTime	*	If this DateTime is in the future, it won't be selected for execution.
data[][parent][sms_messages][][job][num_tries]	integer	*	The number of times this job has been executed Job Processor (usually indicated failures if > 1).
data[][parent][sms_messages][][job][log_summary]	string	*	A human readable summary of the job's execution.
data[][parent][sms_messages][][job][log]	string	*	A more verbose log.
data[][parent][sms_messages][][job][data]	array	*	An array of data, or payload, that the job processor needs to execute this job (stored in the db as json). This MUST always be an array, even if its an empty array
data[][parent][sms_messages][][job][original_job]	integer	*	Null unless the job was created as a retry - if so, the originating job ID is stored here so we can query it later. Note: You MUST specify the originating job, do not create a linked list of failed jobs.
data[][parent][sms_messages][][date_created]	DateTime	*
data[][parent][sms_messages][][from_number]	string	*	Permanent record of the phone number that sent this SMS. (Won't change even if Person changes their phone number).
data[][parent][sms_messages][][to_number]	string	*	Permanent record of the phone number that this SMS was sent to.
data[][parent][sms_messages][][message]	string	*	The SMS message.
data[][parent][sms_messages][][direction]	string	*	Just a system flag for reporting.
data[][parent][topic_links][]	array of objects (TicketCommunityTopicLink)	*
data[][parent][topic_links][][id]	integer	*	The unique filter ID.
data[][parent][topic_links][][ticket]	integer id (Ticket)	*
data[][parent][topic_links][][topic]	integer id (CommunityTopic)	*
data[][parent][topic_links][][person]	integer id (Person)	*
data[][parent][topic_links][][date_created]	DateTime	*
data[][parent][custom_data][]	array of objects (CustomDataTicket)	*
data[][parent][custom_data][][ticket]	object (Ticket)	*
data[][parent][custom_data][][field]	object (CustomDefTicket)	*
data[][parent][custom_data][][field][parent]	object (CustomDefTicket)	*
data[][parent][custom_data][][field][children][]	array of objects (CustomDefTicket)	*	Field children.
data[][parent][custom_data][][root_field]	object (CustomDefTicket)	*
data[][parent][labels][]	array of objects (LabelTicket)	*
data[][parent][labels][][ticket]	object (Ticket)	*
data[][parent][sent_to_address]	string	*	The email address the ticket was sent to if it came in via a gateway. This is a full string (e.g., including CC's) of the original.
data[][parent][email_account]	object (EmailAccount)	*	The gateway this ticket originated from.
data[][parent][email_account][id]	integer	*
data[][parent][email_account][account_type]	string	*
data[][parent][email_account][is_enabled]	boolean	*
data[][parent][email_account][address]	string	*
data[][parent][email_account][cert_blob]	object (Blob)	*
data[][parent][email_account][cert_blob][sys_name]	string	*	A unique system name for the blob.
data[][parent][email_account][cert_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][parent][email_account][cert_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][parent][email_account][cert_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][parent][email_account][cert_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][parent][email_account][cert_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][parent][email_account][cert_blob][file_url]	string	*	The HTTP link to download the file.
data[][parent][email_account][cert_blob][authcode]	string	*
data[][parent][email_account][cert_blob][blob_hash]	string	*
data[][parent][email_account][cert_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][parent][email_account][cert_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][parent][email_account][cert_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][parent][email_account][cert_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][parent][email_account][cert_blob][date_created]	DateTime	*
data[][parent][email_account][cert_blob][is_temp]	boolean	*
data[][parent][email_account][cert_blob][source_ref]	string	*
data[][parent][email_account][cert_blob][labels][]	array of objects (LabelBlob)	*
data[][parent][email_account][cert_blob][labels][][blob]	object (Blob)	*
data[][parent][email_account][key_blob]	object (Blob)	*
data[][parent][email_account_address]	string	*	The email address (from list of to/cc) that matched with the email account.
data[][parent][creation_system]	string	*
data[][parent][creation_system_option]	string	*	Optional information about the creation system. For example, source URL the ticket came from.
data[][parent][ticket_hash]	string	*
data[][parent][status]	string	*
data[][parent][ticket_status]	object (TicketStatus)	*
data[][parent][ticket_status][id]	integer	*
data[][parent][ticket_status][status_type]	string	*
data[][parent][ticket_status][status_code]	string	*
data[][parent][ticket_status][sys_id]	string	*
data[][parent][ticket_status][title]	string	*
data[][parent][ticket_status][display_order]	integer	*
data[][parent][ticket_status][pending_waiting_time_mode]	string	*	Where to count time spending in pending status. Check PENDING_WAITING_TIME_MODE_ constants
data[][parent][ticket_status][children][]	array of objects (TicketStatus)	*
data[][parent][ticket_status][options]	array	*
data[][parent][urgency]	integer	*
data[][parent][feedback_rating]	integer	*
data[][parent][date_feedback_rating]	DateTime	*
data[][parent][date_created]	DateTime	*
data[][parent][date_resolved]	DateTime	*
data[][parent][date_archived]	DateTime	*
data[][parent][date_first_agent_assign]	DateTime	*
data[][parent][date_first_agent_reply]	DateTime	*
data[][parent][date_last_agent_reply]	DateTime	*
data[][parent][date_last_user_reply]	DateTime	*
data[][parent][date_agent_waiting]	DateTime	*
data[][parent][date_user_waiting]	DateTime	*
data[][parent][date_status]	DateTime	*
data[][parent][date_on_hold]	DateTime	*
data[][parent][total_user_waiting]	integer	*
data[][parent][total_to_first_reply]	integer	*
data[][parent][total_user_waiting_wh_start]	DateTime	*
data[][parent][total_user_waiting_wh]	integer	*
data[][parent][total_to_first_reply_wh]	integer	*
data[][parent][locked_by_agent]	object (Person)	*
data[][parent][date_locked]	DateTime	*
data[][parent][has_attachments]	boolean	*
data[][parent][subject]	string	*
data[][parent][original_subject]	string	*
data[][parent][properties]	array	*
data[][parent][count_agent_replies]	integer	*
data[][parent][count_user_replies]	integer	*
data[][parent][worst_sla_status]	string	*
data[][parent][waiting_times]	array	*	Used to track ticket status changes and how much time ticket was in status Add new item every time status changed This is optimisation over TicketLog.
data[][parent][participants][]	array of objects (TicketParticipant)	*
data[][parent][participants][][id]	integer	*
data[][parent][participants][][ticket]	object (Ticket)	*
data[][parent][participants][][person]	object (Person)	*
data[][parent][participants][][access_code]	object (TicketAccessCode)	*
data[][parent][participants][][person_email]	object (PersonEmail)	*
data[][parent][participants][][default_on]	boolean	*	Default checkbox status of the user.
data[][parent][charges][]	array of objects (TicketCharge)	*
data[][parent][charges][][id]	integer	*
data[][parent][charges][][charge_time]	integer	*
data[][parent][charges][][amount]	float	*
data[][parent][charges][][date_created]	DateTime	*
data[][parent][charges][][ticket]	object (Ticket)	*
data[][parent][charges][][person]	object (Person)	*
data[][parent][charges][][organization]	object (Organization)	*
data[][parent][charges][][agent]	object (Person)	*
data[][parent][charges][][custom_data][]	array of objects (CustomDataBilling)	*
data[][parent][charges][][custom_data][][ticket_charge]	object (TicketCharge)	*
data[][parent][charges][][custom_data][][field]	object (CustomDefBilling)	*
data[][parent][charges][][custom_data][][field][parent]	object (CustomDefBilling)	*
data[][parent][charges][][custom_data][][field][children][]	array of objects (CustomDefBilling)	*	Field children.
data[][parent][charges][][custom_data][][root_field]	object (CustomDefBilling)	*
data[][parent][ticket_slas][]	array of objects (TicketSla)	*
data[][parent][ticket_slas][][id]	integer	*	The unique ID.
data[][parent][ticket_slas][][sla_status]	string	*	The SLA status.
data[][parent][ticket_slas][][warn_date]	DateTime	*	The SLA warn date.
data[][parent][ticket_slas][][fail_date]	DateTime	*	The SLA fail date.
data[][parent][ticket_slas][][is_completed]	boolean	*	Is the SLA completed?
data[][parent][ticket_slas][][is_completed_set]	boolean	*	Completed by automated action.
data[][parent][ticket_slas][][completed_time_taken]	integer	*	Time taken.
data[][parent][ticket_slas][][ticket]	integer id (Ticket)	*	Ticket.
data[][parent][ticket_slas][][sla]	integer id (Sla)	*	SLA.
data[][parent][ticket_slas][][date_applied]	DateTime	*	time and date when SLA was applied to the ticket.
data[][parent][ticket_slas][][date_completed]	DateTime	*	time when SLA status became OK.
data[][parent][jira_issues][]	array of objects (JiraIssue)	*	linked jira issues.
data[][parent][jira_issues][][id]	integer	*	The unique ID.
data[][parent][jira_issues][][ticket]	object (Ticket)	*	The associated DeskPRO ticket.
data[][parent][jira_issues][][issue_id]	integer	*
data[][parent][jira_issues][][status_id]	integer	*
data[][parent][jira_issues][][created]	DateTime	*	Export time.
data[][parent][problems][]	array of objects (Problem)	*
data[][parent][problems][][id]	integer	*	The unique ID.
data[][parent][problems][][title]	string	*	Problem title.
data[][parent][problems][][creator]	integer id (Person)	*	Person who created the problem.
data[][parent][problems][][created]	DateTime	*	Date when the problem was created.
data[][parent][problems][][is_open]	boolean	*	Is problem still has no solution?
data[][parent][problems][][tickets][]	array of integer ids (Ticket)	*	Tickets associated with problem.
data[][parent][stars][]	array of objects (TicketFlagged)	*
data[][parent][stars][][ticket]	object (Ticket)	*
data[][parent][stars][][person_id]	integer	*
data[][parent][stars][][color]	string	*
data[][parent][follow_ups][]	array of objects (TicketFollowUp)	*
data[][parent][follow_ups][][id]	integer	*	The unique ID.
data[][parent][follow_ups][][person]	integer id (Person)	*
data[][parent][follow_ups][][actions]	array	*
data[][parent][follow_ups][][cancel_if_user_reply]	boolean	*
data[][parent][follow_ups][][cancel_if_agent_reply]	boolean	*
data[][parent][follow_ups][][status]	string	*
data[][parent][follow_ups][][date_created]	DateTime	*
data[][parent][follow_ups][][date_to_run]	DateTime	*
data[][parent][follow_ups][][date_did_run]	DateTime	*
data[][parent][logs][]	array of objects (TicketLog)	*
data[][parent][logs][][id]	integer	*
data[][parent][logs][][parent]	object (TicketLog)	*
data[][parent][logs][][ticket]	object (Ticket)	*
data[][parent][logs][][person]	object (Person)	*
data[][parent][logs][][action_type]	string	*
data[][parent][logs][][id_object]	integer	*	If the log involves a specific thing in a ticket (eg a message that was moved), then that is this id.
data[][parent][logs][][id_before]	integer	*	The ID of the previous entity changed, or any other numeric value.
data[][parent][logs][][id_after]	integer	*	The ID of the new entity, or any other numeric value.
data[][parent][logs][][trigger_id]	integer	*	If the change was caused by a trigger, the trigger id. Note this is the integer ID (not a FK relation) so the record is kept even if the trigger itself is deleted.
data[][parent][logs][][escalation_id]	integer	*	If the change was caused by an escalation Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data[][parent][logs][][macro_id]	integer	*	If the change was caused by an v2 macro Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data[][parent][logs][][sla]	object (Sla)	*	If the change was caused by an SLA, the SLA.
data[][parent][logs][][sla][id]	integer	*	The unique ID.
data[][parent][logs][][sla][title]	string	*	SLA title.
data[][parent][logs][][sla][sla_type]	string	*	Type of SLA - first_response, resolution, waiting_time.
data[][parent][logs][][sla][active_time]	string	*	Whether active all the time (all) or during work hours only (work_hours) or use the default ticket-wide settings (default).
data[][parent][logs][][sla][work_start]	integer	*	When the work day starts. This is stored as the number of seconds after 00:00:00.
data[][parent][logs][][sla][work_end]	integer	*	When the work day ends. This is stored as the number of seconds after 00:00:00.
data[][parent][logs][][sla][work_days]	array	*	Array of work days, stored with keys corresponding to day numbers. Values are true. 0 = Sunday, 6 = Saturday (same as PHP, easy to convert to MySQL which is 1 = Sunday, 7 = Saturday).
data[][parent][logs][][sla][work_timezone]	string	*	Timezone for work hours/days to be considered in.
data[][parent][logs][][sla][work_holidays]	array	*	List of work holidays.
data[][parent][logs][][sla][apply_type]	string	*	Controls how the SLA is applied to tickets: all, terms, terms_before_triggers, manual.
data[][parent][logs][][sla][apply_terms]	object (TriggerTerms)	*	Conditions to apply.
data[][parent][logs][][sla][apply_terms][version]	integer	*	Terms version.
data[][parent][logs][][sla][apply_terms][terms]	array	*	Terms themselves.
data[][parent][logs][][sla][trigger_terms]	object (TriggerTerms)	*	Conditions to consider sla completed.
data[][parent][logs][][sla][warn_time]	integer	*	Warn time integer.
data[][parent][logs][][sla][warn_time_unit]	string	*	And it's unit (see warn time).
data[][parent][logs][][sla][warn_actions]	object (TriggerActions)	*	How to warn about SLA will fail.
data[][parent][logs][][sla][warn_actions][version]	integer	*	Actions version.
data[][parent][logs][][sla][warn_actions][actions]	array	*	Actions array representation.
data[][parent][logs][][sla][fail_time]	integer	*	Fail time integer.
data[][parent][logs][][sla][fail_time_unit]	string	*	And it's measuring unit (see fail_time).
data[][parent][logs][][sla][fail_actions]	object (TriggerActions)	*	What to do if SLA failed.
data[][parent][logs][][sla][exclude_ticket_statuses]	array	*	This SLA will not apply while tickets are in these pending statuses.
data[][parent][logs][][sla_status]	string	*
data[][parent][logs][][details]	array	*
data[][parent][logs][][date_created]	DateTime	*
data[][parent][chats][]	array of objects (ChatConversation)	*
data[][parent][created_with_channel]	string	*
data[][parent][last_channel_used]	string	*
data[][parent][channels]	array	*
data[][parent][pending_articles][]	array of objects (ArticlePendingCreate)	*
data[][parent][pending_articles][][id]	integer	*
data[][parent][pending_articles][][person]	integer id (Person)	*
data[][parent][pending_articles][][assigned_person]	integer id (Person)	*
data[][parent][pending_articles][][ticket]	integer id (Ticket)	*
data[][parent][pending_articles][][message]	integer id (TicketMessage)	*
data[][parent][pending_articles][][comment]	string	*
data[][parent][pending_articles][][date_created]	DateTime	*
data[][parent][summary]	object (TicketSummary)	*
data[][parent][summary][id]	integer	*
data[][parent][summary][ticket]	object (Ticket)	*
data[][parent][summary][summary]	string	*
data[][parent][summary][summary_input]	string	*
data[][parent][summary][date_created]	DateTime	*
data[][siblings][]	array of objects (Ticket)	*	Ticket array.
data[][children][]	array of objects (Ticket)	*	Ticket array.

Status Code	Description
200	Returned in case of successful request
404	Ticket with specified id wasn't found

POST /api/v2/tickets/{ticket}/links

link two tickets

Applicable api modes

session token key oauth

Api tags for this endpoint

tickets.ticket_links.post

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
ticket		Ticket

Parameter	Type	Required?	Format	Description
link_ticket	choice	true
parent	boolean	true		Set true if you want to make link ticket as parent for ticket

Parameter	Type	Versions	Description
data.parent	object (Ticket)	*	Parent ticket.
data.parent[id]	integer	*
data.parent[ref]	string	*
data.parent[auth]	string	*
data.parent[parent_ticket]	object (Ticket)	*	Parent ticket.
data.parent[children_tickets][]	array of objects (Ticket)	*
data.parent[language]	object (Language)	*	The language the ticket is in.
data.parent[language][id]	integer	*	The unique ID.
data.parent[language][sys_name]	string	*	The unique sys name assigned to the language.
data.parent[language][title]	string	*	Title of the language.
data.parent[language][title_local]	string	*	Title of the language.
data.parent[language][base_filepath]	string	*	The base filepath for default phrases for this lang.
data.parent[language][locale]	string	*	The locale code.
data.parent[language][flag_image]	string	*	String path to image.
data.parent[language][is_rtl]	boolean	*	True if this is a right-to-left language.
data.parent[language][has_user]	boolean	*	True if has user.
data.parent[language][has_agent]	boolean	*	True if has agent.
data.parent[language][has_admin]	boolean	*	True if has admin.
data.parent[language][plural_categories][]	array of strings	*
data.parent[language][plural_formula]	string	*	A formula using "n" being an integer. This formula should be compatible with most C-based languages that support ternary operators. Booleans should be cast to an integer (i.e. true = 1, false = 0). Given an integer n, this formular returns the plural form to use for that number. The plural form can be used as the index to find the category name.
data.parent[language][flag_urn]	string	*	Used in new admin to set custom flag icon in the format: `urn:deskpro:flag:$countryCode`
data.parent[brand]	object (Brand)	*
data.parent[brand][id]	integer	*	The unique ID.
data.parent[brand][name]	string	*	The brand name.
data.parent[brand][slug]	string	*
data.parent[brand][url]	string	*	The brand url.
data.parent[brand][theme_set]	object (ThemeSet)	*
data.parent[brand][theme_set][id]	integer	*
data.parent[brand][theme_set][theme_id]	string	*
data.parent[brand][theme_set][title]	string	*
data.parent[brand][theme_set][options]		*
data.parent[brand][edit_theme_set]	object (ThemeSet)	*
data.parent[brand][departments][]	array of objects (Department)	*
data.parent[brand][departments][][id]	integer	*
data.parent[brand][departments][][parent]	object (Department)	*
data.parent[brand][departments][][children][]	array of objects (Department)	*
data.parent[brand][departments][][title]	string	*
data.parent[brand][departments][][user_title]	string	*
data.parent[brand][departments][][is_tickets_enabled]	boolean	*
data.parent[brand][departments][][is_chat_enabled]	boolean	*
data.parent[brand][departments][][display_order]	integer	*
data.parent[brand][departments][][avatar]	object (Blob)	*
data.parent[brand][departments][][avatar][sys_name]	string	*	A unique system name for the blob.
data.parent[brand][departments][][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.parent[brand][departments][][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.parent[brand][departments][][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.parent[brand][departments][][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.parent[brand][departments][][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.parent[brand][departments][][avatar][file_url]	string	*	The HTTP link to download the file.
data.parent[brand][departments][][avatar][authcode]	string	*
data.parent[brand][departments][][avatar][blob_hash]	string	*
data.parent[brand][departments][][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.parent[brand][departments][][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.parent[brand][departments][][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.parent[brand][departments][][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.parent[brand][departments][][avatar][date_created]	DateTime	*
data.parent[brand][departments][][avatar][is_temp]	boolean	*
data.parent[brand][departments][][avatar][source_ref]	string	*
data.parent[brand][departments][][avatar][labels][]	array of objects (LabelBlob)	*
data.parent[brand][departments][][avatar][labels][][blob]	object (Blob)	*
data.parent[brand][departments][][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.parent[brand][departments][][brands][]	array of objects (Brand)	*
data.parent[brand][departments][][permissions][]	array of objects (DepartmentPermission)	*
data.parent[brand][departments][][permissions][][department]	integer id (Department)	*
data.parent[brand][departments][][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.parent[brand][departments][][permissions][][name]	string	*	The name of the permission.
data.parent[brand][departments][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.parent[brand][departments][][permissions][][is_active]	boolean	*
data.parent[brand][departments][][chat_queue]	object (UserChatQueue)	*
data.parent[brand][departments][][chat_queue][id]	integer	*	The unique ID.
data.parent[brand][departments][][chat_queue][name]	string	*
data.parent[brand][departments][][chat_queue][routing_model]	string	*
data.parent[brand][departments][][chat_queue][answer_timeout]	integer	*
data.parent[brand][departments][][chat_queue][is_all_agents]	boolean	*
data.parent[brand][departments][][chat_queue][departments][]	array of objects (Department)	*
data.parent[brand][departments][][chat_queue][max_queue_size]	integer	*
data.parent[brand][departments][][chat_queue][routingModel]		*
data.parent[brand][theme_sets][]	array of objects (ThemeSet)	*
data.parent[department]	object (Department)	*
data.parent[department][id]	integer	*
data.parent[department][parent]	object (Department)	*
data.parent[department][children][]	array of objects (Department)	*
data.parent[department][title]	string	*
data.parent[department][user_title]	string	*
data.parent[department][is_tickets_enabled]	boolean	*
data.parent[department][is_chat_enabled]	boolean	*
data.parent[department][display_order]	integer	*
data.parent[department][avatar]	object (Blob)	*
data.parent[department][avatar][sys_name]	string	*	A unique system name for the blob.
data.parent[department][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.parent[department][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.parent[department][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.parent[department][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.parent[department][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.parent[department][avatar][file_url]	string	*	The HTTP link to download the file.
data.parent[department][avatar][authcode]	string	*
data.parent[department][avatar][blob_hash]	string	*
data.parent[department][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.parent[department][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.parent[department][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.parent[department][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.parent[department][avatar][date_created]	DateTime	*
data.parent[department][avatar][is_temp]	boolean	*
data.parent[department][avatar][source_ref]	string	*
data.parent[department][avatar][labels][]	array of objects (LabelBlob)	*
data.parent[department][avatar][labels][][blob]	object (Blob)	*
data.parent[department][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.parent[department][brands][]	array of objects (Brand)	*
data.parent[department][permissions][]	array of objects (DepartmentPermission)	*
data.parent[department][permissions][][department]	integer id (Department)	*
data.parent[department][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.parent[department][permissions][][name]	string	*	The name of the permission.
data.parent[department][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.parent[department][permissions][][is_active]	boolean	*
data.parent[department][chat_queue]	object (UserChatQueue)	*
data.parent[department][chat_queue][id]	integer	*	The unique ID.
data.parent[department][chat_queue][name]	string	*
data.parent[department][chat_queue][routing_model]	string	*
data.parent[department][chat_queue][answer_timeout]	integer	*
data.parent[department][chat_queue][is_all_agents]	boolean	*
data.parent[department][chat_queue][departments][]	array of objects (Department)	*
data.parent[department][chat_queue][max_queue_size]	integer	*
data.parent[category]	object (TicketCategory)	*
data.parent[category][id]	integer	*	The unique ID.
data.parent[category][parent]	integer id (TicketCategory)	*	This category parent.
data.parent[category][title]	string	*	Category title.
data.parent[category][display_order]	integer	*	Obviously it's display order for lists.
data.parent[priority]	object (TicketPriority)	*
data.parent[priority][id]	integer	*	The unique ID.
data.parent[priority][title]	string	*	Priority title.
data.parent[priority][priority]	integer	*	The priority itself.
data.parent[workflow]	object (TicketWorkflow)	*
data.parent[workflow][id]	integer	*	The unique ID.
data.parent[workflow][title]	string	*	Workflow title.
data.parent[workflow][display_order]	integer	*	Workflow display order.
data.parent[product]	object (Product)	*
data.parent[product][parent]	integer id (Product)	*	Parent of the product.
data.parent[product][title]		*
data.parent[person]	object (Person)	*
data.parent[person_email]	object (PersonEmail)	*
data.parent[person_email][id]	integer	*	The unique ID.
data.parent[person_email][person]	integer id (Person)	*	Person owner of email.
data.parent[person_email][email]	string	*	The email address.
data.parent[person_email][email_domain]	string	*	The email address domain.
data.parent[person_email][is_validated]	boolean	*	True if validation passed.
data.parent[person_email][date_created]	DateTime	*	The original time the email was created.
data.parent[agent]	object (Person)	*
data.parent[agent_team]	object (AgentTeam)	*
data.parent[agent_team][id]	integer	*	The unique ID.
data.parent[agent_team][name]	string	*	The name of agent team.
data.parent[agent_team][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.parent[agent_team][members]		*
data.parent[organization]	object (Organization)	*
data.parent[organization][id]	integer	*	The unique ID.
data.parent[organization][picture_blob]	object (Blob)	*	The org picture.
data.parent[organization][picture_blob][sys_name]	string	*	A unique system name for the blob.
data.parent[organization][picture_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.parent[organization][picture_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.parent[organization][picture_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.parent[organization][picture_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.parent[organization][picture_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.parent[organization][picture_blob][file_url]	string	*	The HTTP link to download the file.
data.parent[organization][picture_blob][authcode]	string	*
data.parent[organization][picture_blob][blob_hash]	string	*
data.parent[organization][picture_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.parent[organization][picture_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.parent[organization][picture_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.parent[organization][picture_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.parent[organization][picture_blob][date_created]	DateTime	*
data.parent[organization][picture_blob][is_temp]	boolean	*
data.parent[organization][picture_blob][source_ref]	string	*
data.parent[organization][picture_blob][labels][]	array of objects (LabelBlob)	*
data.parent[organization][picture_blob][labels][][blob]	object (Blob)	*
data.parent[organization][icon_property]	object (IconProperty)	*
data.parent[organization][icon_property][urn]	string	*
data.parent[organization][icon_property][options]	array	*
data.parent[organization][name]	string	*	The organization name.
data.parent[organization][summary]	string	*	The summary field as filled in by agents.
data.parent[organization][importance]	integer	*	The org importance.
data.parent[organization][custom_data][]	array of objects (CustomDataOrganization)	*
data.parent[organization][custom_data][][organization]	object (Organization)	*
data.parent[organization][custom_data][][field]	object (CustomDefOrganization)	*
data.parent[organization][custom_data][][field][parent]	object (CustomDefOrganization)	*	Field`s parent.
data.parent[organization][custom_data][][field][children][]	array of objects (CustomDefOrganization)	*	Field children.
data.parent[organization][custom_data][][field][title]		*
data.parent[organization][custom_data][][root_field]	object (CustomDefOrganization)	*
data.parent[organization][usergroups][]	array of objects (Usergroup)	*	Usergroups the user belongs to.
data.parent[organization][usergroups][][id]	integer	*	The unique ID, DB-generated.
data.parent[organization][usergroups][][title]	string	*	Title of the usergroup.
data.parent[organization][usergroups][][note]	string	*	A note or description about the usergroup.
data.parent[organization][usergroups][][is_agent_group]	boolean	*	Is this an agent group?
data.parent[organization][usergroups][][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.parent[organization][usergroups][][is_enabled]	boolean	*	Is the group enabled?
data.parent[organization][usergroups][][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data.parent[organization][usergroups][][permissions][][id]	integer	*	The unique ID.
data.parent[organization][usergroups][][permissions][][name]	string	*	The name of the permission.
data.parent[organization][usergroups][][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.parent[organization][usergroups][][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.parent[organization][usergroups][][department_permissions][]	array of objects (DepartmentPermission)	*
data.parent[organization][usergroups][][department_permissions][][department]	integer id (Department)	*
data.parent[organization][usergroups][][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.parent[organization][usergroups][][department_permissions][][name]	string	*	The name of the permission.
data.parent[organization][usergroups][][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.parent[organization][usergroups][][department_permissions][][is_active]	boolean	*
data.parent[organization][usergroups][][people][]	array of objects (Person)	*	Usergroup members.
data.parent[organization][auto_cc_people][]	array of objects (Person)	*	Users who are set to automatically be added to tickets and other org things.
data.parent[organization][labels][]	array of objects (LabelOrganization)	*
data.parent[organization][labels][][organization]	object (Organization)	*
data.parent[organization][contact_data][]	array of objects (OrganizationContactData)	*
data.parent[organization][contact_data][][organization]		*
data.parent[organization][contact_data][][contact_type]		*
data.parent[organization][contact_data][][comment]		*
data.parent[organization][contact_data][][field_1]		*
data.parent[organization][contact_data][][field_2]		*
data.parent[organization][contact_data][][field_3]		*
data.parent[organization][contact_data][][field_5]		*
data.parent[organization][contact_data][][field_9]		*
data.parent[organization][emails][]	array of objects (OrganizationEmail)	*
data.parent[organization][emails][][id]	integer	*	The unique log id.
data.parent[organization][emails][][organization]	object (Organization)	*
data.parent[organization][emails][][email]	string	*
data.parent[organization][emails][][date_created]	DateTime	*
data.parent[organization][email_domains][]	array of objects (OrganizationEmailDomain)	*
data.parent[organization][email_domains][][domain]	string	*	The email domain.
data.parent[organization][email_domains][][organization]	object (Organization)	*	The users organization.
data.parent[organization][date_created]	DateTime	*	The date the org was inserted into the system.
data.parent[organization][members][]	array of objects (Person)	*
data.parent[organization][parent]	object (Organization)	*
data.parent[organization][children][]	array of objects (Organization)	*
data.parent[organization][tickets][]	array of objects (Ticket)	*
data.parent[organization][organization_members][]	array of objects (OrganizationMember)	*
data.parent[organization][organization_members][][id]	integer	*
data.parent[organization][organization_members][][person]	integer id (Person)	*
data.parent[organization][organization_members][][organization]	integer id (Organization)	*
data.parent[organization][organization_members][][is_manager]	boolean	*
data.parent[organization][organization_members][][position]	string	*
data.parent[organization][organization_members][][created_at]	DateTime	*
data.parent[organization][organization_members][][updated_at]	DateTime	*
data.parent[organization][publicUsergroups]		*
data.parent[linked_chat]	object (ChatConversation)	*
data.parent[linked_chat][id]	integer	*	The unique id of chat conversation.
data.parent[linked_chat][department]	object (Department)	*	Department which chat was assigned.
data.parent[linked_chat][brand]	object (Brand)	*	Department which chat was assigned.
data.parent[linked_chat][task_id]	integer	*
data.parent[linked_chat][ticket]	object (Ticket)	*
data.parent[linked_chat][labels][]	array of objects (LabelChatConversation)	*
data.parent[linked_chat][labels][][chat]	object (ChatConversation)	*
data.parent[linked_chat][subject]	string	*	Subject of the chat conversation.
data.parent[linked_chat][status]	string	*	Status of the chat conversation.
data.parent[linked_chat][agent]	object (Person)	*	If this is a user conversation, this is the agent assigned.
data.parent[linked_chat][agent_team]	object (AgentTeam)	*	If this is a team chat, the team it is.
data.parent[linked_chat][person]	object (Person)	*	If this is a user conversation, this is the user who started the chat.
data.parent[linked_chat][session]	object (Session)	*	If this is a user convo, this is the users session.
data.parent[linked_chat][session][id]	integer	*	The unique ID.
data.parent[linked_chat][session][auth]	string	*	The authcode for the session to verify an id.
data.parent[linked_chat][session][interface]	string	*	The Interface the session is for.
data.parent[linked_chat][session][person]	object (Person)	*
data.parent[linked_chat][session][user_agent]	string	*	The users user agent string.
data.parent[linked_chat][session][visitor_id]	string	*
data.parent[linked_chat][session][ip_address]	string	*	The users IP address.
data.parent[linked_chat][session][data]	string	*
data.parent[linked_chat][session][is_person]	boolean	*
data.parent[linked_chat][session][is_bot]	boolean	*
data.parent[linked_chat][session][is_helpdesk]	boolean	*
data.parent[linked_chat][session][active_status]	string	*	(Agents) Status (available or away).
data.parent[linked_chat][session][is_chat_available]	boolean	*	(Agents) Wehn status is available, if they are available for chat.
data.parent[linked_chat][session][date_created]	DateTime	*
data.parent[linked_chat][session][date_last]	DateTime	*
data.parent[linked_chat][session][date_last_page]	DateTime	*
data.parent[linked_chat][visitor_id]	string	*
data.parent[linked_chat][person_name]	string	*	User chat: The users name, if they arent a person.
data.parent[linked_chat][person_email]	string	*	User chat: The users email, if they aren`t a person.
data.parent[linked_chat][participants][]	array of objects (Person)	*
data.parent[linked_chat][messages][]	array of objects (ChatMessage)	*
data.parent[linked_chat][messages][][id]	integer	*	The unique ID.
data.parent[linked_chat][messages][][author_id]	integer	*	Author id (legacy).
data.parent[linked_chat][messages][][author_type]	string	*	Author type (legacy).
data.parent[linked_chat][messages][][conversation_id]	integer	*	Conversation id (legacy).
data.parent[linked_chat][messages][][author]	integer id (Person)	*	Person who created the message.
data.parent[linked_chat][messages][][content]	string	*	The message.
data.parent[linked_chat][messages][][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.parent[linked_chat][messages][][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.parent[linked_chat][messages][][is_html]	boolean	*	Is the content an HTML message?
data.parent[linked_chat][messages][][metadata]	array	*	Additional data.
data.parent[linked_chat][messages][][date_created]	DateTime	*	Date message was created.
data.parent[linked_chat][messages][][date_received]	DateTime	*	Date message was received.
data.parent[linked_chat][custom_data][]	array of objects (CustomDataChat)	*
data.parent[linked_chat][custom_data][][conversation]	object (ChatConversation)	*	The conversation the message belongs to.
data.parent[linked_chat][custom_data][][field]	object (CustomDefChat)	*
data.parent[linked_chat][custom_data][][field][parent]	object (CustomDefChat)	*
data.parent[linked_chat][custom_data][][field][children][]	array of objects (CustomDefChat)	*	Field children.
data.parent[linked_chat][custom_data][][field][title]		*
data.parent[linked_chat][custom_data][][root_field]	object (CustomDefChat)	*
data.parent[linked_chat][rating_response_time]	integer	*
data.parent[linked_chat][rating_overall]	integer	*
data.parent[linked_chat][rating_comment]	string	*
data.parent[linked_chat][is_agent]	boolean	*	Is this an agent chat.
data.parent[linked_chat][is_window]	boolean	*	If the chat is popped out into a window. This is used to make sure the JS widget on pages doesn't load again.
data.parent[linked_chat][date_created]	DateTime	*	Date when chat was started.
data.parent[linked_chat][date_user_waiting]	DateTime	*	Since when the user has started waiting (i.e., time the assignment was 0).
data.parent[linked_chat][date_assigned]	DateTime	*
data.parent[linked_chat][date_agent_typing]	DateTime	*	Date when agent typed last time.
data.parent[linked_chat][date_first_agent_message]	DateTime	*
data.parent[linked_chat][date_ended]	DateTime	*	Date when chat was ended.
data.parent[linked_chat][total_to_ended]	integer	*
data.parent[linked_chat][ended_by]	string	*	Who ended the chat.
data.parent[linked_chat][should_send_transcript]	boolean	*	True if transcript should be send.
data.parent[linked_chat][date_transcript_sent]	DateTime	*	Date when transcript was sent.
data.parent[linked_chat][email_validation_code]	string	*
data.parent[linked_chat][email_validated]	boolean	*
data.parent[linked_chat][access_token]	string	*
data.parent[attachments][]	array of objects (TicketAttachment)	*
data.parent[attachments][][id]	integer	*	The unique ID.
data.parent[attachments][][ticket]	integer id (Ticket)	*	Ticket this attachment belongs to.
data.parent[attachments][][person]	integer id (Person)	*	Who created the attachment.
data.parent[attachments][][blob]	object (Blob)	*	Actual attachment.
data.parent[attachments][][blob][sys_name]	string	*	A unique system name for the blob.
data.parent[attachments][][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.parent[attachments][][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.parent[attachments][][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.parent[attachments][][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.parent[attachments][][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.parent[attachments][][blob][file_url]	string	*	The HTTP link to download the file.
data.parent[attachments][][blob][authcode]	string	*
data.parent[attachments][][blob][blob_hash]	string	*
data.parent[attachments][][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.parent[attachments][][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.parent[attachments][][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.parent[attachments][][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.parent[attachments][][blob][date_created]	DateTime	*
data.parent[attachments][][blob][is_temp]	boolean	*
data.parent[attachments][][blob][source_ref]	string	*
data.parent[attachments][][blob][labels][]	array of objects (LabelBlob)	*
data.parent[attachments][][blob][labels][][blob]	object (Blob)	*
data.parent[attachments][][message]	integer id (TicketMessage)	*	Message - holder of this attachment.
data.parent[attachments][][is_agent_note]	boolean	*	True if this attachmen just a note.
data.parent[attachments][][is_inline]	boolean	*	Is this attachment is embed in message.
data.parent[access_codes][]	array of objects (TicketAccessCode)	*
data.parent[access_codes][][id]	integer	*
data.parent[access_codes][][ticket]	object (Ticket)	*
data.parent[access_codes][][person]	object (Person)	*
data.parent[access_codes][][auth]	string	*
data.parent[messages][]	array of objects (TicketMessage)	*
data.parent[messages][][id]	integer	*	The unique id of message.
data.parent[messages][][ticket]	object (Ticket)	*	Ticket with which this message is associated.
data.parent[messages][][person]	object (Person)	*	Person this message was sent by.
data.parent[messages][][email_source]	object (EmailSource)	*	Info about email source, if message comes from such source.
data.parent[messages][][email_source][id]	integer	*
data.parent[messages][][email_source][uuid]	string	*
data.parent[messages][][email_source][blob]	object (Blob)	*
data.parent[messages][][email_source][blob][sys_name]	string	*	A unique system name for the blob.
data.parent[messages][][email_source][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.parent[messages][][email_source][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.parent[messages][][email_source][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.parent[messages][][email_source][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.parent[messages][][email_source][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.parent[messages][][email_source][blob][file_url]	string	*	The HTTP link to download the file.
data.parent[messages][][email_source][blob][authcode]	string	*
data.parent[messages][][email_source][blob][blob_hash]	string	*
data.parent[messages][][email_source][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.parent[messages][][email_source][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.parent[messages][][email_source][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.parent[messages][][email_source][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.parent[messages][][email_source][blob][date_created]	DateTime	*
data.parent[messages][][email_source][blob][is_temp]	boolean	*
data.parent[messages][][email_source][blob][source_ref]	string	*
data.parent[messages][][email_source][blob][labels][]	array of objects (LabelBlob)	*
data.parent[messages][][email_source][blob][labels][][blob]	object (Blob)	*
data.parent[messages][][email_source][object_type]	string	*	The type of object this is attached to (should be the table name of the super type, eg: tickets, people, organizations). This typically is not set until after the email is processed (ie the status is 'processed').
data.parent[messages][][email_source][object_id]	integer	*	The ID of the object this is attached to.
data.parent[messages][][email_source][from_email]	string	*
data.parent[messages][][email_source][status]	string	*	The current status of the message: - inserted: Only inserted - processing: Currently processing - complete: Fully processed - error: Tried to process but there was some kind of error (see error_code).
data.parent[messages][][email_source][date_status]	DateTime	*
data.parent[messages][][email_source][error_code]	string	*	When status is error, this is the code that describes the error.
data.parent[messages][][email_source][date_created]	DateTime	*
data.parent[messages][][attachments][]	array of objects (TicketAttachment)	*	Items attached to the ticket.
data.parent[messages][][snippet_use_logs][]	array of objects (SnippetV2UseLog)	*	Snippets used in this message.
data.parent[messages][][snippet_use_logs][][id]	integer	*	The unique ID.
data.parent[messages][][snippet_use_logs][][snippet]	object (SnippetV2)	*	Snippet used.
data.parent[messages][][snippet_use_logs][][snippet][id]	integer	*
data.parent[messages][][snippet_use_logs][][snippet][title]	string	*
data.parent[messages][][snippet_use_logs][][snippet][author]	object (Person)	*
data.parent[messages][][snippet_use_logs][][snippet][is_private]	boolean	*
data.parent[messages][][snippet_use_logs][][snippet][avatar]	object (Blob)	*
data.parent[messages][][snippet_use_logs][][snippet][avatar][sys_name]	string	*	A unique system name for the blob.
data.parent[messages][][snippet_use_logs][][snippet][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.parent[messages][][snippet_use_logs][][snippet][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.parent[messages][][snippet_use_logs][][snippet][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.parent[messages][][snippet_use_logs][][snippet][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.parent[messages][][snippet_use_logs][][snippet][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.parent[messages][][snippet_use_logs][][snippet][avatar][file_url]	string	*	The HTTP link to download the file.
data.parent[messages][][snippet_use_logs][][snippet][avatar][authcode]	string	*
data.parent[messages][][snippet_use_logs][][snippet][avatar][blob_hash]	string	*
data.parent[messages][][snippet_use_logs][][snippet][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.parent[messages][][snippet_use_logs][][snippet][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.parent[messages][][snippet_use_logs][][snippet][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.parent[messages][][snippet_use_logs][][snippet][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.parent[messages][][snippet_use_logs][][snippet][avatar][date_created]	DateTime	*
data.parent[messages][][snippet_use_logs][][snippet][avatar][is_temp]	boolean	*
data.parent[messages][][snippet_use_logs][][snippet][avatar][source_ref]	string	*
data.parent[messages][][snippet_use_logs][][snippet][avatar][labels][]	array of objects (LabelBlob)	*
data.parent[messages][][snippet_use_logs][][snippet][avatar][labels][][blob]	object (Blob)	*
data.parent[messages][][snippet_use_logs][][snippet][status]	string	*
data.parent[messages][][snippet_use_logs][][snippet][shortcut_codes]	array	*
data.parent[messages][][snippet_use_logs][][snippet][inline_translations]	array	*
data.parent[messages][][snippet_use_logs][][snippet][translations][]	array of objects (SnippetV2Translation)	*
data.parent[messages][][snippet_use_logs][][snippet][translations][][id]	integer	*	The unique ID.
data.parent[messages][][snippet_use_logs][][snippet][translations][][snippet]	object (SnippetV2)	*	Snippet translated.
data.parent[messages][][snippet_use_logs][][snippet][translations][][language]	object (Language)	*
data.parent[messages][][snippet_use_logs][][snippet][translations][][content]	array	*	Snippet content.
data.parent[messages][][snippet_use_logs][][snippet][translations][][blobs][]	array of objects (Blob)	*
data.parent[messages][][snippet_use_logs][][snippet][categories][]	array of objects (SnippetV2Category)	*
data.parent[messages][][snippet_use_logs][][snippet][categories][][id]	integer	*
data.parent[messages][][snippet_use_logs][][snippet][categories][][title]	string	*
data.parent[messages][][snippet_use_logs][][snippet][categories][][is_global]	boolean	*
data.parent[messages][][snippet_use_logs][][snippet][categories][][display_order]	integer	*
data.parent[messages][][snippet_use_logs][][snippet][categories][][parent]	object (SnippetV2Category)	*
data.parent[messages][][snippet_use_logs][][snippet][categories][][agent_teams][]	array of objects (AgentTeam)	*
data.parent[messages][][snippet_use_logs][][snippet][display_order]	integer	*
data.parent[messages][][snippet_use_logs][][snippet][date_created]	DateTime	*
data.parent[messages][][snippet_use_logs][][ticket_message]	object (TicketMessage)	*	Ticket Message where the snippet was used.
data.parent[messages][][snippet_use_logs][][chat_message]	object (ChatMessage)	*	Chat Message where the snippet was used.
data.parent[messages][][snippet_use_logs][][chat_message][id]	integer	*	The unique ID.
data.parent[messages][][snippet_use_logs][][chat_message][author_id]	integer	*	Author id (legacy).
data.parent[messages][][snippet_use_logs][][chat_message][author_type]	string	*	Author type (legacy).
data.parent[messages][][snippet_use_logs][][chat_message][conversation_id]	integer	*	Conversation id (legacy).
data.parent[messages][][snippet_use_logs][][chat_message][author]	integer id (Person)	*	Person who created the message.
data.parent[messages][][snippet_use_logs][][chat_message][content]	string	*	The message.
data.parent[messages][][snippet_use_logs][][chat_message][is_sys]	boolean	*	Is this a system message? (ended, joined, etc).
data.parent[messages][][snippet_use_logs][][chat_message][is_user]	boolean	*	Is this an user's message? (send from the widget).
data.parent[messages][][snippet_use_logs][][chat_message][is_html]	boolean	*	Is the content an HTML message?
data.parent[messages][][snippet_use_logs][][chat_message][metadata]	array	*	Additional data.
data.parent[messages][][snippet_use_logs][][chat_message][date_created]	DateTime	*	Date message was created.
data.parent[messages][][snippet_use_logs][][chat_message][date_received]	DateTime	*	Date message was received.
data.parent[messages][][snippet_use_logs][][language]	object (Language)	*	Snippet translated.
data.parent[messages][][snippet_use_logs][][person]	object (Person)	*
data.parent[messages][][snippet_use_logs][][rating]	integer	*
data.parent[messages][][snippet_use_logs][][rating_person]	object (Person)	*
data.parent[messages][][snippet_use_logs][][rating_message]	string	*
data.parent[messages][][snippet_use_logs][][date_created]	DateTime	*
data.parent[messages][][date_created]	DateTime	*	Date when message was created.
data.parent[messages][][is_agent_note]	boolean	*	Is this message agent note?
data.parent[messages][][is_hidden]	boolean	*	Is this message hidden?
data.parent[messages][][creation_system]	string	*	How this message was created.
data.parent[messages][][ip_address]	string	*	An ip address from which message was sent.
data.parent[messages][][visitor_id]	string	*	Unique ID of visitor left this message.
data.parent[messages][][hostname]	string	*	Host from which message was left.
data.parent[messages][][geo_country]	string	*	Country message is from (deprecated).
data.parent[messages][][email]	string	*	The email address the user sent the email from (gateway messages only). This is a perm record and doesnt change even if the user changes/deletes their email address.
data.parent[messages][][message_hash]	string	*	An unique hash of message.
data.parent[messages][][primary_translation]	object (TicketMessageTranslated)	*	The primary translation is the one sent to the user.
data.parent[messages][][primary_translation][id]	integer	*
data.parent[messages][][primary_translation][ticket]	object (Ticket)	*
data.parent[messages][][primary_translation][ticket_message]	object (TicketMessage)	*
data.parent[messages][][primary_translation][from_lang_code]	string	*
data.parent[messages][][primary_translation][lang_code]	string	*
data.parent[messages][][primary_translation][message]	string	*
data.parent[messages][][primary_translation][date_created]	DateTime	*
data.parent[messages][][message]	string	*	The message, will be in HTML!
data.parent[messages][][message_full]	string	*	This is the full message, including all quotes/cut content. This will still be the HTMLPurifier'ed content (so it's safe), it's just the message before it's been run through the cutter.
data.parent[messages][][message_raw]	string	*	This is the full raw message content. It has not been passed through any HTML cleaning process.s.
data.parent[messages][][message_source]	string	*	The message source.
data.parent[messages][][message_source_type]	string	*	The message source type.
data.parent[messages][][show_full_hint]	boolean	*	A hint to say if we should show message_full by default. We do this when we detect that the user has replied to a message inline rather than above the cut line.
data.parent[messages][][lang_code]	string	*	The set/detected lang code.
data.parent[messages][][email_message_id][]	array of objects (TicketMessageEmailId)	*
data.parent[messages][][email_message_id][][id]	integer	*
data.parent[messages][][email_message_id][][message]	object (TicketMessage)	*
data.parent[messages][][email_message_id][][email_id]	string	*
data.parent[messages][][ticket_feedback][]	array of objects (TicketFeedback)	*
data.parent[messages][][ticket_feedback][][id]	integer	*
data.parent[messages][][ticket_feedback][][ticket]	object (Ticket)	*
data.parent[messages][][ticket_feedback][][ticket_message]	object (TicketMessage)	*
data.parent[messages][][ticket_feedback][][person]	object (Person)	*
data.parent[messages][][ticket_feedback][][rating]	integer	*
data.parent[messages][][ticket_feedback][][message]	string	*
data.parent[messages][][ticket_feedback][][date_created]	DateTime	*
data.parent[messages][][ticket_message_forwards][]	array of objects (TicketMessageForward)	*
data.parent[messages][][ticket_message_forwards][][id]	integer	*
data.parent[messages][][ticket_message_forwards][][ticket_message]	object (TicketMessage)	*
data.parent[messages][][ticket_message_forwards][][new_ticket]	object (Ticket)	*
data.parent[messages][][ticket_message_forwards][][new_ticket_message]	object (TicketMessage)	*
data.parent[messages][][ticket_message_forwards][][subject]	string	*
data.parent[messages][][ticket_message_forwards][][from_email]	string	*
data.parent[messages][][ticket_message_forwards][][tos]	array	*
data.parent[messages][][ticket_message_forwards][][ccs]	array	*
data.parent[messages][][ticket_message_forwards][][bccs]	array	*
data.parent[messages][][ticket_message_forwards][][message]	string	*
data.parent[messages][][ticket_message_forwards][][blobs][]	array of objects (Blob)	*
data.parent[messages][][ticket_message_forwards][][blobs][][sys_name]	string	*	A unique system name for the blob.
data.parent[messages][][ticket_message_forwards][][blobs][][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.parent[messages][][ticket_message_forwards][][blobs][][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.parent[messages][][ticket_message_forwards][][blobs][][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.parent[messages][][ticket_message_forwards][][blobs][][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.parent[messages][][ticket_message_forwards][][blobs][][save_path]	string	*	The path to the file if it's not stored in the database.
data.parent[messages][][ticket_message_forwards][][blobs][][file_url]	string	*	The HTTP link to download the file.
data.parent[messages][][ticket_message_forwards][][blobs][][authcode]	string	*
data.parent[messages][][ticket_message_forwards][][blobs][][blob_hash]	string	*
data.parent[messages][][ticket_message_forwards][][blobs][][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.parent[messages][][ticket_message_forwards][][blobs][][title]	string	*	The title of this file used in interfaces if its a media upload.
data.parent[messages][][ticket_message_forwards][][blobs][][dim_w]	integer	*	If this type of file has dimentions, the width.
data.parent[messages][][ticket_message_forwards][][blobs][][dim_h]	integer	*	If this type of file has dimentions, the height.
data.parent[messages][][ticket_message_forwards][][blobs][][date_created]	DateTime	*
data.parent[messages][][ticket_message_forwards][][blobs][][is_temp]	boolean	*
data.parent[messages][][ticket_message_forwards][][blobs][][source_ref]	string	*
data.parent[messages][][ticket_message_forwards][][blobs][][labels][]	array of objects (LabelBlob)	*
data.parent[messages][][ticket_message_forwards][][blobs][][labels][][blob]	object (Blob)	*
data.parent[messages][][ticket_message_forwards][][date_created]	DateTime	*
data.parent[messages][][channel_message]	object (TicketMessageChannelMessage)	*
data.parent[messages][][channel_message][id]	integer	*	@var int The unique id of message.
data.parent[messages][][channel_message][ticket_message]	object (TicketMessage)	*	@var TicketMessageEntity TicketMessage with which this message is associated.
data.parent[messages][][channel_message][provider]	string	*	@var string name of the provider from the ticket-channel service
data.parent[messages][][channel_message][platform_id]	string	*	@var string ID of the platform from the ticket-channel service
data.parent[messages][][channel_message][channel_id]	string	*	@var string ID of the channel from the ticket-channel service
data.parent[messages][][channel_message][message_id]	string	*	@var string ID of the message from the ticket-channel service
data.parent[messages][][channel_message][message_root_id]	string	*	@var string ID of the root message from the ticket-channel service
data.parent[messages][][channel_message][channel_type]	string	*	@var string name of the channel type from the ticket-channel service
data.parent[messages][][channel_message][message_type]	string	*	@var string name of the message type from the ticket-channel service
data.parent[messages][][channel_message][created_at]	DateTime	*	@var \DateTime Date when channel message was created.
data.parent[sms_messages][]	array of objects (TicketSms)	*
data.parent[sms_messages][][id]	integer	*
data.parent[sms_messages][][ticket]	object (Ticket)	*
data.parent[sms_messages][][person]	object (Person)	*
data.parent[sms_messages][][sms_account]	object (SmsAccount)	*
data.parent[sms_messages][][sms_account][id]	integer	*	The unique ID.
data.parent[sms_messages][][sms_account][type]	string	*
data.parent[sms_messages][][sms_account][params]	array	*
data.parent[sms_messages][][sms_account][identifier]	string	*
data.parent[sms_messages][][sms_account][is_enabled]	boolean	*
data.parent[sms_messages][][sms_account][is_connected]	boolean	*
data.parent[sms_messages][][sms_account][is_tested]	boolean	*
data.parent[sms_messages][][sms_account][test_code]	string	*
data.parent[sms_messages][][job]	object (Job)	*
data.parent[sms_messages][][job][id]	integer	*	The unique job id.
data.parent[sms_messages][][job][type]	string	*	The job type, used by the Job Router to find the right Job Processor.
data.parent[sms_messages][][job][status]	string	*	The status of the job.
data.parent[sms_messages][][job][status_code]	string	*	Any code to further classify the status.
data.parent[sms_messages][][job][date_touch]	DateTime	*	Date the last time a process "touched" this ticket.
data.parent[sms_messages][][job][date_created]	DateTime	*	Date this job entered the "jobs" table.
data.parent[sms_messages][][job][date_last_try]	DateTime	*	Last time we processed this job.
data.parent[sms_messages][][job][date_next_try]	DateTime	*	If this DateTime is in the future, it won't be selected for execution.
data.parent[sms_messages][][job][num_tries]	integer	*	The number of times this job has been executed Job Processor (usually indicated failures if > 1).
data.parent[sms_messages][][job][log_summary]	string	*	A human readable summary of the job's execution.
data.parent[sms_messages][][job][log]	string	*	A more verbose log.
data.parent[sms_messages][][job][data]	array	*	An array of data, or payload, that the job processor needs to execute this job (stored in the db as json). This MUST always be an array, even if its an empty array
data.parent[sms_messages][][job][original_job]	integer	*	Null unless the job was created as a retry - if so, the originating job ID is stored here so we can query it later. Note: You MUST specify the originating job, do not create a linked list of failed jobs.
data.parent[sms_messages][][date_created]	DateTime	*
data.parent[sms_messages][][from_number]	string	*	Permanent record of the phone number that sent this SMS. (Won't change even if Person changes their phone number).
data.parent[sms_messages][][to_number]	string	*	Permanent record of the phone number that this SMS was sent to.
data.parent[sms_messages][][message]	string	*	The SMS message.
data.parent[sms_messages][][direction]	string	*	Just a system flag for reporting.
data.parent[topic_links][]	array of objects (TicketCommunityTopicLink)	*
data.parent[topic_links][][id]	integer	*	The unique filter ID.
data.parent[topic_links][][ticket]	integer id (Ticket)	*
data.parent[topic_links][][topic]	integer id (CommunityTopic)	*
data.parent[topic_links][][person]	integer id (Person)	*
data.parent[topic_links][][date_created]	DateTime	*
data.parent[custom_data][]	array of objects (CustomDataTicket)	*
data.parent[custom_data][][ticket]	object (Ticket)	*
data.parent[custom_data][][field]	object (CustomDefTicket)	*
data.parent[custom_data][][field][parent]	object (CustomDefTicket)	*
data.parent[custom_data][][field][children][]	array of objects (CustomDefTicket)	*	Field children.
data.parent[custom_data][][field][title]		*
data.parent[custom_data][][root_field]	object (CustomDefTicket)	*
data.parent[labels][]	array of objects (LabelTicket)	*
data.parent[labels][][ticket]	object (Ticket)	*
data.parent[sent_to_address]	string	*	The email address the ticket was sent to if it came in via a gateway. This is a full string (e.g., including CC's) of the original.
data.parent[email_account]	object (EmailAccount)	*	The gateway this ticket originated from.
data.parent[email_account][id]	integer	*
data.parent[email_account][account_type]	string	*
data.parent[email_account][is_enabled]	boolean	*
data.parent[email_account][address]	string	*
data.parent[email_account][cert_blob]	object (Blob)	*
data.parent[email_account][cert_blob][sys_name]	string	*	A unique system name for the blob.
data.parent[email_account][cert_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.parent[email_account][cert_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.parent[email_account][cert_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.parent[email_account][cert_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.parent[email_account][cert_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.parent[email_account][cert_blob][file_url]	string	*	The HTTP link to download the file.
data.parent[email_account][cert_blob][authcode]	string	*
data.parent[email_account][cert_blob][blob_hash]	string	*
data.parent[email_account][cert_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.parent[email_account][cert_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.parent[email_account][cert_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.parent[email_account][cert_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.parent[email_account][cert_blob][date_created]	DateTime	*
data.parent[email_account][cert_blob][is_temp]	boolean	*
data.parent[email_account][cert_blob][source_ref]	string	*
data.parent[email_account][cert_blob][labels][]	array of objects (LabelBlob)	*
data.parent[email_account][cert_blob][labels][][blob]	object (Blob)	*
data.parent[email_account][key_blob]	object (Blob)	*
data.parent[email_account_address]	string	*	The email address (from list of to/cc) that matched with the email account.
data.parent[creation_system]	string	*
data.parent[creation_system_option]	string	*	Optional information about the creation system. For example, source URL the ticket came from.
data.parent[ticket_hash]	string	*
data.parent[status]	string	*
data.parent[ticket_status]	object (TicketStatus)	*
data.parent[ticket_status][id]	integer	*
data.parent[ticket_status][status_type]	string	*
data.parent[ticket_status][status_code]	string	*
data.parent[ticket_status][sys_id]	string	*
data.parent[ticket_status][title]	string	*
data.parent[ticket_status][display_order]	integer	*
data.parent[ticket_status][pending_waiting_time_mode]	string	*	Where to count time spending in pending status. Check PENDING_WAITING_TIME_MODE_ constants
data.parent[ticket_status][children][]	array of objects (TicketStatus)	*
data.parent[ticket_status][options]	array	*
data.parent[ticket_status][statusType]		*
data.parent[ticket_status][displayOrder]	integer	*
data.parent[urgency]	integer	*
data.parent[feedback_rating]	integer	*
data.parent[date_feedback_rating]	DateTime	*
data.parent[date_created]	DateTime	*
data.parent[date_resolved]	DateTime	*
data.parent[date_archived]	DateTime	*
data.parent[date_first_agent_assign]	DateTime	*
data.parent[date_first_agent_reply]	DateTime	*
data.parent[date_last_agent_reply]	DateTime	*
data.parent[date_last_user_reply]	DateTime	*
data.parent[date_agent_waiting]	DateTime	*
data.parent[date_user_waiting]	DateTime	*
data.parent[date_status]	DateTime	*
data.parent[date_on_hold]	DateTime	*
data.parent[total_user_waiting]	integer	*
data.parent[total_to_first_reply]	integer	*
data.parent[total_user_waiting_wh_start]	DateTime	*
data.parent[total_user_waiting_wh]	integer	*
data.parent[total_to_first_reply_wh]	integer	*
data.parent[locked_by_agent]	object (Person)	*
data.parent[date_locked]	DateTime	*
data.parent[has_attachments]	boolean	*
data.parent[subject]	string	*
data.parent[original_subject]	string	*
data.parent[properties]	array	*
data.parent[count_agent_replies]	integer	*
data.parent[count_user_replies]	integer	*
data.parent[worst_sla_status]	string	*
data.parent[waiting_times]	array	*	Used to track ticket status changes and how much time ticket was in status Add new item every time status changed This is optimisation over TicketLog.
data.parent[participants][]	array of objects (TicketParticipant)	*
data.parent[participants][][id]	integer	*
data.parent[participants][][ticket]	object (Ticket)	*
data.parent[participants][][person]	object (Person)	*
data.parent[participants][][access_code]	object (TicketAccessCode)	*
data.parent[participants][][person_email]	object (PersonEmail)	*
data.parent[participants][][default_on]	boolean	*	Default checkbox status of the user.
data.parent[charges][]	array of objects (TicketCharge)	*
data.parent[charges][][id]	integer	*
data.parent[charges][][charge_time]	integer	*
data.parent[charges][][amount]	float	*
data.parent[charges][][date_created]	DateTime	*
data.parent[charges][][ticket]	object (Ticket)	*
data.parent[charges][][person]	object (Person)	*
data.parent[charges][][organization]	object (Organization)	*
data.parent[charges][][agent]	object (Person)	*
data.parent[charges][][custom_data][]	array of objects (CustomDataBilling)	*
data.parent[charges][][custom_data][][ticket_charge]	object (TicketCharge)	*
data.parent[charges][][custom_data][][field]	object (CustomDefBilling)	*
data.parent[charges][][custom_data][][field][parent]	object (CustomDefBilling)	*
data.parent[charges][][custom_data][][field][children][]	array of objects (CustomDefBilling)	*	Field children.
data.parent[charges][][custom_data][][field][title]		*
data.parent[charges][][custom_data][][root_field]	object (CustomDefBilling)	*
data.parent[ticket_slas][]	array of objects (TicketSla)	*
data.parent[ticket_slas][][id]	integer	*	The unique ID.
data.parent[ticket_slas][][sla_status]	string	*	The SLA status.
data.parent[ticket_slas][][warn_date]	DateTime	*	The SLA warn date.
data.parent[ticket_slas][][fail_date]	DateTime	*	The SLA fail date.
data.parent[ticket_slas][][is_completed]	boolean	*	Is the SLA completed?
data.parent[ticket_slas][][is_completed_set]	boolean	*	Completed by automated action.
data.parent[ticket_slas][][completed_time_taken]	integer	*	Time taken.
data.parent[ticket_slas][][ticket]	integer id (Ticket)	*	Ticket.
data.parent[ticket_slas][][sla]	integer id (Sla)	*	SLA.
data.parent[ticket_slas][][date_applied]	DateTime	*	time and date when SLA was applied to the ticket.
data.parent[ticket_slas][][date_completed]	DateTime	*	time when SLA status became OK.
data.parent[jira_issues][]	array of objects (JiraIssue)	*	linked jira issues.
data.parent[jira_issues][][id]	integer	*	The unique ID.
data.parent[jira_issues][][ticket]	object (Ticket)	*	The associated DeskPRO ticket.
data.parent[jira_issues][][issue_id]	integer	*
data.parent[jira_issues][][status_id]	integer	*
data.parent[jira_issues][][created]	DateTime	*	Export time.
data.parent[problems][]	array of objects (Problem)	*
data.parent[problems][][id]	integer	*	The unique ID.
data.parent[problems][][title]	string	*	Problem title.
data.parent[problems][][creator]	integer id (Person)	*	Person who created the problem.
data.parent[problems][][created]	DateTime	*	Date when the problem was created.
data.parent[problems][][is_open]	boolean	*	Is problem still has no solution?
data.parent[problems][][tickets][]	array of integer ids (Ticket)	*	Tickets associated with problem.
data.parent[stars][]	array of objects (TicketFlagged)	*
data.parent[stars][][ticket]	object (Ticket)	*
data.parent[stars][][person_id]	integer	*
data.parent[stars][][color]	string	*
data.parent[follow_ups][]	array of objects (TicketFollowUp)	*
data.parent[follow_ups][][id]	integer	*	The unique ID.
data.parent[follow_ups][][person]	integer id (Person)	*
data.parent[follow_ups][][actions]	array	*
data.parent[follow_ups][][cancel_if_user_reply]	boolean	*
data.parent[follow_ups][][cancel_if_agent_reply]	boolean	*
data.parent[follow_ups][][status]	string	*
data.parent[follow_ups][][date_created]	DateTime	*
data.parent[follow_ups][][date_to_run]	DateTime	*
data.parent[follow_ups][][date_did_run]	DateTime	*
data.parent[follow_ups][][dateToRun]		*
data.parent[logs][]	array of objects (TicketLog)	*
data.parent[logs][][id]	integer	*
data.parent[logs][][parent]	object (TicketLog)	*
data.parent[logs][][ticket]	object (Ticket)	*
data.parent[logs][][person]	object (Person)	*
data.parent[logs][][action_type]	string	*
data.parent[logs][][id_object]	integer	*	If the log involves a specific thing in a ticket (eg a message that was moved), then that is this id.
data.parent[logs][][id_before]	integer	*	The ID of the previous entity changed, or any other numeric value.
data.parent[logs][][id_after]	integer	*	The ID of the new entity, or any other numeric value.
data.parent[logs][][trigger_id]	integer	*	If the change was caused by a trigger, the trigger id. Note this is the integer ID (not a FK relation) so the record is kept even if the trigger itself is deleted.
data.parent[logs][][escalation_id]	integer	*	If the change was caused by an escalation Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.parent[logs][][macro_id]	integer	*	If the change was caused by an v2 macro Note this is the integer ID (not a FK relation) so the record is kept even if the esc itself is deleted.
data.parent[logs][][sla]	object (Sla)	*	If the change was caused by an SLA, the SLA.
data.parent[logs][][sla][id]	integer	*	The unique ID.
data.parent[logs][][sla][title]	string	*	SLA title.
data.parent[logs][][sla][sla_type]	string	*	Type of SLA - first_response, resolution, waiting_time.
data.parent[logs][][sla][active_time]	string	*	Whether active all the time (all) or during work hours only (work_hours) or use the default ticket-wide settings (default).
data.parent[logs][][sla][work_start]	integer	*	When the work day starts. This is stored as the number of seconds after 00:00:00.
data.parent[logs][][sla][work_end]	integer	*	When the work day ends. This is stored as the number of seconds after 00:00:00.
data.parent[logs][][sla][work_days]	array	*	Array of work days, stored with keys corresponding to day numbers. Values are true. 0 = Sunday, 6 = Saturday (same as PHP, easy to convert to MySQL which is 1 = Sunday, 7 = Saturday).
data.parent[logs][][sla][work_timezone]	string	*	Timezone for work hours/days to be considered in.
data.parent[logs][][sla][work_holidays]	array	*	List of work holidays.
data.parent[logs][][sla][apply_type]	string	*	Controls how the SLA is applied to tickets: all, terms, terms_before_triggers, manual.
data.parent[logs][][sla][apply_terms]	object (TriggerTerms)	*	Conditions to apply.
data.parent[logs][][sla][apply_terms][version]	integer	*	Terms version.
data.parent[logs][][sla][apply_terms][terms]	array	*	Terms themselves.
data.parent[logs][][sla][trigger_terms]	object (TriggerTerms)	*	Conditions to consider sla completed.
data.parent[logs][][sla][warn_time]	integer	*	Warn time integer.
data.parent[logs][][sla][warn_time_unit]	string	*	And it's unit (see warn time).
data.parent[logs][][sla][warn_actions]	object (TriggerActions)	*	How to warn about SLA will fail.
data.parent[logs][][sla][warn_actions][version]	integer	*	Actions version.
data.parent[logs][][sla][warn_actions][actions]	array	*	Actions array representation.
data.parent[logs][][sla][fail_time]	integer	*	Fail time integer.
data.parent[logs][][sla][fail_time_unit]	string	*	And it's measuring unit (see fail_time).
data.parent[logs][][sla][fail_actions]	object (TriggerActions)	*	What to do if SLA failed.
data.parent[logs][][sla][exclude_ticket_statuses]	array	*	This SLA will not apply while tickets are in these pending statuses.
data.parent[logs][][sla_status]	string	*
data.parent[logs][][details]	array	*
data.parent[logs][][date_created]	DateTime	*
data.parent[chats][]	array of objects (ChatConversation)	*
data.parent[created_with_channel]	string	*
data.parent[last_channel_used]	string	*
data.parent[channels]	array	*
data.parent[pending_articles][]	array of objects (ArticlePendingCreate)	*
data.parent[pending_articles][][id]	integer	*
data.parent[pending_articles][][person]	integer id (Person)	*
data.parent[pending_articles][][assigned_person]	integer id (Person)	*
data.parent[pending_articles][][ticket]	integer id (Ticket)	*
data.parent[pending_articles][][message]	integer id (TicketMessage)	*
data.parent[pending_articles][][comment]	string	*
data.parent[pending_articles][][date_created]	DateTime	*
data.parent[summary]	object (TicketSummary)	*
data.parent[summary][id]	integer	*
data.parent[summary][ticket]	object (Ticket)	*
data.parent[summary][summary]	string	*
data.parent[summary][summary_input]	string	*
data.parent[summary][date_created]	DateTime	*
data.siblings[]	array of objects (Ticket)	*	Ticket array.
data.children[]	array of objects (Ticket)	*	Ticket array.

Status Code	Description
201	Tickets was linked successfully
400	You are trying to link ticket to itself
404	Ticket with 'ticketId' wasn't found Ticket with 'link_ticket_id' wasn't found

Show/hide List Operations Expand Operations

Timezones

GET /api/v2/timezones

get timezones

Documentation

Retrieve the list of PHP timezones.

Applicable api modes

session token key oauth

Api tags for this endpoint

timezones.list

Response
Status Codes

Parameter	Type	Versions	Description
data[]	array of objects (Timezone)	*
data[][id]	integer	*	Timezone ID.
data[][title]	string	*	Timezone Title.

Status Code	Description
200	Returned if everything is OK

Show/hide List Operations Expand Operations

Topic

POST /api/v2/topics/{topic}/icon

set Icon

Documentation

Set icon for topic.

Applicable api modes

session token key oauth

Api tags for this endpoint

content.topics.set_icon

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
topic	\d+	integer	the id of topic

Parameter	Type	Required?
urn	string	true
style	string	true
color	string	true

Status Code	Description
200	Returned if everything is OK

POST /api/v2/topics/{topic}/splash_image_upload

Create Splash Image For Topic

Applicable api modes

session token key oauth

Api tags for this endpoint

content.topics.upload_splash_image

Requirements
Status Codes

Name	Requirement	Type	Description
topic	\d+	integer	the id of topic

Status Code	Description
200	Returned if everything is OK

Show/hide List Operations Expand Operations

Topics

POST /api/v2/community_topic_comments/{comment}/rate

rate topic comment

Documentation

Rate article.

Applicable api modes

session token key oauth

Api tags for this endpoint

community.community_topic_all_comments.rate_download_content

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
topics	\d+	integer	the id of comment
comment		CommunityTopicComment

Parameter	Type	Required?	Format	Description
upvote	choice	true	[0,1]

Status Code	Description
200	Returned if everything is OK

POST /api/v2/topics/{topic}/splash_image

set Splash Image

Documentation

Set splash image for topic.

Applicable api modes

session token key oauth

Api tags for this endpoint

content.topics.select_splash_image

Requirements
Status Codes

Name	Requirement	Type	Description
forum	\d+	integer	the id of topic
topic

Status Code	Description
200	Returned if everything is OK

Show/hide List Operations Expand Operations

Usergroups

GET /api/v2/user_groups CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

usergroups.user_groups.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (Usergroup)	*
data[][title]	string	*	Title of the usergroup.
data[][id]	integer	*	The unique ID, DB-generated.
data[][note]	string	*	A note or description about the usergroup.
data[][is_agent_group]	boolean	*	Is this an agent group?
data[][sys_name]	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data[][is_enabled]	boolean	*	Is the group enabled?
data[][permissions][]	array of objects (Permission)	*	Usergroup permissions.
data[][permissions][][id]	integer	*	The unique ID.
data[][permissions][][name]	string	*	The name of the permission.
data[][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][permissions][][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data[][department_permissions][]	array of objects (DepartmentPermission)	*
data[][department_permissions][][department]	integer id (Department)	*
data[][department_permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][department_permissions][][name]	string	*	The name of the permission.
data[][department_permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][department_permissions][][is_active]	boolean	*
data[][people][]	array of objects (Person)	*	Usergroup members.

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

GET /api/v2/user_groups/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

usergroups.user_groups.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

GET /api/v2/user_groups/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

usergroups.user_groups.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.title	string	*	Title of the usergroup.
data.id	integer	*	The unique ID, DB-generated.
data.note	string	*	A note or description about the usergroup.
data.is_agent_group	boolean	*	Is this an agent group?
data.sys_name	string	*	When non-null, the group is a special system group (hidden from most interfaces).
data.is_enabled	boolean	*	Is the group enabled?
data.permissions[]	array of objects (Permission)	*	Usergroup permissions.
data.permissions[][id]	integer	*	The unique ID.
data.permissions[][name]	string	*	The name of the permission.
data.permissions[][value]	integer	*	Any numeric number (ex filesize, flag).
data.permissions[][is_active]	boolean	*	True means this permission record is active for normal use with the permission resolver. When a $person permission is used but the $person in question is also part of a usergroup, then this record might be superfluous: If the ug grants the perm, and this record grants the perm, then we have two records that both grant the perm. This isn't harmful usually but if you have many many agents defined and they all have these duplicative perms, then you end up with many thousands of extra rows, which are all fetched and processed with the permission resolver. So we turn these extra perms "off" so the resolver doesn't fetch them. That means if a hd with many agent uses groups instead of overrides, permission resolving is much much faster.
data.department_permissions[]	array of objects (DepartmentPermission)	*
data.department_permissions[][department]	integer id (Department)	*
data.department_permissions[][app]	string	*	Application name. It's going to be either chat or tickets.
data.department_permissions[][name]	string	*	The name of the permission.
data.department_permissions[][value]	integer	*	Any numeric number (ex filesize, flag).
data.department_permissions[][is_active]	boolean	*
data.people[]	array of objects (Person)	*	Usergroup members.
data.people[][emails]		*
data.people[][labels]		*
data.people[][teams]		*
data.people[][primary_team]		*
data.people[][agentData]		*
data.people[][publicUsergroups]		*
data.people[][publicAgentgroups]		*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

Show/hide List Operations Expand Operations

Usersource settings

GET /api/v2/settings/user_source

Get usersource settings

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.usersource_settings.get

Response
Status Codes

Parameter	Type	Versions	Description
data.has_agent_login_form	boolean	*	True if usersource has agent form for login.
data.has_user_login_form	boolean	*	True if usersource has user form for login.
data.reg_enabled	boolean	*	True if registration is enabled for usersource.

Status Code	Description
200	Success

Show/hide List Operations Expand Operations

Usersources

GET /api/v2/user_sources/{context} CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

usersources.usersources.list

Requirements
Filters
Response
Status Codes

Name	Requirement	Type	Description
context	(agent\|user)

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (Usersource)	*
data[][id]	integer	*	The unique ID.
data[][title]	string	*	The title of this usersource.
data[][type]	string	*	"user" or "agent" for now. the interface this usersource applies to
data[][source_type]	string	*
data[][display_type]	string	*
data[][lost_password_url]	string	*
data[][display_order]	integer	*	The order in which to display this source in UserBundle.
data[][display_options]	array	*
data[][is_enabled]	boolean	*	True if this usersource is enabled/usable.
data[][is_all_brands]	boolean	*
data[][brands][]	array of integer ids (Brand)	*	Brands.
data[][is_sso_auto]	boolean	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/user_sources/{context} CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

usersources.usersources.post

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
context	(agent\|user)

Parameter	Type	Required?
title	string	true
is_enabled	boolean	false
options	string	false
is_all_brands	boolean	false
brands[]	array of choices	false

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.title	string	*	The title of this usersource.
data.type	string	*	"user" or "agent" for now. the interface this usersource applies to
data.source_type	string	*
data.display_type	string	*
data.lost_password_url	string	*
data.display_order	integer	*	The order in which to display this source in UserBundle.
data.display_options	array	*
data.is_enabled	boolean	*	True if this usersource is enabled/usable.
data.is_all_brands	boolean	*
data.brands[]	array of integer ids (Brand)	*	Brands.
data.is_sso_auto	boolean	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/user_sources/{context}/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

usersources.usersources.count

Requirements
Response
Status Codes

Name	Requirement	Type	Description
context	(agent\|user)

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/user_sources/{context}/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

usersources.usersources.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource
context	(agent\|user)

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/user_sources/{context}/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

usersources.usersources.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+\|app-\d+	integer	The id of the resource
context	(agent\|user)

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.title	string	*	The title of this usersource.
data.type	string	*	"user" or "agent" for now. the interface this usersource applies to
data.source_type	string	*
data.display_type	string	*
data.lost_password_url	string	*
data.display_order	integer	*	The order in which to display this source in UserBundle.
data.display_options	array	*
data.is_enabled	boolean	*	True if this usersource is enabled/usable.
data.is_all_brands	boolean	*
data.brands[]	array of integer ids (Brand)	*	Brands.
data.is_sso_auto	boolean	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/user_sources/{context}/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

usersources.usersources.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+\|app-\d+	integer	The id of the resource
context	(agent\|user)

Parameter	Type	Required?
title	string	false
is_enabled	boolean	false
options	string	false
is_all_brands	boolean	false
brands[]	array of choices	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

Show/hide List Operations Expand Operations

Voice Channel

POST /api/v2/plivo_callbacks/async_callback

User joins conference callback

POST /api/v2/plivo_callbacks/user_joins_conference_callback

User joins conference callback

POST /api/v2/plivo_callbacks/{account}/{accountAuth}/agent_extension_callback

Triggers when user entered an agent extension number.

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.plivo_callbacks.agent_extension_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth		string

Status Code	Description
200	Returned if everything is ok

POST /api/v2/plivo_callbacks/{account}/{accountAuth}/answer_agent_callback

Triggers when agent starts calling (outgoing call or accepting an incoming call).

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.plivo_callbacks.answer_agent_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth		string

Status Code	Description
200	Returned if everything is ok

POST /api/v2/plivo_callbacks/{account}/{accountAuth}/answer_forwarding_callback

Triggers when agent accept or decline a forwarding call.

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.plivo_callbacks.answered_forwarding_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth		string

Status Code	Description
200	Returned if everything is ok

POST /api/v2/plivo_callbacks/{account}/{accountAuth}/answer_user_callback

Triggers when user starts calling (incoming call).

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.plivo_callbacks.answer_user_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth		string

Status Code	Description
200	Returned if everything is ok

POST /api/v2/plivo_callbacks/{account}/{accountAuth}/auto_attendant_callback/{autoAttendant}

Triggers when user presses a dial code in IVR mode.

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.plivo_callbacks.auto_attendant_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth		string
autoAttendant

Status Code	Description
200	Returned if everything is ok

POST /api/v2/plivo_callbacks/{account}/{accountAuth}/hangup_agent_callback

Triggers when agent ends call.

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.plivo_callbacks.hangup_agent_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth		string

Status Code	Description
200	Returned if everything is ok

POST /api/v2/plivo_callbacks/{account}/{accountAuth}/hangup_user_callback

Triggers when user ends call.

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.plivo_callbacks.hangup_user_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth		string

Status Code	Description
200	Returned if everything is ok

POST /api/v2/plivo_callbacks/{account}/{accountAuth}/outbound_callback

User accepted an incoming call.

Documentation

User answered an incoming call.

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.plivo_callbacks.outgoing_user_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth		string

Status Code	Description
200	Returned if everything is ok

POST /api/v2/plivo_callbacks/{account}/{accountAuth}/put_user_on_hold_callback

Put user on hold

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.plivo_callbacks.put_user_on_hold_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth		string

Status Code	Description
200	Returned if everything is ok

POST /api/v2/plivo_callbacks/{account}/{accountAuth}/voicemail

Voicemail callback

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.plivo_callbacks.voicemail

Requirements
Filters
Status Codes

Name	Requirement	Type	Description
account
accountAuth		string

Name

Information

asset

Pattern	\d
Description	voice asset id
Datatype	integer

Status Code	Description
200	Returned if everything is ok

POST /api/v2/plivo_callbacks/{account}/{accountAuth}/voicemail_end

Voicemail end callback

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.plivo_callbacks.voicemail_end

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth		string

Status Code	Description
200	Returned if everything is ok

POST /api/v2/plivo_callbacks/{account}/{accountAuth}/voicemail_recording_status_callback

Recording status callback for voicemail

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.plivo_callbacks.voicemail_recording_status_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth		string

Status Code	Description
200	Returned if everything is ok

POST /api/v2/plivo_callbacks/{account}/{accountAuth}/{phoneCall}/call_routing

Recursively triggers to match incoming phone call to a worker

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.plivo_callbacks.call_routing

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth		string
phoneCall

Status Code	Description
200	Returned if everything is ok

POST /api/v2/plivo_callbacks/{account}/{accountAuth}/{phoneCall}/conference_status_callback

Conference status callback, triggers when a participant joins or leaves call, accepts call recording.

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.plivo_callbacks.conference_status_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth		string
phoneCall

Status Code	Description
200	Returned if everything is ok

POST /api/v2/twilio_callbacks/{account}/{accountAuth}/agent_extension_callback

Agent extension callback

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_callbacks.agent_extension_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth

Status Code	Description
200	Returned if everything is ok

POST /api/v2/twilio_callbacks/{account}/{accountAuth}/auto_attendant_callback/{autoAttendant}

Auto attendant callback

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_callbacks.auto_attendant_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth
autoAttendant

Status Code	Description
200	Returned if everything is ok

GET /api/v2/twilio_callbacks/{account}/{accountAuth}/hold_music

Custom hold music

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_callbacks.hold_music

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth

Status Code	Description
200	Returned if everything is ok

POST /api/v2/twilio_callbacks/{account}/{accountAuth}/hold_music

Custom hold music

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_callbacks.hold_music

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth

Status Code	Description
200	Returned if everything is ok

POST /api/v2/twilio_callbacks/{account}/{accountAuth}/hold_silent_callback

Put user on hold

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_callbacks.hold_silent_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth

Status Code	Description
200	Returned if everything is ok

POST /api/v2/twilio_callbacks/{account}/{accountAuth}/outbound_callback/{phoneCall}

Outgoing callback

Documentation

Agent is calling, user answered the call.

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_callbacks.outgoing_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth
phoneCall

Status Code	Description
200	Returned if everything is ok

GET /api/v2/twilio_callbacks/{account}/{accountAuth}/phone_number_callback

Handle incoming phone call

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_callbacks.phone_number_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth

Status Code	Description
200	Returned if everything is ok

POST /api/v2/twilio_callbacks/{account}/{accountAuth}/phone_number_status_callback

Handle incoming phone call changed status

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_callbacks.phone_number_status_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth

Status Code	Description
200	Returned if everything is ok

POST /api/v2/twilio_callbacks/{account}/{accountAuth}/transcribe_callback

Transcribe action, accepts phone call transcription

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_callbacks.transcribe

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth

Status Code	Description
200	Returned if everything is ok

POST /api/v2/twilio_callbacks/{account}/{accountAuth}/transcribe_voicemail

Transcribe voicemail

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_callbacks.transcribe_voicemail

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth

Status Code	Description
200	Returned if everything is ok

POST /api/v2/twilio_callbacks/{account}/{accountAuth}/transfer_to_external_number_callback

Cold transfer to external number callback

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_callbacks.answered_transfer_to_external_number_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth

Status Code	Description
200	Returned if everything is ok

POST /api/v2/twilio_callbacks/{account}/{accountAuth}/voicemail

Voicemail callback

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_callbacks.voicemail

Requirements
Filters
Status Codes

Name	Requirement	Type	Description
account
accountAuth

Name

Information

asset

Pattern	\d
Description	voice asset id
Datatype	integer

Status Code	Description
200	Returned if everything is ok

POST /api/v2/twilio_callbacks/{account}/{accountAuth}/voicemail_disabled

Voicemail disabled callback

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_callbacks.voicemail_disabled

Requirements
Filters
Status Codes

Name	Requirement	Type	Description
account
accountAuth

Name

Information

asset

Pattern	\d
Description	voice asset id
Datatype	integer

Status Code	Description
200	Returned if everything is ok

POST /api/v2/twilio_callbacks/{account}/{accountAuth}/voicemail_end

Voicemail end callback

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_callbacks.voicemail_end

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth

Status Code	Description
200	Returned if everything is ok

POST /api/v2/twilio_callbacks/{account}/{accountAuth}/voicemail_record

Voicemail record callback

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_callbacks.voicemail_record

Requirements
Filters
Status Codes

Name	Requirement	Type	Description
account
accountAuth

Name

Information

asset

Pattern	\d
Description	voice asset id
Datatype	integer

Status Code	Description
200	Returned if everything is ok

POST /api/v2/twilio_callbacks/{account}/{accountAuth}/voicemail_recording_status_callback

Recording status callback

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_callbacks.voicemail_recording_status_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth

Status Code	Description
200	Returned if everything is ok

POST /api/v2/twilio_callbacks/{account}/{accountAuth}/{phoneCall}/call_routing

Plays ringing musing

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_callbacks.call_routing_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth
phoneCall

Status Code	Description
200	Returned if everything is ok

POST /api/v2/twilio_callbacks/{account}/{accountAuth}/{phoneCall}/conference_status_callback

Conference status callback

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_callbacks.conference_status_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth
phoneCall

Status Code	Description
200	Returned if everything is ok

POST /api/v2/twilio_callbacks/{account}/{accountAuth}/{phoneCall}/hold_music_callback

Put user on hold

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_callbacks.hold_music_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth
phoneCall

Status Code	Description
200	Returned if everything is ok

POST /api/v2/twilio_callbacks/{account}/{accountAuth}/{phoneCall}/join_conference

Force join conference

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_callbacks.join_conference_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth
phoneCall

Status Code	Description
200	Returned if everything is ok

POST /api/v2/twilio_callbacks/{account}/{accountAuth}/{phoneCall}/new_incoming_call/{targetType}/{targetId}

Creates a task for task router

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_callbacks.new_incoming_call_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth
phoneCall
targetType
targetId

Status Code	Description
200	Returned if everything is ok

POST /api/v2/twilio_callbacks/{account}/{accountAuth}/{phoneCall}/on_dial_hangup_callback

Transform direct call into a conference

Documentation

Transfer phone call into a conference or hangup. This actions is triggered when user or agent ends the direct call.

It may happen in two cases: if the call is ended or it's warm add/transfer.

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_callbacks.on_dial_hangup_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth
phoneCall

Status Code	Description
200	Returned if everything is ok

POST /api/v2/twilio_callbacks/{account}/{accountAuth}/{phoneCall}/put_on_hold_callback

Put user on hold if it's a direct call

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_callbacks.put_on_hold_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth
phoneCall

Status Code	Description
200	Returned if everything is ok

POST /api/v2/twilio_callbacks/{account}/{accountAuth}/{phoneCall}/recording_status_callback

Recording status callback

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_callbacks.recording_status_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth
phoneCall

Status Code	Description
200	Returned if everything is ok

POST /api/v2/twilio_callbacks/{account}/{accountAuth}/{phoneCall}/unhold_direct_call_callback

Unhold user if it's a direct call

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_callbacks.unhold_direct_call_callback

Requirements
Status Codes

Name	Requirement	Type	Description
account
accountAuth
phoneCall

Status Code	Description
200	Returned if everything is ok

GET /api/v2/voice_accounts CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_accounts.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (AbstractVoiceAccount)	*
data[][accountId]		*
data[][authToken]		*
data[][accountName]		*
data[][id]	integer	*	The unique ID.
data[][account_id]	string	*
data[][auth_token]	string	*
data[][account_name]	string	*
data[][account_auth]	string	*
data[][date_created]	DateTime	*
data[][numbers][]	array of objects (VoiceNumber)	*
data[][numbers][][id]	integer	*	The unique ID.
data[][numbers][][sid]	string	*
data[][numbers][][number]	string	*
data[][numbers][][nickname]	string	*
data[][numbers][][outbound_calls_enabled]	boolean	*
data[][numbers][][outbound_calls_default]	boolean	*
data[][numbers][][outbound_calls_default_type]	string	*
data[][numbers][][outbound_calls_default_countries]	array	*
data[][numbers][][is_voice_enabled]	boolean	*
data[][numbers][][is_sms_enabled]	boolean	*
data[][numbers][][is_sms_supported]	boolean	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

GET /api/v2/voice_accounts/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_accounts.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

GET /api/v2/voice_accounts/plivo CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.plivo_accounts.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (PlivoVoiceAccount)	*
data[][accountId]		*
data[][authToken]		*
data[][accountName]		*
data[][id]	integer	*	The unique ID.
data[][account_id]	string	*
data[][auth_token]	string	*
data[][account_name]	string	*
data[][account_auth]	string	*
data[][date_created]	DateTime	*
data[][numbers][]	array of objects (VoiceNumber)	*
data[][numbers][][id]	integer	*	The unique ID.
data[][numbers][][sid]	string	*
data[][numbers][][number]	string	*
data[][numbers][][nickname]	string	*
data[][numbers][][outbound_calls_enabled]	boolean	*
data[][numbers][][outbound_calls_default]	boolean	*
data[][numbers][][outbound_calls_default_type]	string	*
data[][numbers][][outbound_calls_default_countries]	array	*
data[][numbers][][is_voice_enabled]	boolean	*
data[][numbers][][is_sms_enabled]	boolean	*
data[][numbers][][is_sms_supported]	boolean	*
data[][user_application_id]	string	*
data[][agent_application_id]	string	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/voice_accounts/plivo CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.plivo_accounts.post

Parameters
Response
Status Codes

Parameter	Type	Required?
account_name	string	true
account_id	string	true
auth_token	string	true

Parameter	Type	Versions	Description
data.accountId		*
data.authToken		*
data.accountName		*
data.id	integer	*	The unique ID.
data.account_id	string	*
data.auth_token	string	*
data.account_name	string	*
data.account_auth	string	*
data.date_created	DateTime	*
data.numbers[]	array of objects (VoiceNumber)	*
data.numbers[][id]	integer	*	The unique ID.
data.numbers[][sid]	string	*
data.numbers[][number]	string	*
data.numbers[][nickname]	string	*
data.numbers[][outbound_calls_enabled]	boolean	*
data.numbers[][outbound_calls_default]	boolean	*
data.numbers[][outbound_calls_default_type]	string	*
data.numbers[][outbound_calls_default_countries]	array	*
data.numbers[][is_voice_enabled]	boolean	*
data.numbers[][is_sms_enabled]	boolean	*
data.numbers[][is_sms_supported]	boolean	*
data.numbers[][account]		*
data.numbers[][target]		*
data.numbers[][outboundCallsDefaultType]		*
data.user_application_id	string	*
data.agent_application_id	string	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/voice_accounts/plivo/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.plivo_accounts.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

POST /api/v2/voice_accounts/plivo/test_credentials

Check if account credentials are correct

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.plivo_accounts.test_credentials

Parameters
Status Codes

Parameter	Type	Required?
account_name	string	true
account_id	string	true
auth_token	string	true

Status Code	Description
200	Returned if everything is ok

GET /api/v2/voice_accounts/plivo/{account}/available_numbers

Returns a list of available numbers to buy

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.plivo_accounts.get_available_numbers

Requirements
Response
Status Codes

Name	Requirement	Type	Description
account		PlivoVoiceAccount

Parameter	Type	Versions
data[]	array of objects (TwilioAvailableNumber)	*
data[][number_country_code]	string	*
data[][national_number]	string	*
data[][number]	string	*
data[][country_code]	string	*
data[][sms_enabled]	boolean	*
data[][voice_enabled]	boolean	*
data[][is_sms_supported]	boolean	*
data[][added]	boolean	*
data[][account]	integer id (VoiceAccount)	*
data[][nickname]	string	*
data[][address_requirements]	string	*
data[][region]	string	*
data[][rate_center]	string	*
data[][type]	string	*
data[][price]	string	*
data[][price_unit]	string	*

Status Code	Description
200	Returned if everything is ok

POST /api/v2/voice_accounts/plivo/{account}/buy_number

Buy number

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.plivo_accounts.buy_number

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
account		PlivoVoiceAccount

Parameter	Type	Required?	Format	Description
number	string	true
address	string	true

Parameter	Type	Versions	Description
data.account		*
data.sid	string	*
data.number	string	*
data.target		*
data.outboundCallsDefaultType		*
data.id	integer	*	The unique ID.
data.nickname	string	*
data.outbound_calls_enabled	boolean	*
data.outbound_calls_default	boolean	*
data.outbound_calls_default_type	string	*
data.outbound_calls_default_countries	array	*
data.is_voice_enabled	boolean	*
data.is_sms_enabled	boolean	*
data.is_sms_supported	boolean	*

Status Code	Description
200	Returned if everything is ok

GET /api/v2/voice_accounts/plivo/{account}/existing_numbers

Returns a list of existing (bought) numbers

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.plivo_accounts.get_existing_numbers

Requirements
Filters
Status Codes

Name	Requirement	Type	Description
account		PlivoVoiceAccount

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

Status Code	Description
200	Returned if everything is ok

POST /api/v2/voice_accounts/plivo/{account}/refresh_endpoint

Regenerate a plivo endpoint for agent

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.plivo_accounts.refresh_endpoint

Requirements
Status Codes

Name	Requirement	Type	Description
account		PlivoVoiceAccount

Status Code	Description
200	Returned if everything is ok

DELETE /api/v2/voice_accounts/plivo/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.plivo_accounts.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/voice_accounts/plivo/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.plivo_accounts.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.accountId		*
data.authToken		*
data.accountName		*
data.id	integer	*	The unique ID.
data.account_id	string	*
data.auth_token	string	*
data.account_name	string	*
data.account_auth	string	*
data.date_created	DateTime	*
data.numbers[]	array of objects (VoiceNumber)	*
data.numbers[][id]	integer	*	The unique ID.
data.numbers[][sid]	string	*
data.numbers[][number]	string	*
data.numbers[][nickname]	string	*
data.numbers[][outbound_calls_enabled]	boolean	*
data.numbers[][outbound_calls_default]	boolean	*
data.numbers[][outbound_calls_default_type]	string	*
data.numbers[][outbound_calls_default_countries]	array	*
data.numbers[][is_voice_enabled]	boolean	*
data.numbers[][is_sms_enabled]	boolean	*
data.numbers[][is_sms_supported]	boolean	*
data.numbers[][account]		*
data.numbers[][target]		*
data.numbers[][outboundCallsDefaultType]		*
data.user_application_id	string	*
data.agent_application_id	string	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/voice_accounts/plivo/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.plivo_accounts.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?
account_name	string	false
account_id	string	false
auth_token	string	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/voice_accounts/twilio CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_accounts.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (TwilioVoiceAccount)	*
data[][accountId]		*
data[][authToken]		*
data[][accountName]		*
data[][id]	integer	*	The unique ID.
data[][account_id]	string	*
data[][auth_token]	string	*
data[][account_name]	string	*
data[][account_auth]	string	*
data[][date_created]	DateTime	*
data[][numbers][]	array of objects (VoiceNumber)	*
data[][numbers][][id]	integer	*	The unique ID.
data[][numbers][][sid]	string	*
data[][numbers][][number]	string	*
data[][numbers][][nickname]	string	*
data[][numbers][][outbound_calls_enabled]	boolean	*
data[][numbers][][outbound_calls_default]	boolean	*
data[][numbers][][outbound_calls_default_type]	string	*
data[][numbers][][outbound_calls_default_countries]	array	*
data[][numbers][][is_voice_enabled]	boolean	*
data[][numbers][][is_sms_enabled]	boolean	*
data[][numbers][][is_sms_supported]	boolean	*
data[][twiml_app_sid]	string	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/voice_accounts/twilio CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_accounts.post

Parameters
Response
Status Codes

Parameter	Type	Required?
account_name	string	true
account_id	string	true
auth_token	string	true

Parameter	Type	Versions	Description
data.accountId		*
data.authToken		*
data.accountName		*
data.id	integer	*	The unique ID.
data.account_id	string	*
data.auth_token	string	*
data.account_name	string	*
data.account_auth	string	*
data.date_created	DateTime	*
data.numbers[]	array of objects (VoiceNumber)	*
data.numbers[][id]	integer	*	The unique ID.
data.numbers[][sid]	string	*
data.numbers[][number]	string	*
data.numbers[][nickname]	string	*
data.numbers[][outbound_calls_enabled]	boolean	*
data.numbers[][outbound_calls_default]	boolean	*
data.numbers[][outbound_calls_default_type]	string	*
data.numbers[][outbound_calls_default_countries]	array	*
data.numbers[][is_voice_enabled]	boolean	*
data.numbers[][is_sms_enabled]	boolean	*
data.numbers[][is_sms_supported]	boolean	*
data.numbers[][account]		*
data.numbers[][target]		*
data.numbers[][outboundCallsDefaultType]		*
data.twiml_app_sid	string	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/voice_accounts/twilio/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_accounts.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

POST /api/v2/voice_accounts/twilio/test_credentials

Check if account credentials are correct

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_accounts.test_credentials

Parameters
Status Codes

Parameter	Type	Required?
account_name	string	true
account_id	string	true
auth_token	string	true

Status Code	Description
200	Returned if everything is ok

GET /api/v2/voice_accounts/twilio/{account}/addresses

Get a list of existing voice addresses

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_accounts.get_addresses_list

Requirements
Response
Status Codes

Name	Requirement	Type	Description
account

Parameter	Type	Versions
data[]	array of objects (TwilioAddress)	*
data[][sid]	string	*
data[][account]	integer id (VoiceAccount)	*
data[][customer_name]	string	*
data[][city]	string	*
data[][street]	string	*
data[][region]	string	*
data[][postal_code]	string	*
data[][date_created]	DateTime	*
data[][country_code]	string	*
data[][validated]	boolean	*
data[][verified]	boolean	*

Status Code	Description
200	Returned if everything is ok

POST /api/v2/voice_accounts/twilio/{account}/addresses

Create an address

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_accounts.create_address

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
account

Parameter	Type	Required?
customer_name	string	true
street	string	true
city	string	true
region	string	true
postal_code	string	true

Parameter	Type	Versions
data.sid	string	*
data.account	integer id (VoiceAccount)	*
data.customer_name	string	*
data.city	string	*
data.street	string	*
data.region	string	*
data.postal_code	string	*
data.date_created	DateTime	*
data.country_code	string	*
data.validated	boolean	*
data.verified	boolean	*

Status Code	Description
200	Returned if everything is ok

DELETE /api/v2/voice_accounts/twilio/{account}/addresses/{addressSid}

Delete an address

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_accounts.delete_address

Requirements
Status Codes

Name	Requirement	Type	Description
account
addressSid

Status Code	Description
200	Returned if everything is ok

GET /api/v2/voice_accounts/twilio/{account}/addresses/{addressSid}

Get a voice address

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_accounts.get_address

Requirements
Response
Status Codes

Name	Requirement	Type	Description
account
addressSid

Parameter	Type	Versions
data.sid	string	*
data.account	integer id (VoiceAccount)	*
data.customer_name	string	*
data.city	string	*
data.street	string	*
data.region	string	*
data.postal_code	string	*
data.date_created	DateTime	*
data.country_code	string	*
data.validated	boolean	*
data.verified	boolean	*

Status Code	Description
200	Returned if everything is ok

PUT /api/v2/voice_accounts/twilio/{account}/addresses/{addressSid}

Update an address

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_accounts.update_address

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
account
addressSid

Parameter	Type	Required?
customer_name	string	false
street	string	false
city	string	false
region	string	false
postal_code	string	false

Parameter	Type	Versions
data.sid	string	*
data.account	integer id (VoiceAccount)	*
data.customer_name	string	*
data.city	string	*
data.street	string	*
data.region	string	*
data.postal_code	string	*
data.date_created	DateTime	*
data.country_code	string	*
data.validated	boolean	*
data.verified	boolean	*

Status Code	Description
200	Returned if everything is ok

GET /api/v2/voice_accounts/twilio/{account}/available_countries

Returns a list of available countries with voice service

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_accounts.get_available_countries

Requirements
Response
Status Codes

Name	Requirement	Type	Description
account

Parameter	Type	Versions
data[]	array of objects (TwilioAvailableNumber)	*
data[][number_country_code]	string	*
data[][national_number]	string	*
data[][number]	string	*
data[][country_code]	string	*
data[][sms_enabled]	boolean	*
data[][voice_enabled]	boolean	*
data[][is_sms_supported]	boolean	*
data[][added]	boolean	*
data[][account]	integer id (VoiceAccount)	*
data[][nickname]	string	*
data[][address_requirements]	string	*
data[][region]	string	*
data[][rate_center]	string	*
data[][type]	string	*
data[][price]	string	*
data[][price_unit]	string	*

Status Code	Description
200	Returned if everything is ok

GET /api/v2/voice_accounts/twilio/{account}/available_number_types/{countryCode}

Returns a list of available number types for specific country

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_accounts.get_available_number_types

Requirements
Status Codes

Name	Requirement	Type	Description
account
countryCode		string

Status Code	Description
200	Returned if everything is ok

GET /api/v2/voice_accounts/twilio/{account}/available_numbers

Returns a list of available numbers to buy

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_accounts.get_available_numbers

Requirements
Response
Status Codes

Name	Requirement	Type	Description
account

Parameter	Type	Versions
data[]	array of objects (TwilioAvailableNumber)	*
data[][number_country_code]	string	*
data[][national_number]	string	*
data[][number]	string	*
data[][country_code]	string	*
data[][sms_enabled]	boolean	*
data[][voice_enabled]	boolean	*
data[][is_sms_supported]	boolean	*
data[][added]	boolean	*
data[][account]	integer id (VoiceAccount)	*
data[][nickname]	string	*
data[][address_requirements]	string	*
data[][region]	string	*
data[][rate_center]	string	*
data[][type]	string	*
data[][price]	string	*
data[][price_unit]	string	*

Status Code	Description
200	Returned if everything is ok

POST /api/v2/voice_accounts/twilio/{account}/buy_number

Buy number

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_accounts.buy_number

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
account

Parameter	Type	Required?	Format	Description
number	string	true
address	string	true

Parameter	Type	Versions
data.number_country_code	string	*
data.national_number	string	*
data.number	string	*
data.country_code	string	*
data.sms_enabled	boolean	*
data.voice_enabled	boolean	*
data.is_sms_supported	boolean	*
data.added	boolean	*
data.account	integer id (VoiceAccount)	*
data.nickname	string	*
data.address_requirements	string	*
data.sid	string	*
data.date_created	DateTime	*
data.date_updated	DateTime	*

Status Code	Description
200	Returned if everything is ok

GET /api/v2/voice_accounts/twilio/{account}/existing_numbers

Returns a list of existing (bought) numbers

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_accounts.get_existing_numbers

Requirements
Status Codes

Name	Requirement	Type	Description
account

Status Code	Description
200	Returned if everything is ok

GET /api/v2/voice_accounts/twilio/{account}/refresh_token

Returns client voice auth tokens

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_accounts.create_twilio_client_tokens

Requirements
Response
Status Codes

Name	Requirement	Type	Description
account

Parameter	Type	Versions	Description
data.phone_token	string	*

Status Code	Description
200	Returned if everything is ok

DELETE /api/v2/voice_accounts/twilio/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_accounts.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/voice_accounts/twilio/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_accounts.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.accountId		*
data.authToken		*
data.accountName		*
data.id	integer	*	The unique ID.
data.account_id	string	*
data.auth_token	string	*
data.account_name	string	*
data.account_auth	string	*
data.date_created	DateTime	*
data.numbers[]	array of objects (VoiceNumber)	*
data.numbers[][id]	integer	*	The unique ID.
data.numbers[][sid]	string	*
data.numbers[][number]	string	*
data.numbers[][nickname]	string	*
data.numbers[][outbound_calls_enabled]	boolean	*
data.numbers[][outbound_calls_default]	boolean	*
data.numbers[][outbound_calls_default_type]	string	*
data.numbers[][outbound_calls_default_countries]	array	*
data.numbers[][is_voice_enabled]	boolean	*
data.numbers[][is_sms_enabled]	boolean	*
data.numbers[][is_sms_supported]	boolean	*
data.numbers[][account]		*
data.numbers[][target]		*
data.numbers[][outboundCallsDefaultType]		*
data.twiml_app_sid	string	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/voice_accounts/twilio/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.twilio_accounts.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?
account_name	string	false
account_id	string	false
auth_token	string	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

DELETE /api/v2/voice_accounts/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_accounts.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/voice_accounts/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_accounts.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.accountId		*
data.authToken		*
data.accountName		*
data.id	integer	*	The unique ID.
data.account_id	string	*
data.auth_token	string	*
data.account_name	string	*
data.account_auth	string	*
data.date_created	DateTime	*
data.numbers[]	array of objects (VoiceNumber)	*
data.numbers[][id]	integer	*	The unique ID.
data.numbers[][sid]	string	*
data.numbers[][number]	string	*
data.numbers[][nickname]	string	*
data.numbers[][outbound_calls_enabled]	boolean	*
data.numbers[][outbound_calls_default]	boolean	*
data.numbers[][outbound_calls_default_type]	string	*
data.numbers[][outbound_calls_default_countries]	array	*
data.numbers[][is_voice_enabled]	boolean	*
data.numbers[][is_sms_enabled]	boolean	*
data.numbers[][is_sms_supported]	boolean	*
data.numbers[][account]		*
data.numbers[][target]		*
data.numbers[][outboundCallsDefaultType]		*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

GET /api/v2/voice_assets CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_assets.list

Filters
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/voice_assets CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_assets.post

Status Codes

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/voice_assets/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_assets.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/voice_assets/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_assets.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/voice_assets/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_assets.get

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/voice_assets/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_assets.put

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/voice_auto_attendants CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_auto_attendants.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (VoiceAutoAttendant)	*
data[][name]	string	*
data[][audioAsset]		*
data[][dialNumbers]		*
data[][targets]	array	*
data[][id]	integer	*	The unique ID.
data[][allow_repeat_menu]	boolean	*
data[][allow_extension]	boolean	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/voice_auto_attendants CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_auto_attendants.post

Parameters
Response
Status Codes

Parameter	Type	Required?	Format
name	string	true
audio_asset	string	false
targets[1][type]	choice	true	["queue","agent","auto_attendant"]
targets[2][type]	choice	true	["queue","agent","auto_attendant"]
targets[3][type]	choice	true	["queue","agent","auto_attendant"]
targets[4][type]	choice	true	["queue","agent","auto_attendant"]
targets[5][type]	choice	true	["queue","agent","auto_attendant"]
targets[6][type]	choice	true	["queue","agent","auto_attendant"]
targets[7][type]	choice	true	["queue","agent","auto_attendant"]
targets[8][type]	choice	true	["queue","agent","auto_attendant"]
targets[9][type]	choice	true	["queue","agent","auto_attendant"]
allow_repeat_menu	boolean	true
allow_extension	boolean	true

Parameter	Type	Versions	Description
data.name	string	*
data.audioAsset		*
data.dialNumbers		*
data.targets	array	*
data.id	integer	*	The unique ID.
data.allow_repeat_menu	boolean	*
data.allow_extension	boolean	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/voice_auto_attendants/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_auto_attendants.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/voice_auto_attendants/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_auto_attendants.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/voice_auto_attendants/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_auto_attendants.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.name	string	*
data.audioAsset		*
data.dialNumbers		*
data.targets	array	*
data.id	integer	*	The unique ID.
data.allow_repeat_menu	boolean	*
data.allow_extension	boolean	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/voice_auto_attendants/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_auto_attendants.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format
name	string	false
audio_asset	string	false
targets[1][type]	choice	false	["queue","agent","auto_attendant"]
targets[2][type]	choice	false	["queue","agent","auto_attendant"]
targets[3][type]	choice	false	["queue","agent","auto_attendant"]
targets[4][type]	choice	false	["queue","agent","auto_attendant"]
targets[5][type]	choice	false	["queue","agent","auto_attendant"]
targets[6][type]	choice	false	["queue","agent","auto_attendant"]
targets[7][type]	choice	false	["queue","agent","auto_attendant"]
targets[8][type]	choice	false	["queue","agent","auto_attendant"]
targets[9][type]	choice	false	["queue","agent","auto_attendant"]
allow_repeat_menu	boolean	false
allow_extension	boolean	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

PUT /api/v2/voice_client/phone_call/{phoneCall}/accept_call

Agent accepts a call

Documentation

Agent accepts a call.

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_client_phone_call.accept_call

Requirements
Status Codes

Name	Requirement	Type	Description
phoneCall

Status Code	Description
200	Returned if everything is ok

PUT /api/v2/voice_client/phone_call/{phoneCall}/assign_agent

Assign agent to the ticket

Documentation

Force agent assign to a ticket to open the created voice ticket asap. It works slowly in voice callbacks.

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_client_phone_call.assign_agent

Requirements
Status Codes

Name	Requirement	Type	Description
phoneCall

Status Code	Description
200	Returned if everything is ok

PUT /api/v2/voice_client/phone_call/{phoneCall}/cancel_invite/{agent}

Cancel phone call notification

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_client_phone_call.cancel_agent_invite

Requirements
Status Codes

Name	Requirement	Type	Description
phoneCall
agent

Status Code	Description
204	Returned if everything is ok

PUT /api/v2/voice_client/phone_call/{phoneCall}/cold_transfer/agent/{agent}

Cold transfer call to an another agent

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_client_phone_call.cold_transfer_to_agent

Requirements
Status Codes

Name	Requirement	Type	Description
phoneCall
agent

Status Code	Description
204	Returned if everything is ok

PUT /api/v2/voice_client/phone_call/{phoneCall}/cold_transfer/auto_attendant/{autoAttendant}

Cold transfer call to a voice auto attendant

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_client_phone_call.cold_transfer_to_auto_attendant

Requirements
Status Codes

Name	Requirement	Type	Description
phoneCall
autoAttendant

Status Code	Description
204	Returned if everything is ok

PUT /api/v2/voice_client/phone_call/{phoneCall}/cold_transfer/number

Cold transfer call to an external number

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_client_phone_call.cold_transfer_to_number

Requirements
Status Codes

Name	Requirement	Type	Description
phoneCall

Status Code	Description
204	Returned if everything is ok

PUT /api/v2/voice_client/phone_call/{phoneCall}/cold_transfer/queue/{queue}

Cold transfer call to a voice queue

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_client_phone_call.cold_transfer_to_queue

Requirements
Status Codes

Name	Requirement	Type	Description
phoneCall
queue

Status Code	Description
204	Returned if everything is ok

PUT /api/v2/voice_client/phone_call/{phoneCall}/end_call

End phone call

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_client_phone_call.end_call

Requirements
Status Codes

Name	Requirement	Type	Description
phoneCall

Status Code	Description
204	Returned if everything is ok

PUT /api/v2/voice_client/phone_call/{phoneCall}/hold_call

Toggle the hold status for the end user caller

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_client_phone_call.hold_call

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
phoneCall

Parameter	Type	Required?	Format	Description
	boolean	false		put on hold

Status Code	Description
204	Returned if everything is ok

PUT /api/v2/voice_client/phone_call/{phoneCall}/ignore_invite/{agent}

Ignore phone call notification

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_client_phone_call.ignore_invite

Requirements
Status Codes

Name	Requirement	Type	Description
phoneCall
agent

Status Code	Description
204	Returned if everything is ok

GET /api/v2/voice_client/phone_call/{phoneCall}/is_active

Verify if user is still connected

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_client_phone_call.check_is_active

Requirements
Response
Status Codes

Name	Requirement	Type	Description
phoneCall

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.ref	string	*	String reference.
data.auth	string	*	Auth string.
data.parent	integer id (Ticket)	*	Parent of this ticket.
data.language	integer id (Language)	*	Language associated with this ticket.
data.brand	integer id (Brand)	*	Ticket brand.
data.department	integer id (Department)	*	Ticket where this department is processing.
data.category	integer id (TicketCategory)	*	Category of this ticket.
data.priority	integer id (TicketPriority)	*	Priority of this ticket.
data.workflow	integer id (TicketWorkflow)	*	Workflow entity.
data.product	integer id (Product)	*	Product about which this ticket.
data.person	integer id (Person)	*	Person created this ticket.
data.person_email	string representation (PersonEmail)	*	Person's email.
data.agent	integer id (Person)	*	Agent assigned.
data.agent_team	integer id (AgentTeam)	*	Agent team where this ticket is processing.
data.organization	integer id (Organization)	*	Organization team where this ticket is processing.
data.linked_chat	integer id (ChatConversation)	*	ChatConversation where this ticket is discussed.
data.sent_to_address	array	*	Addresses where ticket was send.
data.email_account	integer id (EmailAccount)	*	Email account used to gather the ticket.
data.email_account_address	string	*	Email account address used to gather the ticket.
data.creation_system	string	*	How this ticket appears.
data.creation_system_option	string	*	Option used by creation system.
data.ticket_hash	string	*	Unique hash.
data.status	string	<=20170400	Legacy ticket status.
data.hidden_status	string	<=20170400	Legacy ticket hidden status.
data.ticket_status	string	*	Ticket status.
data.is_hold	boolean	*	Is this on hold?
data.labels[]	array of strings	*	String array of labels.
data.urgency	integer	*	How urgent this ticket?
data.feedback_rating	integer	*	Its rating based on feedback votes.
data.date_feedback_rating	DateTime	*	When the rating was calculated.
data.date_created	DateTime	*	When the ticket was created.
data.date_resolved	DateTime	*	When the ticket was resolved.
data.date_archived	DateTime	*	And archived at last.
data.date_first_agent_assign	DateTime	*	When it was assigned to agent at the very first time.
data.date_first_agent_reply	DateTime	*	When it was first time replied.
data.date_last_agent_reply	DateTime	*	And when it was replied the last time.
data.date_last_user_reply	DateTime	*	And the date user replied here last time.
data.date_agent_waiting	DateTime	*	Time when agent started to wait user.
data.date_user_waiting	DateTime	*	And the time when user started to wait agent.
data.date_status	DateTime	*	When status was changed.
data.total_user_waiting	integer	*	How much user was waited?
data.total_to_first_reply	integer	*	Total waiting before first reply.
data.total_user_waiting_wh	integer	*	Total user waiting in working hours.
data.total_to_first_reply_wh	integer	*	Total waiting before first reply in working hour.
data.locked_by_agent	integer id (Person)	*	An agent who locked the ticket.
data.date_locked	DateTime	*	Date time when ticket was locked.
data.date_on_hold	DateTime	*	Datetime when ticket was set on hold.
data.has_attachments	boolean	*	Does this ticket has attachments?
data.subject	string	*	Ticket subject.
data.original_subject	string	*	Original subject given by creator.
data.properties	array	*	Array of properties.
data.problems[]	array of integer ids (Problem)	*	An array of associated problems.
data.count_agent_replies	integer	*	Count of all replies made by agents.
data.count_user_replies	integer	*	Count of all replies made by user.
data.worst_sla_status	string	*	Well, this is worst SLA status.
data.waiting_times	array	*	An array of waiting times.
data.ticket_slas[]	array of integer ids (TicketSla)	*	All ticket SLAS.
data.fields[]	dynamically declared custom fields (ticket)	*	Custom ticket fields.
data.contextual_fields	custom handler result for (custom_per_data)	*	Contextual ticket fields (per user/org fields).
data.children[]	array of integer ids (Ticket)	*	Ticket children.
data.siblings[]	array of integer ids (Ticket)	*	Ticket siblings.
data.cc[]	array of integer ids (Person)	*	User should be acknowledged about this ticket.
data.star	string	*	Person star color.
data.ticket_layout	custom handler result for (raw)	*
data.ticket_excerpt	custom handler result for (raw)	*
data.ticket_agent_errors	custom handler result for (raw)	*
data.ticket_user_errors	custom handler result for (raw)	*
data.ticket_permissions	custom handler result for (raw)	*
data.access_code	string	*	Access code.
data.followers	string	*	Followers of that ticket as a comma-separated list of names.

Status Code	Description
204	Returned if everything is ok

PUT /api/v2/voice_client/phone_call/{phoneCall}/mute_call

Toggle agent mute

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_client_phone_call.mute

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
phoneCall

Parameter	Type	Required?	Format	Description
	boolean	false		is mute enabled

Status Code	Description
204	Returned if everything is ok

PUT /api/v2/voice_client/phone_call/{phoneCall}/reject_call

Agent rejects a call

Documentation

Agent rejects a call.

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_client_phone_call.reject_call

Requirements
Status Codes

Name	Requirement	Type	Description
phoneCall

Status Code	Description
204	Returned if everything is ok

GET /api/v2/voice_client/phone_call/{phoneCall}/status

Get conference status

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_client_phone_call.get_call_status

Requirements
Status Codes

Name	Requirement	Type	Description
phoneCall

Status Code	Description
200	Returned if everything is ok

GET /api/v2/voice_client/phone_call/{phoneCall}/ticket

Returns related phone call ticket

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_client_phone_call.get_phone_call_ticket

Requirements
Response
Status Codes

Name	Requirement	Type	Description
phoneCall

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.ref	string	*	String reference.
data.auth	string	*	Auth string.
data.parent	integer id (Ticket)	*	Parent of this ticket.
data.language	integer id (Language)	*	Language associated with this ticket.
data.brand	integer id (Brand)	*	Ticket brand.
data.department	integer id (Department)	*	Ticket where this department is processing.
data.category	integer id (TicketCategory)	*	Category of this ticket.
data.priority	integer id (TicketPriority)	*	Priority of this ticket.
data.workflow	integer id (TicketWorkflow)	*	Workflow entity.
data.product	integer id (Product)	*	Product about which this ticket.
data.person	integer id (Person)	*	Person created this ticket.
data.person_email	string representation (PersonEmail)	*	Person's email.
data.agent	integer id (Person)	*	Agent assigned.
data.agent_team	integer id (AgentTeam)	*	Agent team where this ticket is processing.
data.organization	integer id (Organization)	*	Organization team where this ticket is processing.
data.linked_chat	integer id (ChatConversation)	*	ChatConversation where this ticket is discussed.
data.sent_to_address	array	*	Addresses where ticket was send.
data.email_account	integer id (EmailAccount)	*	Email account used to gather the ticket.
data.email_account_address	string	*	Email account address used to gather the ticket.
data.creation_system	string	*	How this ticket appears.
data.creation_system_option	string	*	Option used by creation system.
data.ticket_hash	string	*	Unique hash.
data.status	string	<=20170400	Legacy ticket status.
data.hidden_status	string	<=20170400	Legacy ticket hidden status.
data.ticket_status	string	*	Ticket status.
data.is_hold	boolean	*	Is this on hold?
data.labels[]	array of strings	*	String array of labels.
data.urgency	integer	*	How urgent this ticket?
data.feedback_rating	integer	*	Its rating based on feedback votes.
data.date_feedback_rating	DateTime	*	When the rating was calculated.
data.date_created	DateTime	*	When the ticket was created.
data.date_resolved	DateTime	*	When the ticket was resolved.
data.date_archived	DateTime	*	And archived at last.
data.date_first_agent_assign	DateTime	*	When it was assigned to agent at the very first time.
data.date_first_agent_reply	DateTime	*	When it was first time replied.
data.date_last_agent_reply	DateTime	*	And when it was replied the last time.
data.date_last_user_reply	DateTime	*	And the date user replied here last time.
data.date_agent_waiting	DateTime	*	Time when agent started to wait user.
data.date_user_waiting	DateTime	*	And the time when user started to wait agent.
data.date_status	DateTime	*	When status was changed.
data.total_user_waiting	integer	*	How much user was waited?
data.total_to_first_reply	integer	*	Total waiting before first reply.
data.total_user_waiting_wh	integer	*	Total user waiting in working hours.
data.total_to_first_reply_wh	integer	*	Total waiting before first reply in working hour.
data.locked_by_agent	integer id (Person)	*	An agent who locked the ticket.
data.date_locked	DateTime	*	Date time when ticket was locked.
data.date_on_hold	DateTime	*	Datetime when ticket was set on hold.
data.has_attachments	boolean	*	Does this ticket has attachments?
data.subject	string	*	Ticket subject.
data.original_subject	string	*	Original subject given by creator.
data.properties	array	*	Array of properties.
data.problems[]	array of integer ids (Problem)	*	An array of associated problems.
data.count_agent_replies	integer	*	Count of all replies made by agents.
data.count_user_replies	integer	*	Count of all replies made by user.
data.worst_sla_status	string	*	Well, this is worst SLA status.
data.waiting_times	array	*	An array of waiting times.
data.ticket_slas[]	array of integer ids (TicketSla)	*	All ticket SLAS.
data.fields[]	dynamically declared custom fields (ticket)	*	Custom ticket fields.
data.contextual_fields	custom handler result for (custom_per_data)	*	Contextual ticket fields (per user/org fields).
data.children[]	array of integer ids (Ticket)	*	Ticket children.
data.siblings[]	array of integer ids (Ticket)	*	Ticket siblings.
data.cc[]	array of integer ids (Person)	*	User should be acknowledged about this ticket.
data.star	string	*	Person star color.
data.ticket_layout	custom handler result for (raw)	*
data.ticket_excerpt	custom handler result for (raw)	*
data.ticket_agent_errors	custom handler result for (raw)	*
data.ticket_user_errors	custom handler result for (raw)	*
data.ticket_permissions	custom handler result for (raw)	*
data.access_code	string	*	Access code.
data.followers	string	*	Followers of that ticket as a comma-separated list of names.

Status Code	Description
204	Returned if everything is ok

PUT /api/v2/voice_client/phone_call/{phoneCall}/warm_add/{agent}

Sends client notification to join the phone call

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_client_phone_call.warm_add

Requirements
Status Codes

Name	Requirement	Type	Description
phoneCall
agent

Status Code	Description
204	Returned if everything is ok

PUT /api/v2/voice_client/phone_call/{phoneCall}/warm_transfer/number

Warm transfer call to an external number

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_client_phone_call.warm_transfer_to_number

Requirements
Status Codes

Name	Requirement	Type	Description
phoneCall

Status Code	Description
204	Returned if everything is ok

PUT /api/v2/voice_client/phone_call/{phoneCall}/warm_transfer/number/cancel

Warm transfer call to an external number

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_client_phone_call.cancel_warm_transfer_to_number

Requirements
Status Codes

Name	Requirement	Type	Description
phoneCall

Status Code	Description
204	Returned if everything is ok

PUT /api/v2/voice_client/phone_call/{phoneCall}/warm_transfer/{agent}

Warm transfer call to an another agent

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_client_phone_call.warm_transfer

Requirements
Status Codes

Name	Requirement	Type	Description
agent	\d+
phoneCall

Status Code	Description
204	Returned if everything is ok

POST /api/v2/voice_client/prepare_outbound_call

Prepares outbound phone call

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_client.prepare_outbound_call

Parameters
Response
Status Codes

Parameter	Type	Required?
call_from	choice	true
call_to	string	true
ticket	choice	false
person	choice	false

Parameter	Type	Versions	Description
data.number	object (VoiceNumber)	*
data.number[id]	integer	*	The unique ID.
data.number[sid]	string	*
data.number[number]	string	*
data.number[nickname]	string	*
data.number[outbound_calls_enabled]	boolean	*
data.number[outbound_calls_default]	boolean	*
data.number[outbound_calls_default_type]	string	*
data.number[outbound_calls_default_countries]	array	*
data.number[is_voice_enabled]	boolean	*
data.number[is_sms_enabled]	boolean	*
data.number[is_sms_supported]	boolean	*
data.number[account]		*
data.number[target]		*
data.number[outboundCallsDefaultType]		*
data.externalNumber		*
data.externalNumberType		*
data.id	integer	*	The unique ID.
data.task_sid	string	*
data.task_sids	array	*
data.call_sid	string	*
data.conference_sid	string	*
data.call_sids	array	*
data.number_plain	string	*	Keep plain number in case if the number is disabled or removed.
data.external_number	string	*
data.external_number_type	string	*
data.person	object (Person)	*
data.person[emails]		*
data.person[labels]		*
data.person[teams]		*
data.person[primary_team]		*
data.person[agentData]		*
data.person[publicUsergroups]		*
data.person[publicAgentgroups]		*
data.type	string	*
data.status	string	*
data.data	array	*
data.phone_call_logs[]	array of objects (VoicePhoneCallLog)	*
data.phone_call_logs[][id]	integer	*	The unique ID.
data.phone_call_logs[][person]	integer id (Person)	*
data.phone_call_logs[][action_type]	string	*
data.phone_call_logs[][details]	array	*
data.phone_call_logs[][date_created]	DateTime	*
data.phone_call_logs[][target_agent]	integer id (Person)	*
data.phone_call_logs[][target_queue]	integer id (VoiceQueue)	*
data.phone_call_logs[][target_auto_attendant]	integer id (VoiceAutoAttendant)	*
data.date_created	DateTime	*
data.date_started	DateTime	*
data.date_waiting	DateTime	*
data.date_ended	DateTime	*
data.full_recording	object (VoiceRecording)	*
data.full_recording[id]	integer	*	The unique ID.
data.full_recording[duration]	integer	*
data.full_recording[blob]	object (Blob)	*
data.full_recording[blob][sys_name]	string	*	A unique system name for the blob.
data.full_recording[blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.full_recording[blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.full_recording[blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.full_recording[blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.full_recording[blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.full_recording[blob][file_url]	string	*	The HTTP link to download the file.
data.full_recording[blob][authcode]	string	*
data.full_recording[blob][blob_hash]	string	*
data.full_recording[blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.full_recording[blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.full_recording[blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.full_recording[blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.full_recording[blob][date_created]	DateTime	*
data.full_recording[blob][is_temp]	boolean	*
data.full_recording[blob][source_ref]	string	*
data.full_recording[blob][labels][]	array of objects (LabelBlob)	*
data.full_recording[blob][labels][][blob]	object (Blob)	*
data.full_recording[transcription]	string	*
data.full_recording[is_deleted]	boolean	*
data.full_recording[metadata]	array	*	Additional data attached to message (not implemented).
data.recordings[]	array of objects (VoiceRecording)	*
data.agent_voicemail_record	object (VoiceMissedAgentCall)	*
data.agent_voicemail_record[id]	integer	*	The unique ID.
data.agent_voicemail_record[duration]	integer	*
data.agent_voicemail_record[blob]	object (Blob)	*
data.agent_voicemail_record[blob][sys_name]	string	*	A unique system name for the blob.
data.agent_voicemail_record[blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.agent_voicemail_record[blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.agent_voicemail_record[blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.agent_voicemail_record[blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.agent_voicemail_record[blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.agent_voicemail_record[blob][file_url]	string	*	The HTTP link to download the file.
data.agent_voicemail_record[blob][authcode]	string	*
data.agent_voicemail_record[blob][blob_hash]	string	*
data.agent_voicemail_record[blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.agent_voicemail_record[blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.agent_voicemail_record[blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.agent_voicemail_record[blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.agent_voicemail_record[blob][date_created]	DateTime	*
data.agent_voicemail_record[blob][is_temp]	boolean	*
data.agent_voicemail_record[blob][source_ref]	string	*
data.agent_voicemail_record[blob][labels][]	array of objects (LabelBlob)	*
data.agent_voicemail_record[blob][labels][][blob]	object (Blob)	*
data.agent_voicemail_record[transcription]	string	*
data.agent_voicemail_record[is_deleted]	boolean	*
data.agent_voicemail_record[agent]	integer id (Person)	*
data.agent_voicemail_record[phone_call]	integer id (VoicePhoneCall)	*
data.agent_voicemail_record[data]	array	*
data.agent_voicemail_record[date_created]	DateTime	*
data.agent_voicemail_record[is_listened]	boolean	*
data.recording_enabled	boolean	*
data.cost	string	*
data.cost_currency	string	*
data.enqueued_as	string	*

Status Code	Description
200	Returned if everything is ok

GET /api/v2/voice_missed_agent_calls CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_missed_agent_calls.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (VoiceMissedAgentCall)	*
data[][id]	integer	*	The unique ID.
data[][duration]	integer	*
data[][blob]	object (Blob)	*
data[][blob][sys_name]	string	*	A unique system name for the blob.
data[][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][blob][file_url]	string	*	The HTTP link to download the file.
data[][blob][authcode]	string	*
data[][blob][blob_hash]	string	*
data[][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][blob][date_created]	DateTime	*
data[][blob][is_temp]	boolean	*
data[][blob][source_ref]	string	*
data[][blob][labels][]	array of objects (LabelBlob)	*
data[][blob][labels][][blob]	object (Blob)	*
data[][transcription]	string	*
data[][is_deleted]	boolean	*
data[][agent]	integer id (Person)	*
data[][phone_call]	integer id (VoicePhoneCall)	*
data[][data]	array	*
data[][date_created]	DateTime	*
data[][is_listened]	boolean	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

GET /api/v2/voice_missed_agent_calls/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_missed_agent_calls.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/voice_missed_agent_calls/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_missed_agent_calls.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/voice_missed_agent_calls/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_missed_agent_calls.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.duration	integer	*
data.blob	object (Blob)	*
data.blob[sys_name]	string	*	A unique system name for the blob.
data.blob[original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.blob[storage_loc]	string	*	The storage adapter that knows how to load this file.
data.blob[storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.blob[storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.blob[save_path]	string	*	The path to the file if it's not stored in the database.
data.blob[file_url]	string	*	The HTTP link to download the file.
data.blob[authcode]	string	*
data.blob[blob_hash]	string	*
data.blob[is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.blob[title]	string	*	The title of this file used in interfaces if its a media upload.
data.blob[dim_w]	integer	*	If this type of file has dimentions, the width.
data.blob[dim_h]	integer	*	If this type of file has dimentions, the height.
data.blob[date_created]	DateTime	*
data.blob[is_temp]	boolean	*
data.blob[source_ref]	string	*
data.blob[labels][]	array of objects (LabelBlob)	*
data.blob[labels][][blob]	object (Blob)	*
data.transcription	string	*
data.is_deleted	boolean	*
data.agent	integer id (Person)	*
data.phone_call	integer id (VoicePhoneCall)	*
data.data	array	*
data.date_created	DateTime	*
data.is_listened	boolean	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

POST /api/v2/voice_missed_agent_calls/{missedAgentCall}/create_ticket

Create voicemail ticket

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_missed_agent_calls.create_ticket

Requirements
Status Codes

Name	Requirement	Type	Description
missedAgentCall

Status Code	Description
204	Returned if everything is ok

PUT /api/v2/voice_missed_agent_calls/{record}/mark_listened

Mark voicemail record as listened to

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_missed_agent_calls.mark_listened_to

Requirements
Status Codes

Name	Requirement	Type	Description
record

Status Code	Description
204	Returned if everything is ok

GET /api/v2/voice_numbers CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_numbers.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (VoiceNumber)	*
data[][account]		*
data[][sid]	string	*
data[][number]	string	*
data[][target]		*
data[][outboundCallsDefaultType]		*
data[][id]	integer	*	The unique ID.
data[][nickname]	string	*
data[][outbound_calls_enabled]	boolean	*
data[][outbound_calls_default]	boolean	*
data[][outbound_calls_default_type]	string	*
data[][outbound_calls_default_countries]	array	*
data[][is_voice_enabled]	boolean	*
data[][is_sms_enabled]	boolean	*
data[][is_sms_supported]	boolean	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/voice_numbers CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_numbers.post

Parameters
Response
Status Codes

Parameter	Type	Required?	Format
account	choice	true
sid	string	true
nickname	string	false
number	string	true
target[type]	choice	true	["queue","agent","auto_attendant"]
is_voice_enabled	boolean	false
is_sms_enabled	boolean	false
is_sms_supported	boolean	false
outbound_calls_enabled	boolean	false
outbound_calls_default	boolean	false
outbound_calls_default_type	choice	false	["country","specific","all"]
outbound_calls_default_countries[]	array of choices	false	["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","ck","cr","ci","hr","cu","cy","cz","cd","dk","dj","dm","do","tp","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","kp","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","sm","st","sa","sn","rs","sc","sl","sg","sk","si","sb","so","za","gs","kr","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","gb","us","um","uy","uz","vu","va","ve","vn","vg","vi","wf","eh","ws","ye","yu","zm","zw","ax","bl","bq","cw","gg","im","je","me","mf","ss","sx","tl","xk"]

Parameter	Type	Versions	Description
data.account		*
data.sid	string	*
data.number	string	*
data.target		*
data.outboundCallsDefaultType		*
data.id	integer	*	The unique ID.
data.nickname	string	*
data.outbound_calls_enabled	boolean	*
data.outbound_calls_default	boolean	*
data.outbound_calls_default_type	string	*
data.outbound_calls_default_countries	array	*
data.is_voice_enabled	boolean	*
data.is_sms_enabled	boolean	*
data.is_sms_supported	boolean	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/voice_numbers/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_numbers.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/voice_numbers/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_numbers.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/voice_numbers/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_numbers.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.account		*
data.sid	string	*
data.number	string	*
data.target		*
data.outboundCallsDefaultType		*
data.id	integer	*	The unique ID.
data.nickname	string	*
data.outbound_calls_enabled	boolean	*
data.outbound_calls_default	boolean	*
data.outbound_calls_default_type	string	*
data.outbound_calls_default_countries	array	*
data.is_voice_enabled	boolean	*
data.is_sms_enabled	boolean	*
data.is_sms_supported	boolean	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/voice_numbers/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_numbers.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format
account	choice	false
sid	string	false
nickname	string	false
number	string	false
target[type]	choice	false	["queue","agent","auto_attendant"]
is_voice_enabled	boolean	false
is_sms_enabled	boolean	false
is_sms_supported	boolean	false
outbound_calls_enabled	boolean	false
outbound_calls_default	boolean	false
outbound_calls_default_type	choice	false	["country","specific","all"]
outbound_calls_default_countries[]	array of choices	false	["af","al","dz","as","ad","ao","ai","aq","ag","ar","am","aw","au","at","az","bs","bh","bd","bb","by","be","bz","bj","bm","bt","bo","ba","bw","bv","br","io","bn","bg","bf","bi","kh","cm","ca","cv","ky","cf","td","cl","cn","cx","cc","co","km","cg","ck","cr","ci","hr","cu","cy","cz","cd","dk","dj","dm","do","tp","ec","eg","sv","gq","er","ee","et","fk","fo","fj","fi","fr","gf","pf","tf","ga","gm","ge","de","gh","gi","gr","gl","gd","gp","gu","gt","gn","gw","gy","ht","hm","hn","hk","hu","is","in","id","ir","iq","ie","il","it","jm","jp","jo","kz","ke","ki","kw","kg","la","lv","lb","ls","lr","ly","li","lt","lu","mo","mk","mg","mw","my","mv","ml","mt","mh","mq","mr","mu","yt","mx","fm","md","mc","mn","ms","ma","mz","mm","na","nr","np","nl","an","nc","nz","ni","ne","ng","nu","nf","kp","mp","no","om","pk","pw","ps","pa","pg","py","pe","ph","pn","pl","pt","pr","qa","re","ro","ru","rw","sh","kn","lc","pm","vc","sm","st","sa","sn","rs","sc","sl","sg","sk","si","sb","so","za","gs","kr","es","lk","sd","sr","sj","sz","se","ch","sy","tw","tj","tz","th","tg","tk","to","tt","tn","tr","tm","tc","tv","ug","ua","ae","gb","us","um","uy","uz","vu","va","ve","vn","vg","vi","wf","eh","ws","ye","yu","zm","zw","ax","bl","bq","cw","gg","im","je","me","mf","ss","sx","tl","xk"]

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/voice_phone_calls CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_phone_calls.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (VoicePhoneCall)	*
data[][number]	object (VoiceNumber)	*
data[][number][id]	integer	*	The unique ID.
data[][number][sid]	string	*
data[][number][number]	string	*
data[][number][nickname]	string	*
data[][number][outbound_calls_enabled]	boolean	*
data[][number][outbound_calls_default]	boolean	*
data[][number][outbound_calls_default_type]	string	*
data[][number][outbound_calls_default_countries]	array	*
data[][number][is_voice_enabled]	boolean	*
data[][number][is_sms_enabled]	boolean	*
data[][number][is_sms_supported]	boolean	*
data[][externalNumber]		*
data[][externalNumberType]		*
data[][id]	integer	*	The unique ID.
data[][task_sid]	string	*
data[][task_sids]	array	*
data[][call_sid]	string	*
data[][conference_sid]	string	*
data[][call_sids]	array	*
data[][number_plain]	string	*	Keep plain number in case if the number is disabled or removed.
data[][external_number]	string	*
data[][external_number_type]	string	*
data[][person]	object (Person)	*
data[][type]	string	*
data[][status]	string	*
data[][data]	array	*
data[][phone_call_logs][]	array of objects (VoicePhoneCallLog)	*
data[][phone_call_logs][][id]	integer	*	The unique ID.
data[][phone_call_logs][][person]	integer id (Person)	*
data[][phone_call_logs][][action_type]	string	*
data[][phone_call_logs][][details]	array	*
data[][phone_call_logs][][date_created]	DateTime	*
data[][phone_call_logs][][target_agent]	integer id (Person)	*
data[][phone_call_logs][][target_queue]	integer id (VoiceQueue)	*
data[][phone_call_logs][][target_auto_attendant]	integer id (VoiceAutoAttendant)	*
data[][date_created]	DateTime	*
data[][date_started]	DateTime	*
data[][date_waiting]	DateTime	*
data[][date_ended]	DateTime	*
data[][full_recording]	object (VoiceRecording)	*
data[][full_recording][id]	integer	*	The unique ID.
data[][full_recording][duration]	integer	*
data[][full_recording][blob]	object (Blob)	*
data[][full_recording][blob][sys_name]	string	*	A unique system name for the blob.
data[][full_recording][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][full_recording][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][full_recording][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][full_recording][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][full_recording][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][full_recording][blob][file_url]	string	*	The HTTP link to download the file.
data[][full_recording][blob][authcode]	string	*
data[][full_recording][blob][blob_hash]	string	*
data[][full_recording][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][full_recording][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][full_recording][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][full_recording][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][full_recording][blob][date_created]	DateTime	*
data[][full_recording][blob][is_temp]	boolean	*
data[][full_recording][blob][source_ref]	string	*
data[][full_recording][blob][labels][]	array of objects (LabelBlob)	*
data[][full_recording][blob][labels][][blob]	object (Blob)	*
data[][full_recording][transcription]	string	*
data[][full_recording][is_deleted]	boolean	*
data[][full_recording][metadata]	array	*	Additional data attached to message (not implemented).
data[][recordings][]	array of objects (VoiceRecording)	*
data[][agent_voicemail_record]	object (VoiceMissedAgentCall)	*
data[][agent_voicemail_record][id]	integer	*	The unique ID.
data[][agent_voicemail_record][duration]	integer	*
data[][agent_voicemail_record][blob]	object (Blob)	*
data[][agent_voicemail_record][blob][sys_name]	string	*	A unique system name for the blob.
data[][agent_voicemail_record][blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][agent_voicemail_record][blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][agent_voicemail_record][blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][agent_voicemail_record][blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][agent_voicemail_record][blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][agent_voicemail_record][blob][file_url]	string	*	The HTTP link to download the file.
data[][agent_voicemail_record][blob][authcode]	string	*
data[][agent_voicemail_record][blob][blob_hash]	string	*
data[][agent_voicemail_record][blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][agent_voicemail_record][blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][agent_voicemail_record][blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][agent_voicemail_record][blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][agent_voicemail_record][blob][date_created]	DateTime	*
data[][agent_voicemail_record][blob][is_temp]	boolean	*
data[][agent_voicemail_record][blob][source_ref]	string	*
data[][agent_voicemail_record][blob][labels][]	array of objects (LabelBlob)	*
data[][agent_voicemail_record][blob][labels][][blob]	object (Blob)	*
data[][agent_voicemail_record][transcription]	string	*
data[][agent_voicemail_record][is_deleted]	boolean	*
data[][agent_voicemail_record][agent]	integer id (Person)	*
data[][agent_voicemail_record][phone_call]	integer id (VoicePhoneCall)	*
data[][agent_voicemail_record][data]	array	*
data[][agent_voicemail_record][date_created]	DateTime	*
data[][agent_voicemail_record][is_listened]	boolean	*
data[][recording_enabled]	boolean	*
data[][cost]	string	*
data[][cost_currency]	string	*
data[][enqueued_as]	string	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

GET /api/v2/voice_phone_calls/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_phone_calls.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

GET /api/v2/voice_phone_calls/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_phone_calls.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.number	object (VoiceNumber)	*
data.number[id]	integer	*	The unique ID.
data.number[sid]	string	*
data.number[number]	string	*
data.number[nickname]	string	*
data.number[outbound_calls_enabled]	boolean	*
data.number[outbound_calls_default]	boolean	*
data.number[outbound_calls_default_type]	string	*
data.number[outbound_calls_default_countries]	array	*
data.number[is_voice_enabled]	boolean	*
data.number[is_sms_enabled]	boolean	*
data.number[is_sms_supported]	boolean	*
data.number[account]		*
data.number[target]		*
data.number[outboundCallsDefaultType]		*
data.externalNumber		*
data.externalNumberType		*
data.id	integer	*	The unique ID.
data.task_sid	string	*
data.task_sids	array	*
data.call_sid	string	*
data.conference_sid	string	*
data.call_sids	array	*
data.number_plain	string	*	Keep plain number in case if the number is disabled or removed.
data.external_number	string	*
data.external_number_type	string	*
data.person	object (Person)	*
data.person[emails]		*
data.person[labels]		*
data.person[teams]		*
data.person[primary_team]		*
data.person[agentData]		*
data.person[publicUsergroups]		*
data.person[publicAgentgroups]		*
data.type	string	*
data.status	string	*
data.data	array	*
data.phone_call_logs[]	array of objects (VoicePhoneCallLog)	*
data.phone_call_logs[][id]	integer	*	The unique ID.
data.phone_call_logs[][person]	integer id (Person)	*
data.phone_call_logs[][action_type]	string	*
data.phone_call_logs[][details]	array	*
data.phone_call_logs[][date_created]	DateTime	*
data.phone_call_logs[][target_agent]	integer id (Person)	*
data.phone_call_logs[][target_queue]	integer id (VoiceQueue)	*
data.phone_call_logs[][target_auto_attendant]	integer id (VoiceAutoAttendant)	*
data.date_created	DateTime	*
data.date_started	DateTime	*
data.date_waiting	DateTime	*
data.date_ended	DateTime	*
data.full_recording	object (VoiceRecording)	*
data.full_recording[id]	integer	*	The unique ID.
data.full_recording[duration]	integer	*
data.full_recording[blob]	object (Blob)	*
data.full_recording[blob][sys_name]	string	*	A unique system name for the blob.
data.full_recording[blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.full_recording[blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.full_recording[blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.full_recording[blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.full_recording[blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.full_recording[blob][file_url]	string	*	The HTTP link to download the file.
data.full_recording[blob][authcode]	string	*
data.full_recording[blob][blob_hash]	string	*
data.full_recording[blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.full_recording[blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.full_recording[blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.full_recording[blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.full_recording[blob][date_created]	DateTime	*
data.full_recording[blob][is_temp]	boolean	*
data.full_recording[blob][source_ref]	string	*
data.full_recording[blob][labels][]	array of objects (LabelBlob)	*
data.full_recording[blob][labels][][blob]	object (Blob)	*
data.full_recording[transcription]	string	*
data.full_recording[is_deleted]	boolean	*
data.full_recording[metadata]	array	*	Additional data attached to message (not implemented).
data.recordings[]	array of objects (VoiceRecording)	*
data.agent_voicemail_record	object (VoiceMissedAgentCall)	*
data.agent_voicemail_record[id]	integer	*	The unique ID.
data.agent_voicemail_record[duration]	integer	*
data.agent_voicemail_record[blob]	object (Blob)	*
data.agent_voicemail_record[blob][sys_name]	string	*	A unique system name for the blob.
data.agent_voicemail_record[blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.agent_voicemail_record[blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.agent_voicemail_record[blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.agent_voicemail_record[blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.agent_voicemail_record[blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.agent_voicemail_record[blob][file_url]	string	*	The HTTP link to download the file.
data.agent_voicemail_record[blob][authcode]	string	*
data.agent_voicemail_record[blob][blob_hash]	string	*
data.agent_voicemail_record[blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.agent_voicemail_record[blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.agent_voicemail_record[blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.agent_voicemail_record[blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.agent_voicemail_record[blob][date_created]	DateTime	*
data.agent_voicemail_record[blob][is_temp]	boolean	*
data.agent_voicemail_record[blob][source_ref]	string	*
data.agent_voicemail_record[blob][labels][]	array of objects (LabelBlob)	*
data.agent_voicemail_record[blob][labels][][blob]	object (Blob)	*
data.agent_voicemail_record[transcription]	string	*
data.agent_voicemail_record[is_deleted]	boolean	*
data.agent_voicemail_record[agent]	integer id (Person)	*
data.agent_voicemail_record[phone_call]	integer id (VoicePhoneCall)	*
data.agent_voicemail_record[data]	array	*
data.agent_voicemail_record[date_created]	DateTime	*
data.agent_voicemail_record[is_listened]	boolean	*
data.recording_enabled	boolean	*
data.cost	string	*
data.cost_currency	string	*
data.enqueued_as	string	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

DELETE /api/v2/voice_phone_calls/{phoneCall}/record

Delete phone call record

Documentation

Delete a call record from blob storage.

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_phone_calls.delete_phone_call_record

Requirements
Status Codes

Name	Requirement	Type	Description
phoneCall		VoicePhoneCall

Status Code	Description
204	Returned if everything is ok

GET /api/v2/voice_queues CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_queues.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (VoiceQueue)	*
data[][name]	string	*
data[][department]	object (Department)	*
data[][department][id]	integer	*
data[][department][parent]	object (Department)	*
data[][department][children][]	array of objects (Department)	*
data[][department][title]	string	*
data[][department][user_title]	string	*
data[][department][is_tickets_enabled]	boolean	*
data[][department][is_chat_enabled]	boolean	*
data[][department][display_order]	integer	*
data[][department][avatar]	object (Blob)	*
data[][department][avatar][sys_name]	string	*	A unique system name for the blob.
data[][department][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][department][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][department][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][department][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][department][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data[][department][avatar][file_url]	string	*	The HTTP link to download the file.
data[][department][avatar][authcode]	string	*
data[][department][avatar][blob_hash]	string	*
data[][department][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][department][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][department][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][department][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][department][avatar][date_created]	DateTime	*
data[][department][avatar][is_temp]	boolean	*
data[][department][avatar][source_ref]	string	*
data[][department][avatar][labels][]	array of objects (LabelBlob)	*
data[][department][avatar][labels][][blob]	object (Blob)	*
data[][department][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][department][brands][]	array of objects (Brand)	*
data[][department][brands][][id]	integer	*	The unique ID.
data[][department][brands][][name]	string	*	The brand name.
data[][department][brands][][slug]	string	*
data[][department][brands][][url]	string	*	The brand url.
data[][department][brands][][theme_set]	object (ThemeSet)	*
data[][department][brands][][theme_set][id]	integer	*
data[][department][brands][][theme_set][theme_id]	string	*
data[][department][brands][][theme_set][title]	string	*
data[][department][brands][][edit_theme_set]	object (ThemeSet)	*
data[][department][brands][][departments][]	array of objects (Department)	*
data[][department][brands][][theme_sets][]	array of objects (ThemeSet)	*
data[][department][permissions][]	array of objects (DepartmentPermission)	*
data[][department][permissions][][department]	integer id (Department)	*
data[][department][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][department][permissions][][name]	string	*	The name of the permission.
data[][department][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][department][permissions][][is_active]	boolean	*
data[][department][chat_queue]	object (UserChatQueue)	*
data[][department][chat_queue][id]	integer	*	The unique ID.
data[][department][chat_queue][name]	string	*
data[][department][chat_queue][routing_model]	string	*
data[][department][chat_queue][answer_timeout]	integer	*
data[][department][chat_queue][is_all_agents]	boolean	*
data[][department][chat_queue][departments][]	array of objects (Department)	*
data[][department][chat_queue][max_queue_size]	integer	*
data[][agents][]	array of objects (VoiceQueueAgent)	*
data[][agents][][agent]	integer id (Person)	*
data[][agents][][is_enabled]	boolean	*
data[][routingModel]		*
data[][greetAsset]		*
data[][loopAsset]		*
data[][voicemailAsset]		*
data[][voicemailDepartment]		*
data[][voicemailAgent]		*
data[][voicemailDisabledAsset]		*
data[][answerTimeout]		*
data[][voicemailTimeout]		*
data[][maxQueueSize]		*
data[][id]	integer	*	The unique ID.
data[][brand]	object (Brand)	*
data[][brand][id]	integer	*	The unique ID.
data[][brand][name]	string	*	The brand name.
data[][brand][slug]	string	*
data[][brand][url]	string	*	The brand url.
data[][brand][theme_set]	object (ThemeSet)	*
data[][brand][theme_set][id]	integer	*
data[][brand][theme_set][theme_id]	string	*
data[][brand][theme_set][title]	string	*
data[][brand][edit_theme_set]	object (ThemeSet)	*
data[][brand][departments][]	array of objects (Department)	*
data[][brand][theme_sets][]	array of objects (ThemeSet)	*
data[][routing_model]	string	*
data[][voicemail_department]	object (Department)	*
data[][voicemail_agent]	object (Person)	*
data[][voicemail_agent_team]	object (AgentTeam)	*
data[][voicemail_agent_team][id]	integer	*	The unique ID.
data[][voicemail_agent_team][name]	string	*	The name of agent team.
data[][voicemail_agent_team][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][voicemail_disabled]	boolean	*
data[][answer_timeout]	integer	*
data[][voicemail_timeout]	integer	*
data[][max_queue_size]	integer	*
data[][recording_enabled]	boolean	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/voice_queues CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_queues.post

Parameters
Response
Status Codes

Parameter	Type	Required?	Format
name	string	true
department	choice	false
brand	choice	false
agents[][agent]	choice	true
agents[][is_enabled]	boolean	true
greet_asset	string	false
loop_asset	string	false
voicemail_asset	string	false
voicemail_department	choice	false
voicemail_agent	choice	false
voicemail_agent_team	choice	false
voicemail_timeout	integer	false
voicemail_disabled	boolean	false
voicemail_disabled_asset	string	false
routing_model	choice	true	["round_robin","least_utilized","simulring"]
answer_timeout	integer	true
max_queue_size	integer	true
recording_enabled	boolean	false

Parameter	Type	Versions	Description
data.name	string	*
data.department	object (Department)	*
data.department[id]	integer	*
data.department[parent]	object (Department)	*
data.department[children][]	array of objects (Department)	*
data.department[title]	string	*
data.department[user_title]	string	*
data.department[is_tickets_enabled]	boolean	*
data.department[is_chat_enabled]	boolean	*
data.department[display_order]	integer	*
data.department[avatar]	object (Blob)	*
data.department[avatar][sys_name]	string	*	A unique system name for the blob.
data.department[avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.department[avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.department[avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.department[avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.department[avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.department[avatar][file_url]	string	*	The HTTP link to download the file.
data.department[avatar][authcode]	string	*
data.department[avatar][blob_hash]	string	*
data.department[avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.department[avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.department[avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.department[avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.department[avatar][date_created]	DateTime	*
data.department[avatar][is_temp]	boolean	*
data.department[avatar][source_ref]	string	*
data.department[avatar][labels][]	array of objects (LabelBlob)	*
data.department[avatar][labels][][blob]	object (Blob)	*
data.department[avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.department[brands][]	array of objects (Brand)	*
data.department[brands][][id]	integer	*	The unique ID.
data.department[brands][][name]	string	*	The brand name.
data.department[brands][][slug]	string	*
data.department[brands][][url]	string	*	The brand url.
data.department[brands][][theme_set]	object (ThemeSet)	*
data.department[brands][][theme_set][id]	integer	*
data.department[brands][][theme_set][theme_id]	string	*
data.department[brands][][theme_set][title]	string	*
data.department[brands][][theme_set][options]		*
data.department[brands][][edit_theme_set]	object (ThemeSet)	*
data.department[brands][][departments][]	array of objects (Department)	*
data.department[brands][][theme_sets][]	array of objects (ThemeSet)	*
data.department[permissions][]	array of objects (DepartmentPermission)	*
data.department[permissions][][department]	integer id (Department)	*
data.department[permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.department[permissions][][name]	string	*	The name of the permission.
data.department[permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.department[permissions][][is_active]	boolean	*
data.department[chat_queue]	object (UserChatQueue)	*
data.department[chat_queue][id]	integer	*	The unique ID.
data.department[chat_queue][name]	string	*
data.department[chat_queue][routing_model]	string	*
data.department[chat_queue][answer_timeout]	integer	*
data.department[chat_queue][is_all_agents]	boolean	*
data.department[chat_queue][departments][]	array of objects (Department)	*
data.department[chat_queue][max_queue_size]	integer	*
data.department[chat_queue][routingModel]		*
data.agents[]	array of objects (VoiceQueueAgent)	*
data.agents[][agent]	integer id (Person)	*
data.agents[][is_enabled]	boolean	*
data.agents[][queue]		*
data.routingModel		*
data.greetAsset		*
data.loopAsset		*
data.voicemailAsset		*
data.voicemailDepartment		*
data.voicemailAgent		*
data.voicemailDisabledAsset		*
data.answerTimeout		*
data.voicemailTimeout		*
data.maxQueueSize		*
data.id	integer	*	The unique ID.
data.brand	object (Brand)	*
data.brand[id]	integer	*	The unique ID.
data.brand[name]	string	*	The brand name.
data.brand[slug]	string	*
data.brand[url]	string	*	The brand url.
data.brand[theme_set]	object (ThemeSet)	*
data.brand[theme_set][id]	integer	*
data.brand[theme_set][theme_id]	string	*
data.brand[theme_set][title]	string	*
data.brand[theme_set][options]		*
data.brand[edit_theme_set]	object (ThemeSet)	*
data.brand[departments][]	array of objects (Department)	*
data.brand[theme_sets][]	array of objects (ThemeSet)	*
data.routing_model	string	*
data.voicemail_department	object (Department)	*
data.voicemail_agent	object (Person)	*
data.voicemail_agent[emails]		*
data.voicemail_agent[labels]		*
data.voicemail_agent[teams]		*
data.voicemail_agent[primary_team]		*
data.voicemail_agent[agentData]		*
data.voicemail_agent[publicUsergroups]		*
data.voicemail_agent[publicAgentgroups]		*
data.voicemail_agent_team	object (AgentTeam)	*
data.voicemail_agent_team[id]	integer	*	The unique ID.
data.voicemail_agent_team[name]	string	*	The name of agent team.
data.voicemail_agent_team[avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.voicemail_agent_team[members]		*
data.voicemail_disabled	boolean	*
data.answer_timeout	integer	*
data.voicemail_timeout	integer	*
data.max_queue_size	integer	*
data.recording_enabled	boolean	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

GET /api/v2/voice_queues/average_waiting_time

Get average waiting time for each voice queue

GET /api/v2/voice_queues/counts CRUD

Count list

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_queues.count

Response
Status Codes

Parameter	Type	Versions	Description
data.count	integer	*	Count itself.
data.id	integer	>=20170401	Entity identity.
data.value	string	>=20170401	Entity value.
data.type	string	*	Count type.
data.title	string	*	Count title.
data.grouped_by	string	*	Grouping option.
data.nested[]	array of objects (Count)	*	Nested counts.
data.nested[][count]	integer	*	Count itself.
data.nested[][id]	integer	>=20170401	Entity identity.
data.nested[][value]	string	>=20170401	Entity value.
data.nested[][type]	string	*	Count type.
data.nested[][title]	string	*	Count title.
data.nested[][grouped_by]	string	*	Grouping option.
data.nested[][nested][]	array of objects (Count)	*	Nested counts.

Status Code	Description
200	Returned if successful request
400	Returned if you filter set was malformed

DELETE /api/v2/voice_queues/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_queues.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/voice_queues/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_queues.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.name	string	*
data.department	object (Department)	*
data.department[id]	integer	*
data.department[parent]	object (Department)	*
data.department[children][]	array of objects (Department)	*
data.department[title]	string	*
data.department[user_title]	string	*
data.department[is_tickets_enabled]	boolean	*
data.department[is_chat_enabled]	boolean	*
data.department[display_order]	integer	*
data.department[avatar]	object (Blob)	*
data.department[avatar][sys_name]	string	*	A unique system name for the blob.
data.department[avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.department[avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.department[avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.department[avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.department[avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.department[avatar][file_url]	string	*	The HTTP link to download the file.
data.department[avatar][authcode]	string	*
data.department[avatar][blob_hash]	string	*
data.department[avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.department[avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.department[avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.department[avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.department[avatar][date_created]	DateTime	*
data.department[avatar][is_temp]	boolean	*
data.department[avatar][source_ref]	string	*
data.department[avatar][labels][]	array of objects (LabelBlob)	*
data.department[avatar][labels][][blob]	object (Blob)	*
data.department[avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.department[brands][]	array of objects (Brand)	*
data.department[brands][][id]	integer	*	The unique ID.
data.department[brands][][name]	string	*	The brand name.
data.department[brands][][slug]	string	*
data.department[brands][][url]	string	*	The brand url.
data.department[brands][][theme_set]	object (ThemeSet)	*
data.department[brands][][theme_set][id]	integer	*
data.department[brands][][theme_set][theme_id]	string	*
data.department[brands][][theme_set][title]	string	*
data.department[brands][][theme_set][options]		*
data.department[brands][][edit_theme_set]	object (ThemeSet)	*
data.department[brands][][departments][]	array of objects (Department)	*
data.department[brands][][theme_sets][]	array of objects (ThemeSet)	*
data.department[permissions][]	array of objects (DepartmentPermission)	*
data.department[permissions][][department]	integer id (Department)	*
data.department[permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.department[permissions][][name]	string	*	The name of the permission.
data.department[permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.department[permissions][][is_active]	boolean	*
data.department[chat_queue]	object (UserChatQueue)	*
data.department[chat_queue][id]	integer	*	The unique ID.
data.department[chat_queue][name]	string	*
data.department[chat_queue][routing_model]	string	*
data.department[chat_queue][answer_timeout]	integer	*
data.department[chat_queue][is_all_agents]	boolean	*
data.department[chat_queue][departments][]	array of objects (Department)	*
data.department[chat_queue][max_queue_size]	integer	*
data.department[chat_queue][routingModel]		*
data.agents[]	array of objects (VoiceQueueAgent)	*
data.agents[][agent]	integer id (Person)	*
data.agents[][is_enabled]	boolean	*
data.agents[][queue]		*
data.routingModel		*
data.greetAsset		*
data.loopAsset		*
data.voicemailAsset		*
data.voicemailDepartment		*
data.voicemailAgent		*
data.voicemailDisabledAsset		*
data.answerTimeout		*
data.voicemailTimeout		*
data.maxQueueSize		*
data.id	integer	*	The unique ID.
data.brand	object (Brand)	*
data.brand[id]	integer	*	The unique ID.
data.brand[name]	string	*	The brand name.
data.brand[slug]	string	*
data.brand[url]	string	*	The brand url.
data.brand[theme_set]	object (ThemeSet)	*
data.brand[theme_set][id]	integer	*
data.brand[theme_set][theme_id]	string	*
data.brand[theme_set][title]	string	*
data.brand[theme_set][options]		*
data.brand[edit_theme_set]	object (ThemeSet)	*
data.brand[departments][]	array of objects (Department)	*
data.brand[theme_sets][]	array of objects (ThemeSet)	*
data.routing_model	string	*
data.voicemail_department	object (Department)	*
data.voicemail_agent	object (Person)	*
data.voicemail_agent[emails]		*
data.voicemail_agent[labels]		*
data.voicemail_agent[teams]		*
data.voicemail_agent[primary_team]		*
data.voicemail_agent[agentData]		*
data.voicemail_agent[publicUsergroups]		*
data.voicemail_agent[publicAgentgroups]		*
data.voicemail_agent_team	object (AgentTeam)	*
data.voicemail_agent_team[id]	integer	*	The unique ID.
data.voicemail_agent_team[name]	string	*	The name of agent team.
data.voicemail_agent_team[avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.voicemail_agent_team[members]		*
data.voicemail_disabled	boolean	*
data.answer_timeout	integer	*
data.voicemail_timeout	integer	*
data.max_queue_size	integer	*
data.recording_enabled	boolean	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/voice_queues/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_queues.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format
name	string	false
department	choice	false
brand	choice	false
agents[][agent]	choice	false
agents[][is_enabled]	boolean	false
greet_asset	string	false
loop_asset	string	false
voicemail_asset	string	false
voicemail_department	choice	false
voicemail_agent	choice	false
voicemail_agent_team	choice	false
voicemail_timeout	integer	false
voicemail_disabled	boolean	false
voicemail_disabled_asset	string	false
routing_model	choice	false	["round_robin","least_utilized","simulring"]
answer_timeout	integer	false
max_queue_size	integer	false
recording_enabled	boolean	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

PUT /api/v2/voice_queues/{queue}/toggle_agent

Toggle agent in voice queue list

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_queues.toggle_agent

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
queue		VoiceQueue

Parameter	Type	Required?	Format	Description
	boolean	false		is enabled

Status Code	Description
204	Returned if everything is ok

GET /api/v2/voice_settings

Global voice settings

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_settings.get_settings

Response
Status Codes

Parameter	Type	Versions
data.private_accounts_enabled	boolean	*
data.agent_voicemail_timeout	integer	*
data.agent_recording_enabled	boolean	*
data.agent_outgoing_recording_enabled	boolean	*
data.agent_default_department	integer	*
data.agent_default_brand	integer	*
data.group_missed_call_tickets	boolean	*
data.group_missed_call_tickets_timeout	string	*
data.forwarding_machine_detection	boolean	*
data.forwarding_number_type	string	*
data.forwarding_number	integer	*
data.transcribe_voicemail	boolean	*
data.email_attach_recording	boolean	*
data.email_attach_transcription	boolean	*

Status Code	Description
200	Returned if everything is ok

PUT /api/v2/voice_settings

Global voice settings

Applicable api modes

session token key oauth

Api tags for this endpoint

voice.voice_settings.update_settings

Parameters
Status Codes

Parameter	Type	Required?	Format
agent_voicemail_timeout	integer	false
agent_recording_enabled	boolean	false
agent_default_department	choice	false
agent_default_brand	choice	false
group_missed_call_tickets	boolean	false
group_missed_call_tickets_timeout	string	false
forwarding_machine_detection	boolean	false
transcribe_voicemail	boolean	false
email_attach_recording	boolean	false
email_attach_transcription	boolean	false
forwarding_number_type	choice	false	["default","specific"]
forwarding_number	choice	false

Status Code	Description
204	Returned if everything is ok

Show/hide List Operations Expand Operations

Webhooks

GET /api/v2/webhooks/tickets CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

webhooks.ticket_webhook.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (TicketWebhook)	*
data[][id]	integer	*
data[][auth_id]	string	*	The URL slug, a string of random uppercase characters.
data[][title]	string	*	A title / description the admin gives it.
data[][payload_decoder]	string	*	Payload decoding strategy.
data[][is_enabled]	boolean	*	True for the webhook is enabled or not.
data[][search_terms]	array	*
data[][triggers][]	array of integer ids (TicketTrigger)	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/webhooks/tickets CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

webhooks.ticket_webhook.post

Parameters
Response
Status Codes

Parameter	Type	Required?	Format	Description
	array of integer ids (TicketTrigger)	false

Parameter	Type	Versions	Description
data.id	integer	*
data.auth_id	string	*	The URL slug, a string of random uppercase characters.
data.title	string	*	A title / description the admin gives it.
data.payload_decoder	string	*	Payload decoding strategy.
data.is_enabled	boolean	*	True for the webhook is enabled or not.
data.search_terms	array	*
data.triggers[]	array of integer ids (TicketTrigger)	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

DELETE /api/v2/webhooks/tickets/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

webhooks.ticket_webhook.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/webhooks/tickets/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

webhooks.ticket_webhook.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.id	integer	*
data.auth_id	string	*	The URL slug, a string of random uppercase characters.
data.title	string	*	A title / description the admin gives it.
data.payload_decoder	string	*	Payload decoding strategy.
data.is_enabled	boolean	*	True for the webhook is enabled or not.
data.search_terms	array	*
data.triggers[]	array of integer ids (TicketTrigger)	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/webhooks/tickets/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

webhooks.ticket_webhook.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format	Description
	array of integer ids (TicketTrigger)	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

GET /api/v2/webhooks/triggers CRUD

Get collection of resources

Applicable api modes

session token key oauth

Api tags for this endpoint

webhooks.trigger.list

Filters
Response
Status Codes

Name

Information

page

Pattern	\d
Description	Which page to display
Datatype	integer

count

Pattern	\d
Description	Resource per page count
Datatype	integer

limit

Pattern	\d
Description	Max number of resources to return
Datatype	integer

ids

Pattern	[\d,]+
Description	Comma separated list of IDs
Datatype	string

Parameter	Type	Versions	Description
data[]	array of objects (TicketTrigger)	*
data[][id]	integer	*	The unique ID.
data[][department]	object (Department)	*
data[][department][id]	integer	*
data[][department][parent]	object (Department)	*
data[][department][children][]	array of objects (Department)	*
data[][department][title]	string	*
data[][department][user_title]	string	*
data[][department][is_tickets_enabled]	boolean	*
data[][department][is_chat_enabled]	boolean	*
data[][department][display_order]	integer	*
data[][department][avatar]	object (Blob)	*
data[][department][avatar][sys_name]	string	*	A unique system name for the blob.
data[][department][avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][department][avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][department][avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][department][avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][department][avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data[][department][avatar][file_url]	string	*	The HTTP link to download the file.
data[][department][avatar][authcode]	string	*
data[][department][avatar][blob_hash]	string	*
data[][department][avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][department][avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][department][avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][department][avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][department][avatar][date_created]	DateTime	*
data[][department][avatar][is_temp]	boolean	*
data[][department][avatar][source_ref]	string	*
data[][department][avatar][labels][]	array of objects (LabelBlob)	*
data[][department][avatar][labels][][blob]	object (Blob)	*
data[][department][avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data[][department][brands][]	array of objects (Brand)	*
data[][department][brands][][id]	integer	*	The unique ID.
data[][department][brands][][name]	string	*	The brand name.
data[][department][brands][][slug]	string	*
data[][department][brands][][url]	string	*	The brand url.
data[][department][brands][][theme_set]	object (ThemeSet)	*
data[][department][brands][][theme_set][id]	integer	*
data[][department][brands][][theme_set][theme_id]	string	*
data[][department][brands][][theme_set][title]	string	*
data[][department][brands][][edit_theme_set]	object (ThemeSet)	*
data[][department][brands][][departments][]	array of objects (Department)	*
data[][department][brands][][theme_sets][]	array of objects (ThemeSet)	*
data[][department][permissions][]	array of objects (DepartmentPermission)	*
data[][department][permissions][][department]	integer id (Department)	*
data[][department][permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data[][department][permissions][][name]	string	*	The name of the permission.
data[][department][permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data[][department][permissions][][is_active]	boolean	*
data[][department][chat_queue]	object (UserChatQueue)	*
data[][department][chat_queue][id]	integer	*	The unique ID.
data[][department][chat_queue][name]	string	*
data[][department][chat_queue][routing_model]	string	*
data[][department][chat_queue][answer_timeout]	integer	*
data[][department][chat_queue][is_all_agents]	boolean	*
data[][department][chat_queue][departments][]	array of objects (Department)	*
data[][department][chat_queue][max_queue_size]	integer	*
data[][email_account]	object (EmailAccount)	*
data[][email_account][id]	integer	*
data[][email_account][account_type]	string	*
data[][email_account][is_enabled]	boolean	*
data[][email_account][address]	string	*
data[][email_account][cert_blob]	object (Blob)	*
data[][email_account][cert_blob][sys_name]	string	*	A unique system name for the blob.
data[][email_account][cert_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data[][email_account][cert_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data[][email_account][cert_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data[][email_account][cert_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data[][email_account][cert_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data[][email_account][cert_blob][file_url]	string	*	The HTTP link to download the file.
data[][email_account][cert_blob][authcode]	string	*
data[][email_account][cert_blob][blob_hash]	string	*
data[][email_account][cert_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data[][email_account][cert_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data[][email_account][cert_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data[][email_account][cert_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data[][email_account][cert_blob][date_created]	DateTime	*
data[][email_account][cert_blob][is_temp]	boolean	*
data[][email_account][cert_blob][source_ref]	string	*
data[][email_account][cert_blob][labels][]	array of objects (LabelBlob)	*
data[][email_account][cert_blob][labels][][blob]	object (Blob)	*
data[][email_account][key_blob]	object (Blob)	*
data[][title]	string	*
data[][is_enabled]	boolean	*
data[][is_hidden]	boolean	*
data[][is_editable]	boolean	*
data[][sys_name]	string	*
data[][event_trigger]	string	*
data[][event_flags][]	array of strings	*
data[][by_agent_mode][]	array of strings	*
data[][by_user_mode][]	array of strings	*
data[][by_app_mode][]	array of strings	*
data[][run_order]	integer	*

Status Code	Description
200	Returned if your request was successful
400	An error will occur if you provide wrong filters set

POST /api/v2/webhooks/triggers CRUD

Create a new resource

Applicable api modes

session token key oauth

Api tags for this endpoint

webhooks.trigger.post

Parameters
Response
Status Codes

Parameter	Type	Required?	Format	Description
	integer	false
id	integer	false
parent	object (Department)	false
children[]	array of objects (Department)	false
title	string	true	{not blank}
user_title	string	false
is_tickets_enabled	boolean	false
is_chat_enabled	boolean	false
display_order	integer	false
avatar[sys_name]	string	false		A unique system name for the blob.
avatar[original_blob]	object (Blob)	false		Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
avatar[storage_loc]	string	false		The storage adapter that knows how to load this file.
avatar[storage_loc_pref]	string	false		The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
avatar[storage_loc_specific]	string	false		A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
avatar[save_path]	string	false		The path to the file if it's not stored in the database.
avatar[file_url]	string	false		The HTTP link to download the file.
avatar[authcode]	string	true	{not blank}
avatar[blob_hash]	string	false
avatar[is_media_upload]	boolean	false		Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
avatar[title]	string	false		The title of this file used in interfaces if its a media upload.
avatar[dim_w]	integer	false		If this type of file has dimentions, the width.
avatar[dim_h]	integer	false		If this type of file has dimentions, the height.
avatar[date_created]	DateTime	false
avatar[is_temp]	boolean	false
avatar[source_ref]	string	false
avatar[labels][][blob]	object (Blob)	false
avatar_urn	string	false		Avatar urn, used to store emoji avatar
brands[][id]	integer	false		The unique ID.
brands[][name]	string	false		The brand name.
brands[][slug]	string	false
brands[][url]	string	false		The brand url.
brands[][theme_set][id]	integer	false
brands[][theme_set][theme_id]	string	true
brands[][theme_set][title]	string	true
brands[][theme_set][options]		true
brands[][edit_theme_set]	object (ThemeSet)	false
brands[][departments][]	array of objects (Department)	false
brands[][theme_sets][]	array of objects (ThemeSet)	false
permissions[][department]	integer id (Department)	false
permissions[][app]	string	false		Application name. It's going to be either chat or tickets.
permissions[][name]	string	false		The name of the permission.
permissions[][value]	integer	false		Any numeric number (ex filesize, flag).
permissions[][is_active]	boolean	false
chat_queue[id]	integer	false		The unique ID.
chat_queue[name]	string	true	{not blank}
chat_queue[routing_model]	string	false
chat_queue[answer_timeout]	integer	false
chat_queue[is_all_agents]	boolean	false
chat_queue[departments][]	array of objects (Department)	false
chat_queue[max_queue_size]	integer	false
chat_queue[routingModel]		true	{not blank}
account_type	string	false
is_enabled	boolean	false
address	string	false
cert_blob[sys_name]	string	false		A unique system name for the blob.
cert_blob[original_blob]	object (Blob)	false		Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
cert_blob[storage_loc]	string	false		The storage adapter that knows how to load this file.
cert_blob[storage_loc_pref]	string	false		The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
cert_blob[storage_loc_specific]	string	false		A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
cert_blob[save_path]	string	false		The path to the file if it's not stored in the database.
cert_blob[file_url]	string	false		The HTTP link to download the file.
cert_blob[authcode]	string	true	{not blank}
cert_blob[blob_hash]	string	false
cert_blob[is_media_upload]	boolean	false		Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
cert_blob[title]	string	false		The title of this file used in interfaces if its a media upload.
cert_blob[dim_w]	integer	false		If this type of file has dimentions, the width.
cert_blob[dim_h]	integer	false		If this type of file has dimentions, the height.
cert_blob[date_created]	DateTime	false
cert_blob[is_temp]	boolean	false
cert_blob[source_ref]	string	false
cert_blob[labels][][blob]	object (Blob)	false
key_blob	object (Blob)	false

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.department	object (Department)	*
data.department[id]	integer	*
data.department[parent]	object (Department)	*
data.department[children][]	array of objects (Department)	*
data.department[title]	string	*
data.department[user_title]	string	*
data.department[is_tickets_enabled]	boolean	*
data.department[is_chat_enabled]	boolean	*
data.department[display_order]	integer	*
data.department[avatar]	object (Blob)	*
data.department[avatar][sys_name]	string	*	A unique system name for the blob.
data.department[avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.department[avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.department[avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.department[avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.department[avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.department[avatar][file_url]	string	*	The HTTP link to download the file.
data.department[avatar][authcode]	string	*
data.department[avatar][blob_hash]	string	*
data.department[avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.department[avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.department[avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.department[avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.department[avatar][date_created]	DateTime	*
data.department[avatar][is_temp]	boolean	*
data.department[avatar][source_ref]	string	*
data.department[avatar][labels][]	array of objects (LabelBlob)	*
data.department[avatar][labels][][blob]	object (Blob)	*
data.department[avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.department[brands][]	array of objects (Brand)	*
data.department[brands][][id]	integer	*	The unique ID.
data.department[brands][][name]	string	*	The brand name.
data.department[brands][][slug]	string	*
data.department[brands][][url]	string	*	The brand url.
data.department[brands][][theme_set]	object (ThemeSet)	*
data.department[brands][][theme_set][id]	integer	*
data.department[brands][][theme_set][theme_id]	string	*
data.department[brands][][theme_set][title]	string	*
data.department[brands][][theme_set][options]		*
data.department[brands][][edit_theme_set]	object (ThemeSet)	*
data.department[brands][][departments][]	array of objects (Department)	*
data.department[brands][][theme_sets][]	array of objects (ThemeSet)	*
data.department[permissions][]	array of objects (DepartmentPermission)	*
data.department[permissions][][department]	integer id (Department)	*
data.department[permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.department[permissions][][name]	string	*	The name of the permission.
data.department[permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.department[permissions][][is_active]	boolean	*
data.department[chat_queue]	object (UserChatQueue)	*
data.department[chat_queue][id]	integer	*	The unique ID.
data.department[chat_queue][name]	string	*
data.department[chat_queue][routing_model]	string	*
data.department[chat_queue][answer_timeout]	integer	*
data.department[chat_queue][is_all_agents]	boolean	*
data.department[chat_queue][departments][]	array of objects (Department)	*
data.department[chat_queue][max_queue_size]	integer	*
data.department[chat_queue][routingModel]		*
data.email_account	object (EmailAccount)	*
data.email_account[id]	integer	*
data.email_account[account_type]	string	*
data.email_account[is_enabled]	boolean	*
data.email_account[address]	string	*
data.email_account[cert_blob]	object (Blob)	*
data.email_account[cert_blob][sys_name]	string	*	A unique system name for the blob.
data.email_account[cert_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.email_account[cert_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.email_account[cert_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.email_account[cert_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.email_account[cert_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.email_account[cert_blob][file_url]	string	*	The HTTP link to download the file.
data.email_account[cert_blob][authcode]	string	*
data.email_account[cert_blob][blob_hash]	string	*
data.email_account[cert_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.email_account[cert_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.email_account[cert_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.email_account[cert_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.email_account[cert_blob][date_created]	DateTime	*
data.email_account[cert_blob][is_temp]	boolean	*
data.email_account[cert_blob][source_ref]	string	*
data.email_account[cert_blob][labels][]	array of objects (LabelBlob)	*
data.email_account[cert_blob][labels][][blob]	object (Blob)	*
data.email_account[key_blob]	object (Blob)	*
data.title	string	*
data.is_enabled	boolean	*
data.is_hidden	boolean	*
data.is_editable	boolean	*
data.sys_name	string	*
data.event_trigger	string	*
data.event_flags[]	array of strings	*
data.by_agent_mode[]	array of strings	*
data.by_user_mode[]	array of strings	*
data.by_app_mode[]	array of strings	*
data.run_order	integer	*

Status Code	Description
201	Returned in case of successful resource creation
400	We will return this in case your request was malformed

DELETE /api/v2/webhooks/triggers/{id} CRUD

Delete a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

webhooks.trigger.delete

Requirements
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Status Code	Description
200	Returned if everything is ok and there is no such resource anymore
404	Well, looks like either resource already deleted either it doesn't exists at all

GET /api/v2/webhooks/triggers/{id} CRUD

Get a resource

Applicable api modes

session token key oauth

Api tags for this endpoint

webhooks.trigger.get

Requirements
Response
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Versions	Description
data.id	integer	*	The unique ID.
data.department	object (Department)	*
data.department[id]	integer	*
data.department[parent]	object (Department)	*
data.department[children][]	array of objects (Department)	*
data.department[title]	string	*
data.department[user_title]	string	*
data.department[is_tickets_enabled]	boolean	*
data.department[is_chat_enabled]	boolean	*
data.department[display_order]	integer	*
data.department[avatar]	object (Blob)	*
data.department[avatar][sys_name]	string	*	A unique system name for the blob.
data.department[avatar][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.department[avatar][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.department[avatar][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.department[avatar][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.department[avatar][save_path]	string	*	The path to the file if it's not stored in the database.
data.department[avatar][file_url]	string	*	The HTTP link to download the file.
data.department[avatar][authcode]	string	*
data.department[avatar][blob_hash]	string	*
data.department[avatar][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.department[avatar][title]	string	*	The title of this file used in interfaces if its a media upload.
data.department[avatar][dim_w]	integer	*	If this type of file has dimentions, the width.
data.department[avatar][dim_h]	integer	*	If this type of file has dimentions, the height.
data.department[avatar][date_created]	DateTime	*
data.department[avatar][is_temp]	boolean	*
data.department[avatar][source_ref]	string	*
data.department[avatar][labels][]	array of objects (LabelBlob)	*
data.department[avatar][labels][][blob]	object (Blob)	*
data.department[avatar_urn]	string	*	Avatar urn, used to store emoji avatar
data.department[brands][]	array of objects (Brand)	*
data.department[brands][][id]	integer	*	The unique ID.
data.department[brands][][name]	string	*	The brand name.
data.department[brands][][slug]	string	*
data.department[brands][][url]	string	*	The brand url.
data.department[brands][][theme_set]	object (ThemeSet)	*
data.department[brands][][theme_set][id]	integer	*
data.department[brands][][theme_set][theme_id]	string	*
data.department[brands][][theme_set][title]	string	*
data.department[brands][][theme_set][options]		*
data.department[brands][][edit_theme_set]	object (ThemeSet)	*
data.department[brands][][departments][]	array of objects (Department)	*
data.department[brands][][theme_sets][]	array of objects (ThemeSet)	*
data.department[permissions][]	array of objects (DepartmentPermission)	*
data.department[permissions][][department]	integer id (Department)	*
data.department[permissions][][app]	string	*	Application name. It's going to be either chat or tickets.
data.department[permissions][][name]	string	*	The name of the permission.
data.department[permissions][][value]	integer	*	Any numeric number (ex filesize, flag).
data.department[permissions][][is_active]	boolean	*
data.department[chat_queue]	object (UserChatQueue)	*
data.department[chat_queue][id]	integer	*	The unique ID.
data.department[chat_queue][name]	string	*
data.department[chat_queue][routing_model]	string	*
data.department[chat_queue][answer_timeout]	integer	*
data.department[chat_queue][is_all_agents]	boolean	*
data.department[chat_queue][departments][]	array of objects (Department)	*
data.department[chat_queue][max_queue_size]	integer	*
data.department[chat_queue][routingModel]		*
data.email_account	object (EmailAccount)	*
data.email_account[id]	integer	*
data.email_account[account_type]	string	*
data.email_account[is_enabled]	boolean	*
data.email_account[address]	string	*
data.email_account[cert_blob]	object (Blob)	*
data.email_account[cert_blob][sys_name]	string	*	A unique system name for the blob.
data.email_account[cert_blob][original_blob]	object (Blob)	*	Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
data.email_account[cert_blob][storage_loc]	string	*	The storage adapter that knows how to load this file.
data.email_account[cert_blob][storage_loc_pref]	string	*	The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
data.email_account[cert_blob][storage_loc_specific]	string	*	A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
data.email_account[cert_blob][save_path]	string	*	The path to the file if it's not stored in the database.
data.email_account[cert_blob][file_url]	string	*	The HTTP link to download the file.
data.email_account[cert_blob][authcode]	string	*
data.email_account[cert_blob][blob_hash]	string	*
data.email_account[cert_blob][is_media_upload]	boolean	*	Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
data.email_account[cert_blob][title]	string	*	The title of this file used in interfaces if its a media upload.
data.email_account[cert_blob][dim_w]	integer	*	If this type of file has dimentions, the width.
data.email_account[cert_blob][dim_h]	integer	*	If this type of file has dimentions, the height.
data.email_account[cert_blob][date_created]	DateTime	*
data.email_account[cert_blob][is_temp]	boolean	*
data.email_account[cert_blob][source_ref]	string	*
data.email_account[cert_blob][labels][]	array of objects (LabelBlob)	*
data.email_account[cert_blob][labels][][blob]	object (Blob)	*
data.email_account[key_blob]	object (Blob)	*
data.title	string	*
data.is_enabled	boolean	*
data.is_hidden	boolean	*
data.is_editable	boolean	*
data.sys_name	string	*
data.event_trigger	string	*
data.event_flags[]	array of strings	*
data.by_agent_mode[]	array of strings	*
data.by_user_mode[]	array of strings	*
data.by_app_mode[]	array of strings	*
data.run_order	integer	*

Status Code	Description
200	We will return such status in case we found your entity
404	Not Found error will returned in case we can't find entity with specified ID

PUT /api/v2/webhooks/triggers/{id} CRUD

Update an existing resource

Applicable api modes

session token key oauth

Api tags for this endpoint

webhooks.trigger.put

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
id	\d+	integer	The id of the resource

Parameter	Type	Required?	Format	Description
	integer	false
id	integer	false
parent	object (Department)	false
children[]	array of objects (Department)	false
title	string	true	{not blank}
user_title	string	false
is_tickets_enabled	boolean	false
is_chat_enabled	boolean	false
display_order	integer	false
avatar[sys_name]	string	false		A unique system name for the blob.
avatar[original_blob]	object (Blob)	false		Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
avatar[storage_loc]	string	false		The storage adapter that knows how to load this file.
avatar[storage_loc_pref]	string	false		The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
avatar[storage_loc_specific]	string	false		A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
avatar[save_path]	string	false		The path to the file if it's not stored in the database.
avatar[file_url]	string	false		The HTTP link to download the file.
avatar[authcode]	string	true	{not blank}
avatar[blob_hash]	string	false
avatar[is_media_upload]	boolean	false		Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
avatar[title]	string	false		The title of this file used in interfaces if its a media upload.
avatar[dim_w]	integer	false		If this type of file has dimentions, the width.
avatar[dim_h]	integer	false		If this type of file has dimentions, the height.
avatar[date_created]	DateTime	false
avatar[is_temp]	boolean	false
avatar[source_ref]	string	false
avatar[labels][][blob]	object (Blob)	false
avatar_urn	string	false		Avatar urn, used to store emoji avatar
brands[][id]	integer	false		The unique ID.
brands[][name]	string	false		The brand name.
brands[][slug]	string	false
brands[][url]	string	false		The brand url.
brands[][theme_set][id]	integer	false
brands[][theme_set][theme_id]	string	true
brands[][theme_set][title]	string	true
brands[][theme_set][options]		true
brands[][edit_theme_set]	object (ThemeSet)	false
brands[][departments][]	array of objects (Department)	false
brands[][theme_sets][]	array of objects (ThemeSet)	false
permissions[][department]	integer id (Department)	false
permissions[][app]	string	false		Application name. It's going to be either chat or tickets.
permissions[][name]	string	false		The name of the permission.
permissions[][value]	integer	false		Any numeric number (ex filesize, flag).
permissions[][is_active]	boolean	false
chat_queue[id]	integer	false		The unique ID.
chat_queue[name]	string	true	{not blank}
chat_queue[routing_model]	string	false
chat_queue[answer_timeout]	integer	false
chat_queue[is_all_agents]	boolean	false
chat_queue[departments][]	array of objects (Department)	false
chat_queue[max_queue_size]	integer	false
chat_queue[routingModel]		true	{not blank}
account_type	string	false
is_enabled	boolean	false
address	string	false
cert_blob[sys_name]	string	false		A unique system name for the blob.
cert_blob[original_blob]	object (Blob)	false		Sometimes we might have multiple versions of a file. For example, if a file has been cropped then the cropped file is saved as its own blob, but the original is linked here.
cert_blob[storage_loc]	string	false		The storage adapter that knows how to load this file.
cert_blob[storage_loc_pref]	string	false		The preferred storage adapter. This is used to mark when we want to move a file from one storage location to another. For example, if an upload to S3 failed and we saved the file in the database instead, then the $storage_loc would be 'db' but $storage_loc_pref would be 's3'. The cron jobs will look for when these two values don't match and will attempt to move resources gradually.
cert_blob[storage_loc_specific]	string	false		A set storage adapter. This is used to 'set' a storage adapter that will be used even if the system would normally use a different one. The main usage for this is to store things like logfiles in the database instead of something like s3. DeskPRO saves lots of logfiles, so its pretty inefficient to send off lots of small logfiles to s3.
cert_blob[save_path]	string	false		The path to the file if it's not stored in the database.
cert_blob[file_url]	string	false		The HTTP link to download the file.
cert_blob[authcode]	string	true	{not blank}
cert_blob[blob_hash]	string	false
cert_blob[is_media_upload]	boolean	false		Is this a media upload (appears in the media browser etc). These are files that were uploaded and are attached to things.
cert_blob[title]	string	false		The title of this file used in interfaces if its a media upload.
cert_blob[dim_w]	integer	false		If this type of file has dimentions, the width.
cert_blob[dim_h]	integer	false		If this type of file has dimentions, the height.
cert_blob[date_created]	DateTime	false
cert_blob[is_temp]	boolean	false
cert_blob[source_ref]	string	false
cert_blob[labels][][blob]	object (Blob)	false
key_blob	object (Blob)	false

Status Code	Description
204	Returned in case of successful resource modify
400	We will return this in case your request was malformed

Show/hide List Operations Expand Operations

Widget sample online agents

POST /api/v2/settings/brands/{brand}/widget/send-instructions

get widget sample online agent

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.widget.widget_settings.send_instructions

Requirements
Parameters
Status Codes

Name	Requirement	Type	Description
brand		Brand

Parameter	Type	Required?	Format	Description
	string	true	string	Email address

Status Code	Description
204	Returned if request was successful

GET /api/v2/widget/live_demo/sample_state

get widget sample online agent

Show/hide List Operations Expand Operations

Widget setup

GET /api/v2/settings/brands/{brand}/widget/code

Get the HTML code for the widget

Documentation

Get the HTML code for the widget.

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.widget.widget_settings.get_widget_code

Requirements
Status Codes

Name	Requirement	Type	Description
brand		Brand

Status Code	Description
200	Returned if request was successful

GET /api/v2/settings/brands/{brand}/widget/live_demo_code

Get the HTML code for the widget

Documentation

Get the HTML code for the widget live demo preview.

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.widget.widget_settings.get_widget_live_demo_code

Requirements
Status Codes

Name	Requirement	Type	Description
brand

Status Code	Description
200	Returned if request was successful

DELETE /api/v2/settings/brands/{brand}/widget/setup

reset widget settings

Documentation

Reset widget settings.

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.widget.widget_settings.reset_settings

Requirements
Status Codes

Name	Requirement	Type	Description
brand		Brand

Status Code	Description
200	Returned if request was successful

GET /api/v2/settings/brands/{brand}/widget/setup

get widget setup

Documentation

Gather widget setup information.

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.widget.widget_settings.get_widget_setup

Requirements
Response
Status Codes

Name	Requirement	Type	Description
brand		Brand

Parameter	Type	Versions	Description
data.url	object (WidgetUrlSettings)	*	A bunch of configuration described in urls.
data.url[widget_loader]	string	*
data.url[widget_bundle]	string	*
data.url[helpdesk]	string	*
data.url[base_url]	string	*
data.settings	object (WidgetOptions)	*	Widget settings itself.
data.settings[global]	object (WidgetGlobalSettings)	*
data.settings[global][company]	object (WidgetGlobalCompanySettings)	*	Company settings.
data.settings[global][company][name]	string	*
data.settings[global][company][logo]	string	*
data.settings[global][chat]	object (WidgetGlobalChatSettings)	*	Global chat settings.
data.settings[global][chat][enabled]	boolean	*
data.settings[brand]	object (WidgetBrandSettings)	*
data.settings[brand][widget]	object (WidgetBrandCommonSettings)	*
data.settings[brand][widget][type]	string	*
data.settings[brand][widget][position]	string	*
data.settings[brand][widget][agent_polling_timeout]	integer	*
data.settings[brand][widget][enabled]	boolean	*
data.settings[brand][widget][primary_color]	string	*
data.settings[brand][button]	object (WidgetBrandButtonSettings)	*
data.settings[brand][button][translations][]	array of objects (WidgetBrandButtonTranslation)	*
data.settings[brand][button][translations][][language]	integer	*	Language.
data.settings[brand][button][translations][][name]	string	*	Chat button name.
data.settings[brand][button][translations][][contact_us]	string	*	Ticket fallback button name.
data.settings[brand][button][size]	string	*
data.settings[brand][button][colors]	object (WidgetBrandButtonColorsSettings)	*
data.settings[brand][button][colors][background]	string	*
data.settings[brand][button][colors][text]	string	*
data.settings[brand][button][colors][border]	string	*
data.settings[brand][chat]	object (WidgetBrandChatSettings)	*
data.settings[brand][chat][request_user_info]	boolean	*
data.settings[brand][chat][proactive]	boolean	*
data.settings[brand][chat][popup]	object (WidgetBrandChatPopupSettings)	*
data.settings[brand][chat][popup][translations][]	array of objects (WidgetBrandChatPopupTranslation)	*
data.settings[brand][chat][popup][translations][][language]	integer	*	Language.
data.settings[brand][chat][popup][translations][][title]	string	*	Translation title.
data.settings[brand][chat][popup][translations][][message]	string	*	Translation message.
data.settings[brand][chat][popup][translations][][heading]	string	*	Translation title.
data.settings[brand][chat][popup][translations][][subheading]	string	*	Translation message.
data.settings[brand][chat][popup][translations][][start_button]	string	*	Message at start button.
data.settings[brand][chat][popup][style]	string	*
data.settings[brand][chat][popup][delay]	float	*
data.settings[brand][chat][begin_mode]	string	*
data.settings[brand][chat][default_department]	integer	*
data.settings[brand][chat][select_department]	string	*
data.settings[brand][chat][waiting_timeout]	integer	*
data.settings[brand][chat][required_name]	boolean	*
data.settings[brand][chat][required_email]	boolean	*
data.settings[brand][ticket]	object (WidgetBrandTicketSettings)	*
data.settings[brand][ticket][select_department]	string	*
data.settings[brand][ticket][default_department]	integer	*
data.settings[brand][ticket][select_subject]	string	*
data.settings[brand][ticket][default_subject]	string	*
data.jwtSettings		*
data.jwt_settings	object (JwtSettings)	*	Widget settings itself.
data.jwt_settings[secret]	string	*
data.jwt_settings[required]	boolean	*
data.enabled_on_portal	boolean	*	If widget enabled on portal.

Status Code	Description
200	Returned if request was successful

POST /api/v2/settings/brands/{brand}/widget/setup

create widget

Documentation

Create widget.

Applicable api modes

session token key oauth

Api tags for this endpoint

settings.widget.widget_settings.post_widget_setup

Requirements
Parameters
Response
Status Codes

Name	Requirement	Type	Description
brand		Brand

Parameter	Type	Required?	Format
settings[global][chat][enabled]	boolean	true
settings[brand][widget][type]	choice	true	["column","bubble"]
settings[brand][widget][position]	choice	true	["left","right"]
settings[brand][widget][agent_polling_timeout]	integer	true
settings[brand][widget][enabled]	boolean	true
settings[brand][widget][primary_color]	string	true
settings[brand][button][translations][][language]	choice	true
settings[brand][button][translations][][name]	string	true
settings[brand][button][translations][][contact_us]	string	true
settings[brand][button][size]	choice	true	["small","medium","large"]
settings[brand][button][colors][background]	string	true
settings[brand][button][colors][text]	string	true
settings[brand][button][colors][border]	string	true
settings[brand][chat][request_user_info]	boolean	true
settings[brand][chat][proactive]	boolean	true
settings[brand][chat][begin_mode]	choice	true	["conversation","form"]
settings[brand][chat][waiting_timeout]	integer	true
settings[brand][chat][popup][translations][][language]	choice	true
settings[brand][chat][popup][translations][][title]	string	true
settings[brand][chat][popup][translations][][message]	string	true
settings[brand][chat][popup][translations][][heading]	string	true
settings[brand][chat][popup][translations][][subheading]	string	true
settings[brand][chat][popup][translations][][start_button]	string	true
settings[brand][chat][popup][style]	choice	true	["agent_text_button","agent_text_input","agents_button","text_button","text_input","widget_button_agent"]
settings[brand][chat][popup][delay]	float	true
settings[brand][chat][select_department]	choice	true	["default","custom"]
settings[brand][chat][default_department]	choice	true
settings[brand][chat][required_name]	boolean	true
settings[brand][chat][required_email]	boolean	true
settings[brand][chat][custom_fields][][id]	choice	true
settings[brand][chat][custom_fields][][display_order]	integer	true
settings[brand][chat][custom_fields][][is_enabled]	boolean	true
settings[brand][chat][user_groups][]	array of choices	true
settings[brand][ticket][select_department]	choice	true	["default","custom"]
settings[brand][ticket][default_department]	choice	true
settings[brand][ticket][select_subject]	choice	true	["custom","message","default"]
settings[brand][ticket][default_subject]	string	true
jwt_settings[secret]	string	true
jwt_settings[required]	boolean	true
enabled_on_portal	boolean	true

Parameter	Type	Versions	Description
data.url	object (WidgetUrlSettings)	*	A bunch of configuration described in urls.
data.url[widget_loader]	string	*
data.url[widget_bundle]	string	*
data.url[helpdesk]	string	*
data.url[base_url]	string	*
data.settings	object (WidgetOptions)	*	Widget settings itself.
data.settings[global]	object (WidgetGlobalSettings)	*
data.settings[global][company]	object (WidgetGlobalCompanySettings)	*	Company settings.
data.settings[global][company][name]	string	*
data.settings[global][company][logo]	string	*
data.settings[global][chat]	object (WidgetGlobalChatSettings)	*	Global chat settings.
data.settings[global][chat][enabled]	boolean	*
data.settings[brand]	object (WidgetBrandSettings)	*
data.settings[brand][widget]	object (WidgetBrandCommonSettings)	*
data.settings[brand][widget][type]	string	*
data.settings[brand][widget][position]	string	*
data.settings[brand][widget][agent_polling_timeout]	integer	*
data.settings[brand][widget][enabled]	boolean	*
data.settings[brand][widget][primary_color]	string	*
data.settings[brand][button]	object (WidgetBrandButtonSettings)	*
data.settings[brand][button][translations][]	array of objects (WidgetBrandButtonTranslation)	*
data.settings[brand][button][translations][][language]	integer	*	Language.
data.settings[brand][button][translations][][name]	string	*	Chat button name.
data.settings[brand][button][translations][][contact_us]	string	*	Ticket fallback button name.
data.settings[brand][button][size]	string	*
data.settings[brand][button][colors]	object (WidgetBrandButtonColorsSettings)	*
data.settings[brand][button][colors][background]	string	*
data.settings[brand][button][colors][text]	string	*
data.settings[brand][button][colors][border]	string	*
data.settings[brand][chat]	object (WidgetBrandChatSettings)	*
data.settings[brand][chat][request_user_info]	boolean	*
data.settings[brand][chat][proactive]	boolean	*
data.settings[brand][chat][popup]	object (WidgetBrandChatPopupSettings)	*
data.settings[brand][chat][popup][translations][]	array of objects (WidgetBrandChatPopupTranslation)	*
data.settings[brand][chat][popup][translations][][language]	integer	*	Language.
data.settings[brand][chat][popup][translations][][title]	string	*	Translation title.
data.settings[brand][chat][popup][translations][][message]	string	*	Translation message.
data.settings[brand][chat][popup][translations][][heading]	string	*	Translation title.
data.settings[brand][chat][popup][translations][][subheading]	string	*	Translation message.
data.settings[brand][chat][popup][translations][][start_button]	string	*	Message at start button.
data.settings[brand][chat][popup][style]	string	*
data.settings[brand][chat][popup][delay]	float	*
data.settings[brand][chat][begin_mode]	string	*
data.settings[brand][chat][default_department]	integer	*
data.settings[brand][chat][select_department]	string	*
data.settings[brand][chat][waiting_timeout]	integer	*
data.settings[brand][chat][required_name]	boolean	*
data.settings[brand][chat][required_email]	boolean	*
data.settings[brand][ticket]	object (WidgetBrandTicketSettings)	*
data.settings[brand][ticket][select_department]	string	*
data.settings[brand][ticket][default_department]	integer	*
data.settings[brand][ticket][select_subject]	string	*
data.settings[brand][ticket][default_subject]	string	*
data.jwtSettings		*
data.jwt_settings	object (JwtSettings)	*	Widget settings itself.
data.jwt_settings[secret]	string	*
data.jwt_settings[required]	boolean	*
data.enabled_on_portal	boolean	*	If widget enabled on portal.

Status Code	Description
200	Returned if request was successful
400	In case your request was malformed

Parameter	Type	Versions	Description
data[]	array of objects (Tag)	*
data[][path]	string	*
data[][id]	integer	*	Autogenerated tag id. Runtime generated.
data[][title]	string	*	Just a title for the tag.
data[][value]	integer	*	Tag permission. 1 - granted. -1 - strictly denied. 0 - soft denied.
data[][nodes][]	array of objects (Tag)	*	Children.
data[][nodes][][path]	string	*
data[][nodes][][id]	integer	*	Autogenerated tag id. Runtime generated.
data[][nodes][][title]	string	*	Just a title for the tag.
data[][nodes][][value]	integer	*	Tag permission. 1 - granted. -1 - strictly denied. 0 - soft denied.
data[][nodes][][nodes][]	array of objects (Tag)	*	Children.

Name	Requirement	Type	Description
id	\d+	integer	The id of key
action	string	string	Tag name
value	1\|0	boolean	Allow\|deny

Deskpro API Documentation

Agents

GET /api/v2/agent_groups CRUD

Applicable api modes

Api tags for this endpoint

GET /api/v2/agent_groups/counts CRUD

Applicable api modes

Api tags for this endpoint

GET /api/v2/agent_groups/{id} CRUD

Applicable api modes

Api tags for this endpoint

GET /api/v2/agent_teams CRUD

Applicable api modes

Api tags for this endpoint

POST /api/v2/agent_teams CRUD

Applicable api modes

Api tags for this endpoint

GET /api/v2/agent_teams/counts CRUD

Applicable api modes

Api tags for this endpoint

DELETE /api/v2/agent_teams/{id} CRUD

Applicable api modes

Api tags for this endpoint

GET /api/v2/agent_teams/{id} CRUD

Applicable api modes

Api tags for this endpoint

PUT /api/v2/agent_teams/{id} CRUD

Applicable api modes

Api tags for this endpoint

GET /api/v2/agent_teams/{id}/agents

Documentation

Applicable api modes

Api tags for this endpoint

GET /api/v2/agents CRUD

Applicable api modes

Api tags for this endpoint

GET DEPRECATED /api/v2/agents/assigned_to_chat

Applicable api modes

Api tags for this endpoint

GET /api/v2/agents/counts CRUD

Applicable api modes

Api tags for this endpoint

GET /api/v2/agents/extended

Applicable api modes

Api tags for this endpoint

GET /api/v2/agents/online

Applicable api modes

Api tags for this endpoint

PUT /api/v2/agents/profile

Applicable api modes

Api tags for this endpoint

DELETE /api/v2/agents/{id} CRUD

Applicable api modes

Api tags for this endpoint

GET /api/v2/agents/{id} CRUD

Applicable api modes

Api tags for this endpoint

DELETE /api/v2/agents/{id}/agent_permissions

Applicable api modes

Api tags for this endpoint

POST DEPRECATED /api/v2/agents/{id}/reset-password

Applicable api modes

Api tags for this endpoint

POST /api/v2/agents/{id}/send-token

Applicable api modes

Api tags for this endpoint

POST DEPRECATED /api/v2/agents/{id}/set-password

Applicable api modes

Api tags for this endpoint

Anti-abuse settings

GET /api/v2/settings/anti_abuse/captcha

Applicable api modes

Api tags for this endpoint

PUT /api/v2/settings/anti_abuse/captcha

Applicable api modes

Api tags for this endpoint

GET /api/v2/settings/anti_abuse/portal

Applicable api modes

Api tags for this endpoint

PUT /api/v2/settings/anti_abuse/portal