Deskpro API

activity : Operations about activity

Parameter	Value	Description	Parameter Type	Data Type
dismiss_ids		Escalation ID	path	string\|integer[]

Parameter	Value	Description	Parameter Type	Data Type
since		Since what time	path	integer

agent_groups : Operations about agent groups

- get /agent_groups
  - Get agent groups list
  Response Class
  Model
  
  Model Schema
  
  array[null]
  Response Content Type
  
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers

put /agent_groups

Create new agent group

Parameter	Description	Parameter Type	Data Type
group[title]	Group title	query	string
group[perms]	Group permissions	query	string[]
group[person_ids]	Agents who belongs to this group	query	integer[]
dep_perms[tickets]	Department tickets belongs to this group	query	integer[]
dep_perms[chat]		query	string[]

get /agent_groups/{id}

Get group by ID

Parameter	Value	Description	Parameter Type	Data Type
id		Group ID	path	integer

post /agent_groups/{id}

Update existing agent group by ID

Parameter	Description	Parameter Type	Data Type
id	Agent group ID	path	integer
group[title]	Group title	query	string
group[perms]	Group permissions	query	string[]
group[person_ids]	Agents who belongs to this group	query	integer[]
dep_perms[tickets]	Department tickets belongs to this group	query	integer[]
dep_perms[chat]		query	string[]

delete /agent_groups/{id}

Delete agent group by ID

Parameter	Value	Description	Parameter Type	Data Type
id		Agent group ID	path	integer

agents : Operations about agents

get /agents

Get agents list

Parameter	Description	Parameter Type	Data Type
full	Display full agents information right in list	query	boolean
basic	Display full agents information right in list	query	boolean
with_perms	Display agent permissions	query	boolean

put /agents

Create new agent

- get /agents/deleted
  - Get deleted agents list
  Response Class
  Model
  
  Model Schema
  
  array[null]
  Response Content Type
  
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers

Parameter	Description	Parameter Type	Data Type
skip_email	Do not send email to new user	query	boolean
quick_add	Add 'all perms' group	query	boolean
perm_overrides	Save permission overrides	query	boolean
dep_perm_overrides	Save department permission overrides	query	boolean
agent[emails]	Agent data - emails	query	string
agent[primary_phone_number_text]	Agent data - phone number	query	string
agent[email]	Agent data - email	query	string
profile[signature_html]	Agent signature	query	string
profile[timezone]	Agent timezone	query	string
profile[unset_picture]	Delete agent picture	query	boolean
profile[set_picture_blob]	Picture blob	query	string

get /agents/deleted/{id}

Get deleted agent by ID

Parameter	Value	Description	Parameter Type	Data Type
id		Agent ID	path	integer

post /agents/deleted/{id}/undelete

Undelete existing agent by ID

Parameter	Value	Description	Parameter Type	Data Type
id		Agent ID	path	integer

get /agents/{id}

Get agent by ID

Parameter	Value	Description	Parameter Type	Data Type
id		Agent ID	path	integer

post /agents/{id}

Update existing agent by ID

Parameter	Description	Parameter Type	Data Type
id	Agent ID	path	integer
quick_add	Add 'all perms' group	query	boolean
perm_overrides	Save permission overrides	query	boolean
dep_perm_overrides	Save department permission overrides	query	boolean
agent[emails]	Agent data - emails	query	string
agent[primary_phone_number_text]	Agent data - phone number	query	string
agent[email]	Agent data - email	query	string
profile[signature_html]	Agent signature	query	string
profile[timezone]	Agent timezone	query	string
profile[unset_picture]	Delete agent picture	query	boolean
profile[set_picture_blob]	Picture blob	query	string

delete /agents/{id}/delete

Delete agent and move it to deleted list

Parameter	Value	Description	Parameter Type	Data Type
id		Agent ID	path	integer

delete /agents/{id}/delete/to-user

Delete agent and move it to users list

Parameter	Value	Description	Parameter Type	Data Type
id		Agent ID	path	integer

get /agents/{id}/login-token

Generate login token to agent with ID = id

Parameter	Value	Description	Parameter Type	Data Type
id		Agent ID	path	integer

get /agents/{id}/notify-prefs/get-tables

Get agent notification preferences

Parameter	Value	Description	Parameter Type	Data Type
id		Agent ID	path	integer

post /agents/{id}/profile

Update existing agent profile by ID

Parameter	Description	Parameter Type	Data Type
id	Agent ID	path	integer
profile[signature_html]	Agent signature	query	string
profile[timezone]	Agent timezone	query	string
profile[unset_picture]	Delete agent picture	query	boolean
profile[set_picture_blob]	Picture blob	query	string

post /agents/{id}/reset-password

Reset agent profile by ID

Parameter	Value	Description	Parameter Type	Data Type
id		Agent ID	path	integer

api_keys : Operations about API Keys

Parameter	Value	Description	Parameter Type	Data Type
id		ID of API Key that needs to be fetched	path	integer

HTTP Status Code	Reason
404	API Key not found

chats : Operations about Chats

get /chats

Search for chats matching criteria

Parameter	Description	Parameter Type	Data Type
agent_id[]	Requires chat to be assigned to the specified agent ID.	query	string
department_id[]	Requires chat to be in the specified department ID.	query	string
label[]	Requires chat to be have the specified label.	query	string
person_id[]	Requires chat to be created by the specified person ID.	query	string
status[]	Requires chat to be in the specified status. Possible values are ended and open.	query	string
order	Order of the results. Defaults to newest chats. This parameter is not used used yet.	query	string
cache_id	If provided, cached results from this result set are used. If it cannot be found or used, the other constraints provided will be used to create a new result set.	query	string
page	The page number of the results to fetch.	query	string

get /chats/{chat_id}

Gets a chat by chat ID.

Parameter	Value	Description	Parameter Type	Data Type
chat_id		ID of the chat that needs to be searched.	path	integer

HTTP Status Code	Reason
404	Chat not found

post /chats/{chat_id}

Updates a chat by chat ID.

Parameter	Value	Description	Parameter Type	Data Type
chat_id		ID of the chat that needs to be searched.	path	integer
department_id		Department the chat is in.	query	integer

HTTP Status Code	Reason
404	Chat not found

post /chats/{chat_id}/end

Ends a chat by chat ID.

Parameter	Value	Description	Parameter Type	Data Type
chat_id		ID of the chat that needs to be ended.	path	integer

HTTP Status Code	Reason
404	Chat not found

get /chats/{chat_id}/labels

Gets the labels for a chat

Parameter	Value	Description	Parameter Type	Data Type
chat_id		ID of the chat that needs to be checked.	path	integer

HTTP Status Code	Reason
404	Chat not found

post /chats/{chat_id}/labels

Adds a label to a chat.

Parameter	Value	Description	Parameter Type	Data Type
chat_id		ID of the chat that needs to be checked.	path	integer
label		Label to add.	query	string

HTTP Status Code	Reason
404	Chat not found

get /chats/{chat_id}/labels/{label}

Determines if the chat has the label.

Parameter	Value	Description	Parameter Type	Data Type
chat_id		ID of the chat that needs to be checked.	path	integer
label		Label to check.	path	string

HTTP Status Code	Reason
404	Chat not found

delete /chats/{chat_id}/labels/{label}

Removes a label from a chat.

Parameter	Value	Description	Parameter Type	Data Type
chat_id		ID of the chat that needs to be checked.	path	integer
label		Label that needs to be removed.	path	string

HTTP Status Code	Reason
404	Chat not found

post /chats/{chat_id}/leave

Leaves a chat by chat ID.

Parameter	Value	Description	Parameter Type	Data Type
chat_id		ID of the chat that needs to be left.	path	integer
action		If the chat is open, an additional action to take. Options are unassign or end.	query	string

HTTP Status Code	Reason
404	Chat not found

get /chats/{chat_id}/messages

Gets all messages in a chat by chat ID.

Parameter	Value	Description	Parameter Type	Data Type
chat_id		ID of the chat that needs to be ended.	path	integer

HTTP Status Code	Reason
404	Chat not found

post /chats/{chat_id}/messages

Replies to a chat as the API user

Parameter	Value	Description	Parameter Type	Data Type
chat_id		ID of the chat that needs to be ended.	path	integer
message		Message reply text.	query	integer

HTTP Status Code	Reason
404	Chat not found

get /chats/{chat_id}/participants

Gets all participants in a chat by chat ID.

Parameter	Value	Description	Parameter Type	Data Type
chat_id		ID of the chat that needs to be ended.	path	integer

HTTP Status Code	Reason
404	Chat not found

post /chats/{chat_id}/participants

Adds a participants in a chat by chat ID and person ID.

Parameter	Value	Description	Parameter Type	Data Type
chat_id		ID of the chat.	path	integer
person_id		ID of the person that needs to be added to the Chat.	query	integer

HTTP Status Code	Reason
404	Chat not found

get /chats/{chat_id}/participants/{person_id}

Determines if a person is participating in a chat.

Parameter	Value	Description	Parameter Type	Data Type
chat_id		ID of the chat that needs to be checked.	path	integer
person_id		ID of the person that needs to be added to be checked.	query	integer

HTTP Status Code	Reason
404	Chat not found

delete /chats/{chat_id}/participants/{person_id}

Removes a participant from a chat

Parameter	Value	Description	Parameter Type	Data Type
chat_id		ID of the chat that needs to be checked.	path	integer
person_id		ID of the person that needs to be added to be removed.	query	integer

HTTP Status Code	Reason
404	Chat not found

downloads : Operations about Downloads

- get /download/categories
  - Gets available download categories.
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers

post /download/categories

Creates a download category.

Parameter	Description	Parameter Type	Data Type
title	Title of the category that needs to be created.	path	integer
parent_id	ID of the category's parent. Use 0 for no parent.	query	integer
display_order	Order of display of categories. Lower numbers will be displayed first.	query	integer
usergroup_id[]	comma separated IDs of usergroup that has access. If not provided, defaults to all users.	query	string

- get /download/validating-comments
  - Gets download comments that are awaiting validation.
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers

delete /download/{download_id}

Deletes a Download by ID.

get /download/{download_id}/comments

Gets the comments for download

post /download/{download_id}/comments

Add a comment for a download entry.

get /download/{download_id}/comments/{comment_id}

Gets info about a specific download comment

post /download/{download_id}/comments/{comment_id}

Updates a comment for a download entry.

delete /download/{download_id}/comments/{comment_id}

Deletes a comment for a download entry.

get /download/{download_id}/labels

Gets the labels for download

post /download/{download_id}/labels

Add a label for a download entry.

get /download/{download_id}/labels/{label}

Determines if download has a label.

delete /download/{download_id}/labels/{label}

Removes a label from download

get /downloads

Search for downloads matching criteria

Implementation Notes

Returns list of downloads that matched.

Response Class

array[null]

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
category_id[]	Comma seperated IDs of categories to search in	query	string
category_id_specific[]	Comma seperated IDs of categories to search in	query	string
date_created_end	Requires the download to have been created before this date. Must be specified as a Unix timestamp.	query	integer
date_created_start	Requires the download to have been created after this date. Must be specified as a Unix timestamp.	query	integer
label[]	Requires the download to have this label.	query	string
status[]	Requires the download to be in this status. Possible values: new, active, closed, hidden.	query	string
new	If non-0, requires the download to be considered new (created within the last month). If 0, this does nothing.	query	boolean
popular	If non-0, requires the download to be considered popular (50 or more downloads). If 0, this does nothing.	query	boolean
order	Order of the results. Defaults to the publishing date.	query	string
cache_id	If provided, cached results from this result set are used. If it cannot be found or used, the other constraints provided will be used to create a new result set.	query	integer
page	The page number of the results to fetch.	query	integer

post /downloads

Creates a new download.

get /downloads/{download_id}

Gets a download by download ID.

post /downloads/{download_id}

Updates a Download by download ID.

community : Operations about Feedbacks

get /community

Search for feedbacks matching criteria

- get /community/categories
  - Gets available feedback categories.
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers
- get /community/status-categories
  - Gets available feedback status categories.
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers
- get /community/user-categories
  - Gets available feedback user categories.
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers
- get /community/validating-comments
  - Gets feedback comments that are awaiting validation.
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers

get /community/{feedback_id}

Gets a feedback by feedback ID.

delete /community/{feedback_id}

Deletes a Feedback by ID.

get /community/{feedback_id}/attachments

Gets information about a feedback record's attachments

post /community/{feedback_id}/attachments

Adds an attachment to a feedback record.

get /community/{feedback_id}/attachments/{attachment_id}

Determines if a feedback record has an attachment

delete /community/{feedback_id}/attachments/{attachment_id}

Removes a feedback attachment

get /community/{feedback_id}/comments

Gets the comments for feedback

post /community/{feedback_id}/comments

Add a comment for a feedback entry.

get /community/{feedback_id}/comments/{comment_id}

Gets info about a specific feedback comment

post /community/{feedback_id}/comments/{comment_id}

Updates a feedback comment

delete /community/{feedback_id}/comments/{comment_id}

DELETE a specific feedback comment

get /community/{feedback_id}/labels

Gets the labels for feedback

post /community/{feedback_id}/labels

Add a label for a feedback entry.

get /community/{feedback_id}/labels/{label}

Determines if feedback has a label.

delete /community/{feedback_id}/labels/{label}

Removes a label from feedback

post /community/{feedback_id}/merge/{other_feedback_id}

Merges the two feedback records

get /community/{feedback_id}/votes

Gets the votes for feedback

post /communitys

Creates a new feedback.

post /communitys/{feedback_id}

Updates a Feedback by feedback ID.

glossary : Operations about Glossary Words

get /glossary

List glossary words.

post /glossary

Add a glossary word.

get /glossary/definitions/{definition_id}

Gets a glossary word definition.

post /glossary/definitions/{definition_id}

Updates a glossary word definition.

delete /glossary/definitions/{definition_id}

Deletes a glossary word definition.

get /glossary/lookup

Looks up a specific glossary word.

get /glossary/{word_id}

Gets a glossary word by word ID.

delete /glossary/{word_id}

Deletes a glossary word by ID.

kb : Operations about Knowledgebase

get /kb

Search for articles matching criteria

Implementation Notes

Returns list of articles that matched.

Response Class

array[null]

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
category_id[]	Comma seperated IDs of categories to search in	query	string
category_id_specific[]	Comma seperated IDs of categories to search in	query	string
date_created_end	Requires the article to have been created before this date. Must be specified as a Unix timestamp.	query	integer
date_created_start	Requires the article to have been created after this date. Must be specified as a Unix timestamp.	query	integer
label[]	Requires the article to have this label.	query	string
status[]	Requires the article to be in this status. Possible values include: published, archived, hidden.	query	string
new	If non-0, requires the article to be considered new (created within the last month). If 0, this does nothing.	query	boolean
popular	If non-0, requires the article to be considered popular (50 or more articles). If 0, this does nothing.	query	boolean
order	Order of the results. Defaults to the publishing date.	query	string
cache_id	If provided, cached results from this result set are used. If it cannot be found or used, the other constraints provided will be used to create a new result set.	query	integer
page	The page number of the results to fetch.	query	integer

post /kb

Creates a new article.

Parameters

Parameter	Value	Description	Parameter Type	Data Type
title		Title of the article.	query	string
content		Content of the article. Marked up using HTML.	query	string
category_id[]		ID of the category the article is in. At least one is required.	query	integer
label[]		Comma seperated list of Labels to apply to the article.	query	string
status		Status of the article. Defaults to new if not overridden by this or status_category_id.	query	integer
attach[]	Parameter content type:	Attached file that represents the article. See the API Basics for more information on sending files to the API. Required if no attach_id is provided.	body	string
attach_id[]		The ID of an already uploaded file to include with the article. Required if no attach value is provided.	query	integer
date		If provided, changes the creation/publishing date of the article to the given Unix timestamp. If not provided, defaults to the current time.	query	integer
date_end		If provided, sets the Unix timestamp when an action should be taken.	query	integer
date_published		If provided and the article is not published, sets the Unix timestamp when an article should be published.	query	integer
end_action		If provided with a date_end, the action that should be taken when date_end is reached. Possible values are delete or archive.	query	integer
field[]		Value for the specified custom field.	query	integer
product_id[]		ID of product this article is associated with.	query	integer

- get /kb/categories
  - Gets available article categories.
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers

post /kb/categories

Creates an article category.

get /kb/categories/{category_id}

Gets an article category

post /kb/categories/{category_id}

Updates an article category.

delete /kb/categories/{category_id}

DELETEs an article category

get /kb/categories/{category_id}/articles

Gets articles within an article category.

get /kb/categories/{category_id}/groups

Gets groups with access to a article category.

post /kb/categories/{category_id}/groups

Adds a group to a article category.

get /kb/categories/{category_id}/groups/{group_id}

Determines if a group has access to a article category.

delete /kb/categories/{category_id}/groups/{group_id}

Removes a group's access to a article category.

- get /kb/fields
  - Gets available article fields.
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers
- get /kb/products
  - Gets available article products.
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers
- get /kb/validating-comments
  - Gets article comments that are awaiting validation.
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers

get /kb/{article_id}

Gets a article by article ID.

post /kb/{article_id}

Updates an article.

Parameters

Parameter	Value	Description	Parameter Type	Data Type
article_id		ID of the article that needs to be upated	path	string
title		Title of the article.	query	string
content		Content of the article. Marked up using HTML.	query	string
category_id[]		ID of the category the article is in. At least one is required.	query	integer
status		Status of the article. Defaults to new if not overridden by this or status_category_id.	query	integer
attach[]	Parameter content type:	Attached file that represents the article. See the API Basics for more information on sending files to the API. Required if no attach_id is provided.	body	string
attach_id[]		The ID of an already uploaded file to include with the article. Required if no attach value is provided.	query	integer
date		If provided, changes the creation/publishing date of the article to the given Unix timestamp. If not provided, defaults to the current time.	query	integer
date_end		If provided, sets the Unix timestamp when an action should be taken.	query	integer
date_published		If provided and the article is not published, sets the Unix timestamp when an article should be published.	query	integer
end_action		If provided with a date_end, the action that should be taken when date_end is reached. Possible values are delete or archive.	query	integer
field[]		Value for the specified custom field.	query	integer
product_id[]		ID of product this article is associated with.	query	integer

delete /kb/{article_id}

DELETES a article by article ID.

get /kb/{article_id}/attachments

Gets the attachments for an article.

post /kb/{article_id}/attachments

Add an attachment for an article.

get /kb/{article_id}/comments

Gets the comments for an article.

post /kb/{article_id}/comments

Add a comment for an article.

get /kb/{article_id}/comments/{attachment_id}

Gets info about a specific article attachment.

delete /kb/{article_id}/comments/{attachment_id}

DELETEs info about a specific article attachment.

get /kb/{article_id}/comments/{comment_id}

Gets info about a specific article comment.

post /kb/{article_id}/comments/{comment_id}

Updates an article comment.

delete /kb/{article_id}/comments/{comment_id}

DELETEs an article comment.

get /kb/{article_id}/labels

Gets the labels for an article.

post /kb/{article_id}/labels

Add a label for an article.

get /kb/{article_id}/labels/{label}

Determines if an article has a label.

delete /kb/{article_id}/labels/{label}

Removes a label from an article.

get /kb/{article_id}/votes

Gets the votes for an article.

news : Operations about News Items

get /news

Get list of all News Items

post /news

Add a new News Item

- get /news/categories
  - Gets available news categories
  Implementation Notes
  
  Retrieves all available news categories
  
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers
- post /news/categories
  - Creates a new News category
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers

delete /news/categories/{category_id}

Delete News Category by ID

get /news/categories/{category_id}/groups

Gets groups with access to a news category

post /news/categories/{category_id}/groups

Adds a group to a news category

get /news/categories/{category_id}/groups/{group_id}

Determines if a group has access to a news category

delete /news/categories/{category_id}/groups/{group_id}

Removes a group's access to a news category

get /news/categories/{catgory_id}

Find News Category by ID

post /news/categories/{catgory_id}

Update News Category by ID

get /news/categories/{catgory_id}

Gets news within a news category

- get /news/validating-comments
  - Gets news comments that are awaiting validation
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers

get /news/{news_id}

Find News by ID

post /news/{news_id}

Updates News Item by ID

delete /news/{news_id}

Delete News by ID

get /news/{news_id}/comments

Find all the comments by News ID

post /news/{news_id}/comments

Adds a new Comment by News ID

get /news/{news_id}/comments/{comment_id}

Find one News comment by News ID and Comment ID

post /news/{news_id}/comments/{comment_id}

Updates one News comment by News ID and Comment ID

delete /news/{news_id}/comments/{comment_id}

Delete one News comment by News ID and Comment ID

delete /news/{news_id}/comments/{label}

Delete one label by News ID and label

get /news/{news_id}/labels

Find all the labels by News ID

post /news/{news_id}/labels

Adds a new Label by News ID

get /news/{news_id}/labels/{label}

Find one Label by News ID and Label

organizations : Operations about Organization

get /organizations

Search for organizations matching criteria

Implementation Notes

Returns list of organizations that matched.

Response Class

array[null]

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
address[]	Requires an organization's address to contain this value.	query	string
field[#][]	Requires organization custom field to have the specified value in the listed field.	query	string
im[]	Requires an organization to have an instant messenger contact that contains this value.	query	string
label[]	Requires organization to be have the specified label.	query	string
name[]	Requires an organization to have a name that contains this value.	query	string
phone[]	Requires organization to have a phone number that contains this value.	query	string
order	Order of the results. Defaults to accessing organization's preference or organizations.id:asc.	query	string
cache_id	If provided, cached results from this result set are used. If it cannot be found or used, the other constraints provided will be used to create a new result set.	query	string
page	The page number of the results to fetch.	query	string
parent_id	The id of the parent org.	query	integer

post /organizations

Creates a new organization.

- get /organizations/fields
  - Gets available custom organization fields.
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers
- get /organizations/fields
  - Gets available usergroups.
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers

get /organizations/{organization_id}

Gets a organization by organization ID.

post /organizations/{organization_id}

Updates a organization.

delete /organizations/{organization_id}

DELETEs a organization.

get /organizations/{organization_id}/activity-stream

Gets activity stream for an organization.

get /organizations/{organization_id}/billing-charges

Gets billing charges for an organization.

get /organizations/{organization_id}/chats

Gets chats by a organization.

get /organizations/{organization_id}/contact-details

Gets contact details for an organization.

post /organizations/{organization_id}/contact-details

Creates a contact detail for an organization.

get /organizations/{organization_id}/contact-details/{contact_id}

Determines if contact ID exists for organization.

delete /organizations/{organization_id}/contact-details/{contact_id}

Deletes a contact for an organization.

get /organizations/{organization_id}/email-domains

Gets associated email domains for an organization.

post /organizations/{organization_id}/email-domains

Adds an email domain for an organization.

get /organizations/{organization_id}/email-domains/{domain}

Determines if a domain is associated with an organization.

delete /organizations/{organization_id}/email-domains/{domain}

Deletes a domain association for an organization

post /organizations/{organization_id}/email-domains/{domain}/move-taken-users

Moves users to an organization (if they have another organization).

post /organizations/{organization_id}/email-domains/{domain}/move-users

Moves users to an organization (if they have no organization).

get /organizations/{organization_id}/groups

Gets the groups for an organization.

post /organizations/{organization_id}/groups

Adds an organization to a group.

get /organizations/{organization_id}/groups/{usergroup_id}

Determines if an organization is a member of a group.

delete /organizations/{organization_id}/groups/{usergroup_id}

Removes an organization from a group.

get /organizations/{organization_id}/labels

Gets the labels for an organization.

post /organizations/{organization_id}/labels

Add a label for an organization.

get /organizations/{organization_id}/labels/{label}

Determines if an organization has a label.

delete /organizations/{organization_id}/labels/{label}

Determines if an organization has a label.

get /organizations/{organization_id}/members

Gets members of an organization.

get /organizations/{organization_id}/notes

Gets a list of Organization Notes for an organization.

post /organizations/{organization_id}/notes

Adds a new Organization Notes to an organization.

get /organizations/{organization_id}/notes/{note_id}

Gets an Organization Note for an organization by Organization ID and Note ID.

get /organizations/{organization_id}/picture

Gets a link to an organization's picture.

post /organizations/{organization_id}/picture

Updates an organization's picture.

delete /organizations/{organization_id}/picture

DELETEs an organization's picture.

get /organizations/{organization_id}/tickets

Gets tickets by an organization.

people : Operations about People/Persons

get /people

Search for people matching criteria

Implementation Notes

Returns list of people that matched.

Response Class

array[null]

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
address[]	Requires an person's address to contain this value.	query	string
agent_team_id[]	Requires a person to be a member of this agent team.	query	string
alpha[]	Requires a person's last name to start with this letter.	query	string
date_created_end	Requires a person's account to have been created before this date. Must be specified as a Unix timestamp.	query	integer
date_created_start	Requires a person's account to have been created after this date. Must be specified as a Unix timestamp.	query	integer
email[]	Requires a person to have an email that contains this value.	query	integer
email_domain[]	Requires a person to have an email with a domain that contains this value.	query	integer
field[#][]	Requires person custom field to have the specified value in the listed field.	query	string
im[]	Requires an person to have an instant messenger contact that contains this value.	query	string
is_agent	True to search on agents instead of users.	query	boolean
is_agent_confirmed	Requires the person to be confirmed by an agent or not.	query	boolean
label[]	Requires person to be have the specified label.	query	string
name[]	Requires an person to have a name that contains this value.	query	string
language_id[]	Requires person to have chosen this language.	query	string
organization_id[]	Requires person to be a member of this organization.	query	string
phone[]	Requires person to have a phone number that contains this value.	query	string
usergroup_id[]	Requires person to be a member of this usergroup.	query	string
order	Order of the results. Defaults to accessing person's preference or people.id:asc.	query	string
cache_id	If provided, cached results from this result set are used. If it cannot be found or used, the other constraints provided will be used to create a new result set.	query	string
page	The page number of the results to fetch.	query	string

post /people

Creates a new Person.

Parameters

Parameter	Description	Parameter Type	Data Type
name	Full name of the Person.	query	string
first_name	First name of the Person.	query	string
last_name	Last name of the Person.	query	string
password	Set the password for the person so they can log in.	query	string
email	Primary email of the person. This cannot already exist.	query	string
contact_data[#]	Components of a contact detail to add. See the Setting Contact Data article for more information.	query	string
disable_autoresponses	If true, disables sending this person automatic notifications when actions are applied to their tickets.	query	boolean
field[#]	Value for the specified custom person field.	query	string
group_id[]	ID of a usergroup to add this person to.	query	string
label[]	Label to apply to the person.	query	string
is_disabled	If true, sets this person to be disabled (can't login or interact with tickets/chat).	query	boolean
organization	Name of the organization this person should belong to. If this does not exist, one will be created.	query	string
organization_id	ID of the organization this person should belong to.	query	integer
organization_position	If the person belongs to an organization, their position within it.	query	string
summary	Summary of the person's details.	query	string
timezone	Olson time zone string identifier.	query	string
send_email	Send the user a welcome email (false by default).	query	boolean
via_agent	Use this to signify you are creating the account on behalf of a user, which would result in the agent variant of the welcome email when send_email is enabled.	query	boolean

post /people/auth-login

Given some user credentials, test to see if they are correct and return the person record if so.

- get /people/fields
  - Gets available custom person fields
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers
- get /people/groups
  - Gets available usergroups
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers

get /people/{person_id}

Gets a Person by Person ID.

post /people/{person_id}

Updates a Person.

Parameters

Parameter	Description	Parameter Type	Data Type
person_id	ID of the Person.	path	string
name	Name of the Person.	query	string
disable_autoresponses	If true, disables sending this person automatic notifications when actions are applied to their tickets.	query	boolean
field[#]	Value for the specified custom person field.	query	string
is_disabled	If true, sets this person to be disabled (can't login or interact with tickets/chat).	query	boolean
organization	Name of the organization this person should belong to. If this does not exist, one will be created.	query	string
organization_id	ID of the organization this person should belong to.	query	integer
organization_position	If the person belongs to an organization, their position within it.	query	string
summary	Summary of the person's details.	query	string
timezone	Olson time zone string identifier.	query	string

Error Status Codes

HTTP Status Code	Reason
404	Person not found

delete /people/{person_id}

Deletes a Person by Person ID.

get /people/{person_id}/activity-stream

Gets activity stream for a person.

get /people/{person_id}/billing-charges

Gets billing charges for a person.

get /people/{person_id}/chats

Gets chats by a person.

post /people/{person_id}/clear-session

Clears a person's session.

get /people/{person_id}/contact-details

Gets contact details for a person.

post /people/{person_id}/contact-details

Creates a contact detail for a person

get /people/{person_id}/contact-details/{contact_id}

Determines if contact ID exists for person.

delete /people/{person_id}/contact-details/{contact_id}

Deletes a contact for a person.

get /people/{person_id}/emails

Gets email records for a person.

post /people/{person_id}/emails

Adds an email for a person.

get /people/{person_id}/emails/{email_id}

Gets information about an email ID for a person.

post /people/{person_id}/emails/{email_id}

Updates an email record for a person.

delete /people/{person_id}/emails/{email_id}

Deletes an email record for a person

get /people/{person_id}/groups

Gets the groups for a person.

post /people/{person_id}/groups

Adds a person to a group.

get /people/{person_id}/groups/{group_id}

Determines if a person is a member of a group.

delete /people/{person_id}/groups/{group_id}

Removes a person from a group.

get /people/{person_id}/labels

Gets the labels for a person.

post /people/{person_id}/labels

Adds a label for a person.

get /people/{person_id}/labels/{label}

Determines if a person has a label.

delete /people/{person_id}/labels/{label}

Removes a label from a person.

get /people/{person_id}/login-token

Gets a login token that can be used in a web request to log a user in. Note that the login token is only valid for 5 minutes.

get /people/{person_id}/notes

Gets notes for a person.

post /people/{person_id}/notes

Creates a note for a person.

get /people/{person_id}/phone_numbers

Gets phone numbers for a person.

post /people/{person_id}/phone_numbers

Adds a phone number for a person.

get /people/{person_id}/phone_numbers/{number_id}

Gets information about an email ID for a person.

post /people/{person_id}/phone_numbers/{number_id}

Updates a phone number for a person.

delete /people/{person_id}/phone_numbers/{number_id}

Deletes a phone number record for a person

get /people/{person_id}/picture

Gets a link to a person's picture.

post /people/{person_id}/picture

Updates a person's picture.

delete /people/{person_id}/picture

Deletes a person's picture.

post /people/{person_id}/reset-password

Resets a person's password.

get /people/{person_id}/tickets

Gets tickets by a person.

get /people/{person_id}/vcard

Gets the vCard for a person.

tasks : Operations about Tasks

get /tasks

Search for tasks matching criteria

Implementation Notes

Returns list of tasks that matched.

Response Class

array[null]

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
assigned_agent_id[]	Comma seperated IDs of the agent assigned to the task.	query	string
assigned_agent_team_id[]	Comma seperated IDs of the agent assigned to the task.	query	string
date_completed_end	Maximum Unix timestamp for when the task was completed.	query	integer
date_completed_start	Minimum Unix timestamp for when the task was completed.	query	integer
date_created_end	Maximum Unix timestamp for when the task was created.	query	integer
date_created_start	Minimum Unix timestamp for when the task was created.	query	integer
date_due_end	Maximum Unix timestamp for when the task is due.	query	integer
date_due_start	Minimum Unix timestamp for when the task is due.	query	integer
is_completed	1 to get completed tasks only, 0 to get incomplete tasks only.	query	boolean
person_id[]	Comma seperated IDs of the person that created the task.	query	string
title[]	Text that must be contained in the task title.	query	string
visibility	1 to get public tasks only, 0 to get private tasks only.	query	boolean
order	Order of the results. Defaults to task.name:asc	query	string
cache_id	If provided, cached results from this result set are used. If it cannot be found or used, the other constraints provided will be used to create a new result set.	query	integer
page	The page number of the results to fetch.	query	integer

post /tasks

Creates a new task.

get /tasks/{task_id}

Gets a task by task ID.

post /tasks/{task_id}

Updates a Task.

delete /tasks/{task_id}

Deletes a task by ID.

get /tasks/{task_id}/associations

Gets Task associations.

get /tasks/{task_id}/associations

Creates a task association.

get /tasks/{task_id}/associations/{association_id}

Determines if a task association exists.

delete /tasks/{task_id}/associations/{association_id}

Deletes a task association.

get /tasks/{task_id}/comments

Gets task comments by task ID

post /tasks/{task_id}/comments

Creates a task comment by task ID

get /tasks/{task_id}/comments/{comment_id}

Determines if a task comment exists

delete /tasks/{task_id}/comments/{comment_id}

Deletes a task comment by Task and Comment IDs

get /tasks/{task_id}/labels

Gets task labels by task ID

post /tasks/{task_id}/labels

Creates a task label by task ID

get /tasks/{task_id}/labels/{label}

Determines if a task label exists by task ID

delete /tasks/{task_id}/labels/{label}

Deletes a task label by task ID

ticket_escalations : Operations about Ticket escalations

- get /ticket_escalations
  - Get list of ticket escalations
  Response Class
  Model
  
  Model Schema
  
  array[null]
  Response Content Type
  
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers

put /ticket_escalations

Create new escalation

post /ticket_escalations/run_order

Update escalation run order

get /ticket_escalations/{id}

Get escalation by ID

post /ticket_escalations/{id}

Update existing escalation by ID

delete /ticket_escalations/{id}

Delete escalation by ID

post /ticket_escalations/{id}/disable

Disable escalation by id

post /ticket_escalations/{id}/enable

Enable escalation by id

ticket_fields : Operations about Ticket fields

ticket_filters : Operations about Ticket urgencies

- get /ticket_filters
  - Get all defined filters
  Response Class
  Model
  
  Model Schema
  
  array[null]
  Response Content Type
  
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers

post /ticket_filters/display_order

Rearrange order in which filters are following

get /ticket_filters/{id}

Get ticket filter by Id

post /ticket_filters/{id}

Save ticket filter details

delete /ticket_filters/{id}

Delete ticket filter by ID

ticket_layout : Operations about Ticket layouts

ticket_macros : Operations about Ticket macros

get /ticket_layouts/{dep_id}

Get macros by ID

put /ticket_macros

Create new macros

delete /ticket_macros/{id}

Delete macros by ID

- get /ticket_triggers
  - Get list of ticket macroses
  Response Class
  Model
  
  Model Schema
  
  array[null]
  Response Content Type
  
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers

ticket_statuses : Operations about Ticket status

ticket_triggers : Operations about Ticket triggers

ticket_urgencies : Operations about Ticket urgencies
- - get /ticket_urgencies
    - Get list of ticket counted urgency
    Response Class
    Model
    
    Model Schema
    
    array[null]
    Response Content Type
    
    Hide Response
    
    Request URL
    
    Response Body
    
    Response Code
    
    Response Headers

tickets : Operations about Tickets

get /ticket/{ticket_id}/billing-charges

Gets billing charges for a Ticket.

post /ticket/{ticket_id}/billing-charges

Gets billing charges for a Ticket.

get /ticket/{ticket_id}/billing-charges/{charge_id}

Determines if a charge exists for a ticket.

delete /ticket/{ticket_id}/billing-charges/{charge_id}

Deletes a charge for a ticket.

post /tickets

Creates a new Ticket.

Parameters

Parameter	Description	Parameter Type	Data Type
person_id	ID of person to create ticket for.	query	integer
person_email	If no person_id is given, the ticket is created for a person with this email. If no person is found with this email, one is created.	query	string
person_name	If a person is being created, use this as their name.	query	string
overwrite_person_name	Set person_name even if the person already exists. This will overwrite a persons name with the one provided in person_name.	query	boolean
person_organization	If a person is being created, user this as their organization. If no organization is found with this name, one is created.	query	string
person_organization_position	If a person is being created and they belong to an organization, select this as their position.	query	string
subject	Subject of the ticket.	query	string
message	First message of the ticket.	query	string
message_as_agent	If true, the message is considered to be written by the API agent rather than the ticket owner. Defaults to false.	query	boolean
message_is_html	If true, the message parameter is treated as HTML.	query	boolean
agent_id	Agent assigned to the ticket. Defaults to unassigned.	query	integer
agent_team_id	Agent team the ticket belongs to.	query	integer
attach[]	If you wish to upload a file with the ticket, you may send the request as multipart/form-data with the file data going to this parameter.	form	string
attach_id[]	The ID of an already uploaded file to include with the ticket.	query	string
category_id	Category the ticket is in.	query	string
department_id	Department the ticket is in. If not specified, uses the default ticket department.	query	string
field[]	Value for the specified field.	query	string
label[]	Label to apply to the ticket.	query	string
language_id	Language the ticket is in.	query	string
priority_id	Priority of the ticket.	query	string
product_id	Product the ticket relates to.	query	string
status	Status the ticket is in. Possible values are awaiting_user, awaiting_agent, archived, hidden, resolved. Defaults to awaiting_agent.	query	string
sla_id[]	Adds the SLA to the ticket. Can only add SLAs that agents may manually add.	query	string
urgency	Urgency of the ticket (1-10).	query	integer
workflow_id	Workflow for the ticket.	query	integer

get /tickets

Search for Tickets matching criteria

Implementation Notes

All constraints are optional. Multiple constraints are AND'd together; multiple values for a single constraint are OR'd.

Response Class

array[null]

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
agent_id[]	Requires ticket to be assigned to the specified agent ID.	query	string
agent_team_id[]	Requires ticket to be assigned to an agent in the specific agent team ID.	query	string
category_id[]	Requires ticket to be in the specified category ID.	query	string
department_id[]	Requires ticket to be in the specified department ID.	query	string
field[#][]	Requires ticket custom field to have the specified value in the listed field.	query	string
label[]	Requires ticket to be have the specified label.	query	string
language_id[]	Requires ticket to be in the specified language ID.	query	string
organization_id[]	Requires ticket to be for the specified organization ID.	query	string
participant[]	Requires ticket to be followed by or copied to the specified person ID.	query	string
person_id[]	Requires ticket to be created by the specified person ID.	query	string
priority_id[]	Requires ticket to be have the specified priority ID.	query	string
product_id[]	Requires ticket to be for the specified product ID.	query	string
query	Requires ticket to contain the specified text within it.	query	string
status[]	Requires ticket to be in the specified status. Possible values are awaiting_user, awaiting_agent, archived, hidden, resolved.	query	string
is_hold	If specified, requires the ticke to be on hold (1) or not on hold (0)	query	boolean
sla_completed	If specified, requires the ticket to have the SLA requirement completed (1) or incomplete (0).	query	boolean
sla_id[]	Requires ticket to be have the specified SLA.	query	string
sla_status[]	Requires ticket to be have the specified SLA status. Possible values: ok, warning, fail.	query	string
subject[]	Requires ticket subject to match the string provided.	query	string
urgency[]	Requires ticket to be have the specified urgency (1-10).	query	string
workflow_id[]	Requires ticket to be have the specified workflow ID.	query	string
id_min	Specify min ticket ID (since build 315)	query	integer
id_max	Specify max ticket ID (since build 315)	query	integer
ref	Specify a ref or the beginning characters of a ref (since build 315)	query	string
date_created	Constrains results based on the date the ticket was created.	query	string
date_resolved	Constrains results based on the date the ticket was first resolved. Unresolved tickets are not included.	query	string
date_archived	Constrains results based on the date the ticket was first archived. Unarchived tickets are not included.	query	string
date_status	Constrains results based on the date of the last status change.	query	string
date_last_agent_reply	Constrains results based on the date of the last agent reply. Tickets without an agent reply are not included.	query	string
date_last_user_reply	Constrains results based on the date of the last user reply.	query	string
date_last_reply	Constrains results based on the date of the last reply (either a user or agent reply, whichever was latest).	query	string
order	Order of the results. Defaults to accessing person's preference or ticket.date_created:desc.	query	string
cache_id	If provided, cached results from this result set are used. If it cannot be found or used, the other constraints provided will be used to create a new result set.	query	integer
page	The page number of the results to fetch.	query	integer

- get /tickets/categories
  - Gets available ticket categories.
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers
- get /tickets/departments
  - Gets available ticket departments.
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers
- get /tickets/fields
  - Gets available custom ticket fields.
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers
- get /tickets/filters
  - Get a map of filters
  Implementation Notes
  
  Find all ticket filters (system and custom)
  
  Response Class
  Model
  
  Model Schema
  
  array[null]
  Response Content Type
  
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers
- get /tickets/filters/counts
  - Get array of filters and counts
  Response Class
  Model
  
  Model Schema
  
  array[null]
  Response Content Type
  
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers

get /tickets/filters/{filter_id}

Execute a filter and return results

- get /tickets/priorities
  - Gets available ticket priorities.
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers
- get /tickets/products
  - Gets available ticket products.
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers
- get /tickets/quick-stats
  - Returns all today created or resolved tickets and tickets awaiting their agent
  Response Class
  Model
  
  Model Schema
  
  array[null]
  Response Content Type
  
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers
- get /tickets/slas
  - Gets available ticket SLAs.
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers

get /tickets/slas/{sla_id}

Gets an SLA.

- get /tickets/workflows
  - Gets available ticket workflows.
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers

get /tickets/{ticket_id}

Gets a Ticket by Ticket ID.

post /tickets/{ticket_id}

Updates a ticket.

Parameters

Parameter	Description	Parameter Type	Data Type
person_id	ID of person to create ticket for.	query	integer
subject	A new subject for the ticket.	query	string
agent_id	Agent assigned to the ticket. Defaults to unassigned.	query	integer
agent_team_id	Agent team the ticket belongs to.	query	integer
attach[]	If you wish to upload a file with the ticket, you may send the request as multipart/form-data with the file data going to this parameter.	form	string
category_id	Category the ticket is in.	query	string
department_id	Department the ticket is in. If not specified, uses the default ticket department.	query	string
field[]	Value for the specified field.	query	string
language_id	Language the ticket is in.	query	string
priority_id	Priority of the ticket.	query	string
product_id	Product the ticket relates to.	query	string
status	Status the ticket is in. Possible values are awaiting_user, awaiting_agent, closed, hidden, resolved. Defaults to awaiting_agent.	query	string
urgency	Urgency of the ticket (1-10).	query	integer
workflow_id	Workflow for the ticket.	query	integer
flag	Sets the color of the flag for the this ticket for the API user. Use none to remove the flag.	query	string

delete /tickets/{ticket_id}

DELETEs a Ticket by Ticket ID.

post /tickets/{ticket_id}/claim

Assigns a ticket to the API user

get /tickets/{ticket_id}/labels

Gets the labels for a ticket.

post /tickets/{ticket_id}/labels

Adds a label to a ticket.

get /tickets/{ticket_id}/labels/{label}

Determines if the ticket has the label.

delete /tickets/{ticket_id}/labels/{label}

Removes a label from a ticket.

post /tickets/{ticket_id}/link/{link_ticket_id}

Links two tickets

post /tickets/{ticket_id}/lock

Locks a ticket.

get /tickets/{ticket_id}/logs

Gets all logs in a Ticket by Ticket ID.

post /tickets/{ticket_id}/merge/{merge_ticket_id}

Merges the two tickets

get /tickets/{ticket_id}/messages

Gets all messages in a ticket.

post /tickets/{ticket_id}/messages

Replies to a ticket.

Parameters

Parameter	Description	Parameter Type	Data Type
ticket_id	ID of the Ticket that needs to be searched.	path	integer
message	Message reply text.	query	string
attach[]	If you wish to upload a file with the ticket, you may send the request as multipart/form-data with the file data going to this parameter.	query	string
attach_id[]	The ID of an already uploaded file to include with the ticket.	query	string
is_note	If true, sets the reply as a note, rather than a public reply. Defaults to false.	query	boolean
message_as_agent	If true, the message is considered to be written by the API agent rather than the ticket owner. Defaults to false.	query	boolean
message_is_html	If true, the message parameter is treated as HTML.	query	boolean
suppress_user_notify	If true, suppresses user notification of the reply. Defaults to false.	query	boolean
person_id	Message author	query	integer

Error Status Codes

HTTP Status Code	Reason
404	Ticket not found

get /tickets/{ticket_id}/messages/{message_id}

Gets the specific message

get /tickets/{ticket_id}/messages/{message_id}/details

Gets a specific message's details

get /tickets/{ticket_id}/participants

Gets the participants in a ticket.

post /tickets/{ticket_id}/participants

Adds a participant to a ticket.

get /tickets/{ticket_id}/participants/{participant_id}

Determines if a person is participating in a ticket.

delete /tickets/{ticket_id}/participants/{participant_id}

Removes a participant from a ticket.

get /tickets/{ticket_id}/slas

Gets a list of automatically applied SLAs for a ticket.

post /tickets/{ticket_id}/slas

Adds an SLA to the automatically applied SLAs for a ticket.

get /tickets/{ticket_id}/slas/{sla_id}

Determines if a ticket SLA exists for a ticket.

delete /tickets/{ticket_id}/slas/{sla_id}

Deletes a ticket SLA for a ticket.

post /tickets/{ticket_id}/spam

Marks a ticket as spam.

post /tickets/{ticket_id}/split

Splits messages from a ticket into a new one.

get /tickets/{ticket_id}/tasks

Gets the tasks for a ticket.

post /tickets/{ticket_id}/tasks

Create a task for a ticket.

post /tickets/{ticket_id}/undelete

Undeletes a Ticket by Ticket ID.

post /tickets/{ticket_id}/unlock

unLocks a ticket.

post /tickets/{ticket_id}/unspam

Removes spam indicator from a ticket

Parameter	Description	Parameter Type	Data Type
category_id	ID of the category to look for.	path	integer
title	New Title of the category.	path	integer
parent_id	New ID of the category's parent. Use 0 for no parent.	query	integer
display_order	New Order of display of categories. Lower numbers will be displayed first.	query	integer

Parameter	Description	Parameter Type	Data Type
download_id	ID of the download that needs to be searched.	path	integer
content	Text of the comment.	query	integer
person_id	ID of the person that owns the comment. If not provided, defaults to the agent making the request.	query	integer
status	Status of the comment. Defaults to visible.	query	string

Parameter	Value	Description	Parameter Type	Data Type
title		Title of the download.	query	string
content		Content of the download. Marked up using HTML.	query	string
category_id		Category of the download.	query	integer
label[]		Comma seperated list of Labels to apply to the download.	query	string
status		Status of the download. Defaults to new if not overridden by this or status_category_id.	query	integer
attach	Parameter content type:	Attached file that represents the download. See the API Basics for more information on sending files to the API. Required if no attach_id is provided.	body	string
attach_id		The ID of an already uploaded file to include with the download. Required if no attach value is provided.	query	integer

Parameter	Value	Description	Parameter Type	Data Type
feedback_id		ID of the feedback that needs to be searched.	path	integer
file	Parameter content type:	Attached file to include with the feedback. See the API Basics for more information on sending files to the API. Required if no attach_id is provided.	body	string
attach_id		The ID of an already uploaded file to include with the feedback. Required if no attach value is provided.	query	integer

Parameter	Value	Description	Parameter Type	Data Type
feedback_id		ID of the first Feedback	path	integer
other_feedback_id		ID of the second Feedback	path	integer

Parameter	Description	Parameter Type	Data Type
title	Title of the feedback.	query	string
content	Content of the feedback. Marked up using HTML.	query	string
category_id	Category of the feedback.	query	integer
label[]	Comma seperated list of Labels to apply to the feedback.	query	string
status	Status of the feedback. Defaults to new if not overridden by this or status_category_id.	query	integer
status_category_id	Status category of the feedback.	query	string
user_category_id	User category of the feedback.	query	string

Parameter	Description	Parameter Type	Data Type
feedback_id	ID of the feedback the needs to be updated.	query	string
title	Title of the feedback.	query	string
content	Content of the feedback. Marked up using HTML.	query	string
category_id	Category of the feedback.	query	integer
label[]	Comma seperated list of Labels to apply to the feedback.	query	string
status	Status of the feedback. Defaults to new if not overridden by this or status_category_id.	query	integer
status_category_id	Status category of the feedback.	query	string
user_category_id	User category of the feedback.	query	string

Parameter	Value	Description	Parameter Type	Data Type
definition		Definition of given words.	query	string
word[]		Comma seperated list of words to associate with this definition.	query	string

Parameter	Description	Parameter Type	Data Type
title	Title of the category.	query	string
parent_id	ID of the category's parent. Use 0 for no parent.	query	integer
display_order	Order of display of categories. Lower numbers will be displayed first.	query	integer
usergroup_id[]	ID of usergroup that has access. If not provided, defaults to all users.	query	integer

Parameter	Description	Parameter Type	Data Type
category_id	ID of the category that needs to be updated.	path	integer
title	Title of the category.	query	string
parent_id	ID of the category's parent. Use 0 for no parent.	query	integer
display_order	Order of display of categories. Lower numbers will be displayed first.	query	integer
usergroup_id[]	ID of usergroup that has access. If not provided, defaults to all users.	query	integer

Parameter	Description	Parameter Type	Data Type
category_id	ID of the category that needs to be searched.	path	integer
order	Order of the results. Defaults to the publishing date.	query	integer
cache_id	If provided, cached results from this result set are used. If it cannot be found or used, the other constraints provided will be used to create a new result set.	query	integer
page	The page number of the results to fetch.	query	integer

Parameter	Value	Description	Parameter Type	Data Type
article_id		ID of the article that needs to be searched.	path	integer
attach	Parameter content type:	Attached file that represents the article. See the API Basics for more information on sending files to the API. Required if no attach_id is provided.	body	string
attach_id		The ID of an already uploaded file to include with the article. Required if no attach value is provided.	query	integer

Parameter	Description	Parameter Type	Data Type
category_id	Category ID that needs to be searched	query	integer
category_id_specific	Specific Category ID that needs to be searched	query	integer
label	News label that needs to be searched	query	string
status	News status that needs to be searched	query	string

Parameter	Value	Description	Parameter Type	Data Type
category_id		ID of the news category where the new group needs to be added	path	integer
id		ID of the group to add access for.	path	integer

Parameter	Value	Description	Parameter Type	Data Type
category_id		ID of the news category that needs to be checked	path	integer
group_id		ID of the group that needs to be checked	path	integer

Parameter	Description	Parameter Type	Data Type
news_id	ID of the news item that needs to be updated	path	integer
title	Updated title of the News Item	form	string
status	Updated status of the News Item	form	string
date_published	Updated published date of the News Item	form	string
content	Updated content of the News Item	form	string
category_id	Updated category_id of the News Item	form	integer

Parameter	Description	Parameter Type	Data Type
news_id	ID of the news item that needs to be searched for comments	path	integer
content	Comment content	query	string
person_id	ID of the person making the comment	query	integer
status	status of the comment	query	integer

Parameter	Description	Parameter Type	Data Type
name	Name of the organization.	query	string
contact_data[#]	Components of a contact detail to add. See the Setting Contact Data organization for more information.	query	string
field[#]	Value for the specified custom organization field.	query	string
group_id[]	ID of a usergroup to add this organization to.	query	string
label[]	Label to apply to the ticket.	query	string
summary	Summary of the organization's details.	query	string

Parameter	Description	Parameter Type	Data Type
organization_id	ID of the organization that needs to be updated.	path	integer
name	Name of the organization.	query	string
field[#]	Value for the specified custom organization field.	query	string
summary	Summary of the organization's details.	query	string

Parameter	Description	Parameter Type	Data Type
email	The email address of the user to authenticate. Alternatively, specify the username instead.	query	string
username	The username of the user to authenticate. Alternatively, specify the email instead.	query	string
password	The user password	query	string

activity : Operations about activity

Response Class

Parameters

Request URL

Response Body

Response Code

Response Headers

Response Class

Parameters

Request URL

Response Body

Response Code

Response Headers

agent_groups : Operations about agent groups

Response Class

Request URL

Response Body

Response Code

Response Headers

Response Class

Parameters

Request URL

Response Body

Response Code

Response Headers

Response Class

Parameters

Request URL

Response Body

Response Code

Response Headers

Response Class

Parameters

Request URL

Response Body

Response Code

Response Headers

Response Class

Parameters

Request URL

Response Body

Response Code

Response Headers

agents : Operations about agents

Implementation Notes

Response Class

Parameters

Request URL

Response Body

Response Code

Response Headers

Response Class

Parameters

Request URL

Response Body

Response Code

Response Headers

Response Class

Request URL

Response Body

Response Code

Response Headers

Response Class

Parameters

Request URL

Response Body

Response Code

Response Headers

Response Class

Parameters

Request URL

Response Body

Response Code

Response Headers

Response Class

Parameters

Request URL

Response Body

Response Code

Response Headers

Parameter	Value	Description	Parameter Type	Data Type
person_id		ID of the person that needs to be searched.	path	integer
page		The page number of the results to fetch.	query	integer

Parameter	Description	Parameter Type	Data Type
assigned_agent_id	ID of agent assigned to the task.	query	integer
assigned_agent_team_id	ID of agent team assigned to the task.	query	integer
date_due	Unix timestamp of when the task is due.	query	integer
label[]	Comma seperated list of Labels to apply to the task.	query	string
ticket_id	If specified, the ID of the ticket this task should be associated with.	query	integer
title	Title of the task.	query	string
visibility	0 for private, 1 for public.	query	boolean

Parameter	Description	Parameter Type	Data Type
task_id	ID of the task that needs to be updated	path	integer
assigned_agent_id	Updated ID of agent assigned to the task.	query	integer
assigned_agent_team_id	Updated ID of agent team assigned to the task.	query	integer
completed	Sets the completed state for the task.	query	boolean

Parameter	Value	Description	Parameter Type	Data Type
task_id		ID of the task that needs to be searched.	path	integer
ticket_id		ID of ticket to create association with.	query	integer

Parameter	Value	Description	Parameter Type	Data Type
task_id		ID of the task that needs to be checked.	path	integer
association_id		ID of the association that needs to be checked.	path	integer

Parameter	Description	Parameter Type	Data Type
title	Escalation name	query	string
event_trigger	Event trigger name	query	string
event_trigger_time	When to run event_trigger	query	integer
terms	Criteria for trigger run	query	string
terms_any	Filter	query	string
actions	Array of actions to perform	query	string

Parameter	Value	Description	Parameter Type	Data Type
id		Custom field ID	path	integer
is_enabled		Enabled marker	path	boolean

Parameter	Description	Parameter Type	Data Type
id	ticket id	path	integer
filter.title	Title for this filter	query	string
filter.is_global	ticket global flag	query	boolean
filter.person_id	Added person identificator	query	integer
filter.agent_team_id	Agent team identificator	query	integer
filter.terms		query	integer[]

Parameter	Description	Parameter Type	Data Type
dep_id	Department ID	path	integer
layout[user]	Layout user	query	string
layout[agent]	Layout agent	query	string

Parameter	Description	Parameter Type	Data Type
title	Macros name	query	string
is_global	Mark/unmark macros as global	query	boolean
person_id	Set macros owner	query	integer