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

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	*

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