Deskpro MCP by usefulapi is an MCP server published by io.usefulapi, hosted at deskpro.usefulapi.io. When last checked on 2026-11-21 it was working: it answers and lists its tools. It declares 20 tools, including deskpro_get_me, deskpro_list_tickets, deskpro_get_ticket, deskpro_list_ticket_messages, deskpro_list_people.
Search tickets, people, organizations and KB articles in Deskpro, and create tickets and replies.
4,276 connections through 5 shared values. Tap any node.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Inferred from the host name and headers: what a server runs on, not who runs it.
Return who the API key acts as — the auth method, the bound person id and their profile. A cheap way to confirm the helpdesk URL and key are right. Deskpro: GET /api/v2/me.
No parameters.
{
"name": "deskpro_get_me",
"title": "Get the authenticated agent",
"description": "Return who the API key acts as — the auth method, the bound person id and their profile. A cheap way to confirm the helpdesk URL and key are right. Deskpro: GET /api/v2/me.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"title": "Get the authenticated agent",
"readOnlyHint": true
}
}List tickets, filtered by status, assigned agent, requester, organization, department or labels, and sorted. Returns ticket objects (id, ref, subject, ticket_status, agent, person, department, urgency, labels, dates) plus pagination meta. Deskpro: GET /api/v2/tickets.
| Parameter | Type | Description |
|---|---|---|
| ids | string | Fetch exactly these ticket ids (comma-separated). |
| page | integer | Page number, starting at 1. |
| agent | integer | Only tickets assigned to this agent id. |
| count | integer | Results per page, 1-200. |
| labels | string | Only tickets with these labels (comma-separated). |
| person | integer | Only tickets raised by this person id. |
| status | string | Only tickets in this status, e.g. awaiting_agent, awaiting_user, pending, resolved. |
| include | string | Comma-separated related object types to side-load into the response's `linked` section, e.g. person,agent,department,organization. |
| order_by | string | Sort field. |
| department | integer | Only tickets in this department id. |
| group_sort | string | Sort direction. |
| organization |
Fetch a single ticket by id, with its subject, status, assignment, requester, labels, custom fields, SLA state and timing. A merged ticket redirects to the ticket it was merged into. Deskpro: GET /api/v2/tickets/{id}.
| Parameter | Type | Description |
|---|---|---|
| include | string | Comma-separated related object types to side-load into the response's `linked` section, e.g. person,agent,department,organization. |
| ticket_id * | integer | The ticket's numeric id. |
{
"name": "deskpro_get_ticket",
"title": "Get one ticket",
"description": "Fetch a single ticket by id, with its subject, status, assignment, requester, labels, custom fields, SLA state and timing. A merged ticket redirects to the ticket it was merged into. Deskpro: GET /api/v2/tickets/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"ticket_id"
],
"properties": {
"include": {
"type": "string",
"description": "Comma-separated related object types to side-load into the response's `linked` section, e.g. person,agent,department,organization."
},
"ticket_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The ticket's numeric id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get one ticket",
"readOnlyHint": true
}
}List the conversation on one ticket — every reply and agent note, with its author, date, is_agent_note flag and HTML body. Deskpro: GET /api/v2/tickets/{id}/messages.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, starting at 1. |
| count | integer | Results per page, 1-200. |
| include | string | Comma-separated related object types to side-load into the response's `linked` section, e.g. person,agent,department,organization. |
| ticket_id * | integer | The ticket's numeric id. |
{
"name": "deskpro_list_ticket_messages",
"title": "List a ticket's messages",
"description": "List the conversation on one ticket — every reply and agent note, with its author, date, is_agent_note flag and HTML body. Deskpro: GET /api/v2/tickets/{id}/messages.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"ticket_id"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number, starting at 1."
},
"count": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Results per page, 1-200."
},
"include": {
"type": "string",
"description": "Comma-separated related object types to side-load into the response's `linked` section, e.g. person,agent,department,organization."
},
"ticket_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The ticket's numeric id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List a ticket's messages",
"readOnlyHint": true
}
}List people (end users and agents), searchable by name and filterable by email, organization or agent flag. Deskpro: GET /api/v2/people.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, starting at 1. |
| count | integer | Results per page, 1-200. |
| search | string | Search on name. |
| include | string | Comma-separated related object types to side-load into the response's `linked` section, e.g. person,agent,department,organization. |
| is_agent | boolean | true for agents only, false for end users only. |
| order_by | string | Sort field. |
| order_dir | string | Sort direction. |
| organization | string | Only members of these organization ids (comma-separated). |
| primary_email | string | Only the person with this primary email. |
{
"name": "deskpro_list_people",
"title": "List people",
"description": "List people (end users and agents), searchable by name and filterable by email, organization or agent flag. Deskpro: GET /api/v2/people.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number, starting at 1."
},
"count": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Results per page, 1-200."
},
"search": {
"type": "string",
"description": "Search on name."
},
"include": {
"type": "string",
"description": "Comma-separated related object types to side-load into the response's `linked` section, e.g. person,agent,department,organization."
},
"is_agent": {
"type": "boolean",
"description": "true for agents only, false for end users only."
},
"order_by": {
"enum": [
"id",
"date_created",
"date_last_login",
"name",
"first_name",
"last_name",
"primary_email",
"timezone",
"organization"
],
"type": "string",
"description": "Sort field."
},
"order_dir": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction."
},
"organization": {
"type": "string",
"pattern": "^\\d+(,\\d+)*$",
"description": "Only members of these organization ids (comma-separated)."
},
"primary_email": {
"type": "string",
"description": "Only the person with this primary email."
}
}
},
"annotations": {
"title": "List people",
"readOnlyHint": true
}
}Fetch a single person by id — name, emails, phone numbers, organization, labels, custom fields and ticket count. Deskpro: GET /api/v2/people/{id}.
| Parameter | Type | Description |
|---|---|---|
| include | string | Comma-separated related object types to side-load into the response's `linked` section, e.g. person,agent,department,organization. |
| person_id * | integer | The person's numeric id. |
{
"name": "deskpro_get_person",
"title": "Get one person",
"description": "Fetch a single person by id — name, emails, phone numbers, organization, labels, custom fields and ticket count. Deskpro: GET /api/v2/people/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"person_id"
],
"properties": {
"include": {
"type": "string",
"description": "Comma-separated related object types to side-load into the response's `linked` section, e.g. person,agent,department,organization."
},
"person_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The person's numeric id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get one person",
"readOnlyHint": true
}
}List the tickets raised by one person — their support history. Deskpro: GET /api/v2/people/{id}/tickets.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, starting at 1. |
| count | integer | Results per page, 1-200. |
| person_id * | integer | The person's numeric id. |
{
"name": "deskpro_list_person_tickets",
"title": "List a person's tickets",
"description": "List the tickets raised by one person — their support history. Deskpro: GET /api/v2/people/{id}/tickets.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"person_id"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number, starting at 1."
},
"count": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Results per page, 1-200."
},
"person_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The person's numeric id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List a person's tickets",
"readOnlyHint": true
}
}List customer organizations, filterable by name or labels. Deskpro: GET /api/v2/organizations.
| Parameter | Type | Description |
|---|---|---|
| name | string | Only the organization with this name. |
| page | integer | Page number, starting at 1. |
| count | integer | Results per page, 1-200. |
| labels | string | Only organizations with these labels (comma-separated). |
| search | string | Search on name. |
| include | string | Comma-separated related object types to side-load into the response's `linked` section, e.g. person,agent,department,organization. |
{
"name": "deskpro_list_organizations",
"title": "List organizations",
"description": "List customer organizations, filterable by name or labels. Deskpro: GET /api/v2/organizations.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"description": "Only the organization with this name."
},
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number, starting at 1."
},
"count": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Results per page, 1-200."
},
"labels": {
"type": "string",
"description": "Only organizations with these labels (comma-separated)."
},
"search": {
"type": "string",
"description": "Search on name."
},
"include": {
"type": "string",
"description": "Comma-separated related object types to side-load into the response's `linked` section, e.g. person,agent,department,organization."
}
}
},
"annotations": {
"title": "List organizations",
"readOnlyHint": true
}
}Fetch a single organization by id — name, summary, email domains, labels, custom fields and ticket count. Deskpro: GET /api/v2/organizations/{id}.
| Parameter | Type | Description |
|---|---|---|
| include | string | Comma-separated related object types to side-load into the response's `linked` section, e.g. person,agent,department,organization. |
| organization_id * | integer | The organization's numeric id. |
{
"name": "deskpro_get_organization",
"title": "Get one organization",
"description": "Fetch a single organization by id — name, summary, email domains, labels, custom fields and ticket count. Deskpro: GET /api/v2/organizations/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"organization_id"
],
"properties": {
"include": {
"type": "string",
"description": "Comma-separated related object types to side-load into the response's `linked` section, e.g. person,agent,department,organization."
},
"organization_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The organization's numeric id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get one organization",
"readOnlyHint": true
}
}List the tickets belonging to one organization. Deskpro: GET /api/v2/organizations/{id}/tickets.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, starting at 1. |
| count | integer | Results per page, 1-200. |
| organization_id * | integer | The organization's numeric id. |
{
"name": "deskpro_list_organization_tickets",
"title": "List an organization's tickets",
"description": "List the tickets belonging to one organization. Deskpro: GET /api/v2/organizations/{id}/tickets.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"organization_id"
],
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number, starting at 1."
},
"count": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Results per page, 1-200."
},
"organization_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The organization's numeric id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List an organization's tickets",
"readOnlyHint": true
}
}List knowledgebase articles, filterable by category, status and author. Deskpro: GET /api/v2/articles.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, starting at 1. |
| count | integer | Results per page, 1-200. |
| author | string | Only articles by this author id, or 'me' for the key's agent. |
| status | string | Only articles in this status. |
| category | integer | Only articles in this category id. |
| order_by | string | Sort field. |
{
"name": "deskpro_list_articles",
"title": "List knowledgebase articles",
"description": "List knowledgebase articles, filterable by category, status and author. Deskpro: GET /api/v2/articles.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number, starting at 1."
},
"count": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Results per page, 1-200."
},
"author": {
"type": "string",
"pattern": "^(\\d+|me)$",
"description": "Only articles by this author id, or 'me' for the key's agent."
},
"status": {
"enum": [
"published",
"archived",
"hidden"
],
"type": "string",
"description": "Only articles in this status."
},
"category": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Only articles in this category id."
},
"order_by": {
"enum": [
"date_created",
"date_updated",
"person"
],
"type": "string",
"description": "Sort field."
}
}
},
"annotations": {
"title": "List knowledgebase articles",
"readOnlyHint": true
}
}Fetch a single knowledgebase article by id — title, content, status, categories and labels. Deskpro: GET /api/v2/articles/{id}.
| Parameter | Type | Description |
|---|---|---|
| article_id * | integer | The article's numeric id. |
{
"name": "deskpro_get_article",
"title": "Get one article",
"description": "Fetch a single knowledgebase article by id — title, content, status, categories and labels. Deskpro: GET /api/v2/articles/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"article_id"
],
"properties": {
"article_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The article's numeric id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get one article",
"readOnlyHint": true
}
}List the ticket departments (id, title, parent, whether tickets/chat are enabled) — needed to route a new ticket. Deskpro: GET /api/v2/ticket_departments.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, starting at 1. |
| count | integer | Results per page, 1-200. |
{
"name": "deskpro_list_departments",
"title": "List ticket departments",
"description": "List the ticket departments (id, title, parent, whether tickets/chat are enabled) — needed to route a new ticket. Deskpro: GET /api/v2/ticket_departments.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number, starting at 1."
},
"count": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Results per page, 1-200."
}
}
},
"annotations": {
"title": "List ticket departments",
"readOnlyHint": true
}
}List the helpdesk's agents (id, name, email, online state) — needed to assign a ticket. Deskpro: GET /api/v2/agents.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, starting at 1. |
| count | integer | Results per page, 1-200. |
| online | any | 1 = online only, 0 = offline only, -1 = both. |
{
"name": "deskpro_list_agents",
"title": "List agents",
"description": "List the helpdesk's agents (id, name, email, online state) — needed to assign a ticket. Deskpro: GET /api/v2/agents.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number, starting at 1."
},
"count": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Results per page, 1-200."
},
"online": {
"anyOf": [
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 0
},
{
"type": "number",
"const": -1
}
],
"description": "1 = online only, 0 = offline only, -1 = both."
}
}
},
"annotations": {
"title": "List agents",
"readOnlyHint": true
}
}List the ticket statuses and custom sub-statuses (status_type, status_code, title) configured on the helpdesk. Deskpro: GET /api/v2/ticket_statuses.
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, starting at 1. |
| count | integer | Results per page, 1-200. |
| status_type | string | Only statuses of this type. |
{
"name": "deskpro_list_ticket_statuses",
"title": "List ticket statuses",
"description": "List the ticket statuses and custom sub-statuses (status_type, status_code, title) configured on the helpdesk. Deskpro: GET /api/v2/ticket_statuses.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number, starting at 1."
},
"count": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Results per page, 1-200."
},
"status_type": {
"enum": [
"pending",
"awaiting_agent",
"awaiting_user",
"resolved"
],
"type": "string",
"description": "Only statuses of this type."
}
}
},
"annotations": {
"title": "List ticket statuses",
"readOnlyHint": true
}
}Quick search across tickets, people, organizations, articles, news, downloads, community topics and chats; results are grouped by type. Deskpro: GET /api/v2/search.
| Parameter | Type | Description |
|---|---|---|
| q * | string | The search term. |
| types | string | Comma-separated types to search, e.g. ticket,person,organization. Omit for all. |
{
"name": "deskpro_search",
"title": "Search the helpdesk",
"description": "Quick search across tickets, people, organizations, articles, news, downloads, community topics and chats; results are grouped by type. Deskpro: GET /api/v2/search.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"minLength": 1,
"description": "The search term."
},
"types": {
"type": "string",
"pattern": "^(article|download|community|news|ticket|person|agent|organization|chat_conversation)(,(article|download|community|news|ticket|person|agent|organization|chat_conversation))*$",
"description": "Comma-separated types to search, e.g. ticket,person,organization. Omit for all."
}
}
},
"annotations": {
"title": "Search the helpdesk",
"readOnlyHint": true
}
}Open a new ticket for a requester (by person id, or by email — Deskpro creates the person if the email is new) with a first message. Depending on the helpdesk's triggers this may email the requester. Returns the created ticket. Deskpro: POST /api/v2/tickets.
| Parameter | Type | Description |
|---|---|---|
| labels | array | Labels to set. |
| status | string | Ticket status: awaiting_agent, awaiting_user, pending or resolved, optionally with a custom sub-status id suffix (e.g. pending.5 — see deskpro_list_ticket_statuses). The hidden (deleted/spam) status is not settable here. |
| message * | string | The first message body. |
| subject * | string | The ticket subject. |
| urgency | integer | Urgency 1-10. |
| agent_id | integer | Assign to this agent id. |
| person_id | integer | The requester's person id. |
| agent_team | integer | Assign to this agent team id. |
| department | integer | Department id (see deskpro_list_departments). |
| person_name |
Change a ticket's subject, status, assignment, department, organization, urgency, hold state or labels. Only the fields you pass are sent. Reversible by updating again. Cannot set the hidden (deleted/spam) status. Deskpro: PUT /api/v2/tickets/{id}.
| Parameter | Type | Description |
|---|---|---|
| labels | array | The ticket's labels. |
| status | string | Ticket status: awaiting_agent, awaiting_user, pending or resolved, optionally with a custom sub-status id suffix (e.g. pending.5 — see deskpro_list_ticket_statuses). The hidden (deleted/spam) status is not settable here. |
| is_hold | boolean | Put the ticket on hold (true) or take it off hold (false). |
| subject | string | New subject. |
| urgency | integer | Urgency 1-10. |
| agent_id | integer | Assign to this agent id. |
| ticket_id * | integer | The ticket's numeric id. |
| agent_team | integer | Assign to this agent team id. |
| department | integer | Move to this department id. |
| organization | integer |
Add a message to a ticket as the key's agent. With is_note=true it is an internal agent note (not shown to the requester); with is_note=false it is a REPLY that the helpdesk emails to the requester — that cannot be unsent. Deskpro: POST /api/v2/tickets/{id}/messages.
| Parameter | Type | Description |
|---|---|---|
| format | string | Format of the body. Default text. |
| is_note * | boolean | true = internal agent note; false = public reply to the requester. |
| message * | string | The message body. |
| ticket_id * | integer | The ticket's numeric id. |
{
"name": "deskpro_add_ticket_message",
"title": "Reply to a ticket or add a note",
"description": "Add a message to a ticket as the key's agent. With is_note=true it is an internal agent note (not shown to the requester); with is_note=false it is a REPLY that the helpdesk emails to the requester — that cannot be unsent. Deskpro: POST /api/v2/tickets/{id}/messages.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"ticket_id",
"message",
"is_note"
],
"properties": {
"format": {
"enum": [
"html",
"text"
],
"type": "string",
"description": "Format of the body. Default text."
},
"is_note": {
"type": "boolean",
"description": "true = internal agent note; false = public reply to the requester."
},
"message": {
"type": "string",
"minLength": 1,
"description": "The message body."
},
"ticket_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The ticket's numeric id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Reply to a ticket or add a note",
"destructiveHint": true
}
}Create a customer organization. Email domains auto-associate people with matching addresses. Deskpro: POST /api/v2/organizations.
| Parameter | Type | Description |
|---|---|---|
| name * | string | The organization's name. |
| labels | array | Labels to set. |
| summary | string | A short description. |
| email_domains | array | Email domains belonging to the organization, e.g. example.com. |
{
"name": "deskpro_create_organization",
"title": "Create an organization",
"description": "Create a customer organization. Email domains auto-associate people with matching addresses. Deskpro: POST /api/v2/organizations.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"description": "The organization's name."
},
"labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Labels to set."
},
"summary": {
"type": "string",
"description": "A short description."
},
"email_domains": {
"type": "array",
"items": {
"type": "string"
},
"description": "Email domains belonging to the organization, e.g. example.com."
}
}
},
"annotations": {
"title": "Create an organization",
"destructiveHint": true
}
}Tools for Deskpro, hosted by usefulapi.io. If the user is new or asks what this server can do, suggest requests such as: "Which support tickets are still open and who is assigned to each?"; "Show me the full conversation on my oldest open ticket."; "How many tickets has Acme Ltd raised, and what are they about?". Read-only tools never change data; ask the user before a tool that creates, changes or deletes Deskpro data. Free plan: 50 tool calls per month. Run deskpro_usage_status to see the calls used this month. If the user asks for something none of these tools can do, tell the user and, with their OK, run deskpro_request_feature to record the request. Paid plans: Pro (10,000 tool calls a month, $9/month or $90/year, for normal use) and Pro+ (100,000 tool calls a month, $39/month or $390/year, for automations and heavy use). A plan can be cancelled at any time and then runs to the end of the paid period, so it also suits a one-time job. When the user wants more calls or reaches the limit, run deskpro_upgrade without a plan: it returns both plans, each with a payment link for the user to open. deskpro_cancel_subscription cancels Pro at the end of the paid period.
Names, descriptions and schemas were written by the server and are shown as data.
Pattern matches on what the server declares. They show what it says it can do, not what it does.
None yet. Changes appear after a server's second daily check.
| integer |
| Only tickets from this organization id. |
{
"name": "deskpro_list_tickets",
"title": "List tickets",
"description": "List tickets, filtered by status, assigned agent, requester, organization, department or labels, and sorted. Returns ticket objects (id, ref, subject, ticket_status, agent, person, department, urgency, labels, dates) plus pagination meta. Deskpro: GET /api/v2/tickets.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"ids": {
"type": "string",
"pattern": "^\\d+(,\\d+)*$",
"description": "Fetch exactly these ticket ids (comma-separated)."
},
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number, starting at 1."
},
"agent": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Only tickets assigned to this agent id."
},
"count": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Results per page, 1-200."
},
"labels": {
"type": "string",
"description": "Only tickets with these labels (comma-separated)."
},
"person": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Only tickets raised by this person id."
},
"status": {
"type": "string",
"description": "Only tickets in this status, e.g. awaiting_agent, awaiting_user, pending, resolved."
},
"include": {
"type": "string",
"description": "Comma-separated related object types to side-load into the response's `linked` section, e.g. person,agent,department,organization."
},
"order_by": {
"enum": [
"id",
"urgency",
"date_created",
"date_status",
"date_last_agent_reply",
"date_last_user_reply",
"date_last_reply",
"date_user_waiting",
"total_user_waiting",
"subject",
"status"
],
"type": "string",
"description": "Sort field."
},
"department": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Only tickets in this department id."
},
"group_sort": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction."
},
"organization": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Only tickets from this organization id."
}
}
},
"annotations": {
"title": "List tickets",
"readOnlyHint": true
}
}| string |
| The requester's name, for a new person. |
| organization | integer | Organization id. |
| person_email | string | The requester's email (used when person_id is not given). |
| message_format | string | Format of the message body. Default text. |
{
"name": "deskpro_create_ticket",
"title": "Create a ticket",
"description": "Open a new ticket for a requester (by person id, or by email — Deskpro creates the person if the email is new) with a first message. Depending on the helpdesk's triggers this may email the requester. Returns the created ticket. Deskpro: POST /api/v2/tickets.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"subject",
"message"
],
"properties": {
"labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Labels to set."
},
"status": {
"type": "string",
"pattern": "^(awaiting_agent|awaiting_user|pending|resolved)(\\.\\d+)?$",
"description": "Ticket status: awaiting_agent, awaiting_user, pending or resolved, optionally with a custom sub-status id suffix (e.g. pending.5 — see deskpro_list_ticket_statuses). The hidden (deleted/spam) status is not settable here."
},
"message": {
"type": "string",
"minLength": 1,
"description": "The first message body."
},
"subject": {
"type": "string",
"minLength": 1,
"description": "The ticket subject."
},
"urgency": {
"type": "integer",
"maximum": 10,
"minimum": 1,
"description": "Urgency 1-10."
},
"agent_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Assign to this agent id."
},
"person_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The requester's person id.",
"exclusiveMinimum": 0
},
"agent_team": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Assign to this agent team id."
},
"department": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Department id (see deskpro_list_departments)."
},
"person_name": {
"type": "string",
"description": "The requester's name, for a new person."
},
"organization": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Organization id."
},
"person_email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"description": "The requester's email (used when person_id is not given)."
},
"message_format": {
"enum": [
"html",
"text"
],
"type": "string",
"description": "Format of the message body. Default text."
}
}
},
"annotations": {
"title": "Create a ticket",
"destructiveHint": true
}
}| Set the organization id. |
{
"name": "deskpro_update_ticket",
"title": "Update a ticket",
"description": "Change a ticket's subject, status, assignment, department, organization, urgency, hold state or labels. Only the fields you pass are sent. Reversible by updating again. Cannot set the hidden (deleted/spam) status. Deskpro: PUT /api/v2/tickets/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"ticket_id"
],
"properties": {
"labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "The ticket's labels."
},
"status": {
"type": "string",
"pattern": "^(awaiting_agent|awaiting_user|pending|resolved)(\\.\\d+)?$",
"description": "Ticket status: awaiting_agent, awaiting_user, pending or resolved, optionally with a custom sub-status id suffix (e.g. pending.5 — see deskpro_list_ticket_statuses). The hidden (deleted/spam) status is not settable here."
},
"is_hold": {
"type": "boolean",
"description": "Put the ticket on hold (true) or take it off hold (false)."
},
"subject": {
"type": "string",
"minLength": 1,
"description": "New subject."
},
"urgency": {
"type": "integer",
"maximum": 10,
"minimum": 1,
"description": "Urgency 1-10."
},
"agent_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Assign to this agent id."
},
"ticket_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The ticket's numeric id.",
"exclusiveMinimum": 0
},
"agent_team": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Assign to this agent team id."
},
"department": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Move to this department id."
},
"organization": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Set the organization id."
}
}
},
"annotations": {
"title": "Update a ticket",
"destructiveHint": true
}
}