Servers Playground How we check Add a server Log in

eDesk MCP by usefulapi

Working · 2.2 s

io.usefulapi/edeskv1.6.0 Domain verified

Work with eDesk support tickets, replies, internal notes, contacts and sales orders.

Sales & CRM

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://edesk.usefulapi.io/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

edesk_add_order_note Destructive

WRITE: add an internal note to a sales order (never sent to the customer). POST /order-notes.

textstring, required

The note text.

sales_order_idinteger, required

eDesk sales order id.

The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.

I understand, run it anyway

eDesk MCP by usefulapi MCP server | mcptry

Tools (18)

edesk_add_order_note

WRITE: add an internal note to a sales order (never sent to the customer). POST /order-notes.

destructive

Argument	Type	Description
text*	string	The note text.
sales_order_id*	integer	eDesk sales order id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "sales_order_id",
    "text"
  ],
  "properties": {
    "text": {
      "type": "string",
      "maxLength": 20000,
      "minLength": 1,
      "description": "The note text."
    },
    "sales_order_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "eDesk sales order id.",
      "exclusiveMinimum": 0
    }
  }
}

edesk_add_ticket_note

WRITE: add an internal note to a ticket. The note is for the team only and is never sent to the customer. POST /messages with type Note.

destructive

Argument	Type	Description
text*	string	The note text.
ticket_id*	integer	eDesk ticket id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "ticket_id",
    "text"
  ],
  "properties": {
    "text": {
      "type": "string",
      "maxLength": 20000,
      "minLength": 1,
      "description": "The note text."
    },
    "ticket_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "eDesk ticket id.",
      "exclusiveMinimum": 0
    }
  }
}

edesk_get_message

One ticket message or internal note by id (from a ticket's message ids): body, direction, type (Message or Note), author and attachments. GET /messages/{id}.

read-only

Argument	Type	Description
message_id*	integer	eDesk message id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "message_id"
  ],
  "properties": {
    "message_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "eDesk message id.",
      "exclusiveMinimum": 0
    }
  }
}

edesk_get_sales_order

One sales order by id with items, amounts, ship-to and bill-to addresses, tracking codes, delivery dates, the linked ticket id and order note ids. GET /sales-orders/{id}.

read-only

Argument	Type	Description
sales_order_id*	integer	eDesk sales order id (the sales_order_id on a ticket).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "sales_order_id"
  ],
  "properties": {
    "sales_order_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "eDesk sales order id (the sales_order_id on a ticket).",
      "exclusiveMinimum": 0
    }
  }
}

edesk_get_template

One reply template by id. GET /templates/{id}.

read-only

Argument	Type	Description
template_id*	integer	eDesk template id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "template_id"
  ],
  "properties": {
    "template_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "eDesk template id.",
      "exclusiveMinimum": 0
    }
  }
}

edesk_get_ticket

One ticket by id with its status, owner, tags, custom fields, linked sales order and the ids of its messages (read each with edesk_get_message). GET /tickets/{id}.

read-only

Argument	Type	Description
ticket_id*	integer	eDesk ticket id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "ticket_id"
  ],
  "properties": {
    "ticket_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "eDesk ticket id.",
      "exclusiveMinimum": 0
    }
  }
}

edesk_list_channels

List the sales channels connected to eDesk (Amazon, eBay, Shopify, email, ...) with id, type, name, country and currency. Use the ids to filter tickets and orders. GET /channels.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
items_per_page	integer	Results per page, 1-100 (default 25).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "items_per_page": {
      "type": "integer",
      "maximum": 100,
      "description": "Results per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    }
  }
}

edesk_list_contacts

Search the contacts (customers) of the helpdesk by free text, email, name, phone number or consumer id. Returns id, channel, full name, email and phone. GET /contacts.

read-only

Argument	Type	Description
name	string	Filter by full name.
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
email	string	Filter by email.
query	string	Free-text search.
consumer_id	integer	Filter by consumer id.
phone_number	string	Filter by phone number.
items_per_page	integer	Results per page, 1-100 (default 25).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Filter by full name."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "email": {
      "type": "string",
      "maxLength": 320,
      "minLength": 1,
      "description": "Filter by email."
    },
    "query": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Free-text search."
    },
    "consumer_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Filter by consumer id.",
      "exclusiveMinimum": 0
    },
    "phone_number": {
      "type": "string",
      "maxLength": 50,
      "minLength": 1,
      "description": "Filter by phone number."
    },
    "items_per_page": {
      "type": "integer",
      "maximum": 100,
      "description": "Results per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    }
  }
}

edesk_list_order_notes

List the internal notes attached to sales orders (id, sales order id, author, text, attachments). GET /order-notes.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
items_per_page	integer	Results per page, 1-100 (default 25).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "items_per_page": {
      "type": "integer",
      "maximum": 100,
      "description": "Results per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    }
  }
}

edesk_list_sales_orders

List the marketplace/store orders that eDesk holds, with status, items, amounts, addresses, tracking codes and the linked ticket id. Filter by status, channel, contact, marketplace order id, id range and created/updated dates. GET /sales-orders.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
id_to	integer	Only orders with an eDesk id less than or equal to this.
status	string	Only orders with this status.
id_from	integer	Only orders with an eDesk id greater than or equal to this.
order_by	string	Sort field.
channel_id	integer	Only orders from this channel.
contact_id	integer	Only orders of this contact.
created_after	string	Only orders created on or after this date, yyyy-mm-dd.
updated_after	string

edesk_list_tag_groups

List the tag groups that organize ticket tags. GET /tag-groups.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
items_per_page	integer	Results per page, 1-100 (default 25).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "items_per_page": {
      "type": "integer",
      "maximum": 100,
      "description": "Results per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    }
  }
}

edesk_list_tags

List ticket tags with id, name, color, active flag and tag group id. Use the ids in edesk_update_ticket (tag_ids). GET /tags.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
items_per_page	integer	Results per page, 1-100 (default 25).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "items_per_page": {
      "type": "integer",
      "maximum": 100,
      "description": "Results per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    }
  }
}

edesk_list_templates

List saved reply templates (id, name, subject, body text, channels, usage). GET /templates.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
items_per_page	integer	Results per page, 1-100 (default 25).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "items_per_page": {
      "type": "integer",
      "maximum": 100,
      "description": "Results per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    }
  }
}

edesk_list_tickets

List support tickets from all channels with subject, type, status, channel, owner, contact, linked sales order id, tag ids, message ids, reply count and AI classification. Filter by status, type, channel, contact, owner, sales order, seller (marketplace) order id and last-updated date. GET /tickets.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
type	string	Only tickets of this type.
status	string	Only tickets with this status.
order_by	string	Sort field.
channel_id	integer	Only tickets on this channel (see edesk_list_channels).
contact_id	integer	Only tickets of this contact (customer).
owner_user_id	integer	Only tickets assigned to this user.
updated_after	string	Only tickets last updated on or after this date, yyyy-mm-dd.
items_per_page

edesk_list_users

List the eDesk users (support agents) with id, name, email, username, role and active flag. Use the ids as ticket owners. GET /users.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
items_per_page	integer	Results per page, 1-100 (default 25).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "items_per_page": {
      "type": "integer",
      "maximum": 100,
      "description": "Results per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    }
  }
}

edesk_reply_to_ticket

WRITE, CUSTOMER-VISIBLE: send a reply on a ticket. eDesk queues it for delivery to the marketplace or email channel, so it cannot be recalled once queued. The audience is the channel's default: on a Mirakl channel it is the channel's "Default messages recipients" setting (customer, operator or both), and this API cannot choose recipients (use the eDesk reply box when they matter). Only call this when the user has approved the exact text and audience. If the call fails in transit, the reply may still be queued: check the ticket before retrying. Use edesk_add_ticket_note for an internal note. POST /messages with type Message.

destructive

Argument	Type	Description
text*	string	The reply text the customer will receive.
subject	string	Subject, for channels that use one (such as email).
ticket_id*	integer	eDesk ticket id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "ticket_id",
    "text"
  ],
  "properties": {
    "text": {
      "type": "string",
      "maxLength": 20000,
      "minLength": 1,
      "description": "The reply text the customer will receive."
    },
    "subject": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Subject, for channels that use one (such as email)."
    },
    "ticket_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "eDesk ticket id.",
      "exclusiveMinimum": 0
    }
  }
}

edesk_update_ticket

WRITE: change a ticket's status, owner (assignee), tags or subject. Only the fields you pass are sent. tag_ids is sent as given: read the ticket first (tags_ids) and include the tags to keep. Nothing is sent to the customer. PUT /tickets/{id}.

destructive

Argument	Type	Description
status	string	New status, e.g. Open, Pending or Closed.
subject	string	New subject.
tag_ids	array	Tag ids for the ticket (see edesk_list_tags).
ticket_id*	integer	eDesk ticket id.
owner_user_id	integer	User id to assign the ticket to (see edesk_list_users).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "ticket_id"
  ],
  "properties": {
    "status": {
      "enum": [
        "Scheduled",
        "Spam",
        "Unread",
        "Read",
        "Unpriority",
        "Priority",
        "Archived",
        "Open",
        "Pending",
        "Closed"
      ],
      "type": "string",
      "description": "New status, e.g. Open, Pending or Closed."
    },
    "subject": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "New subject."
    },
    "tag_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 100,
      "description": "Tag ids for the ticket (see edesk_list_tags)."
    },
    "ticket_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "eDesk ticket id.",
      "exclusiveMinimum": 0
    },
    "owner_user_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "User id to assign the ticket to (see edesk_list_users).",
      "exclusiveMinimum": 0
    }
  }
}

edesk_whoami

The eDesk user the API token belongs to: id, name, email, username, role and active flag. GET /whoami.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "id_to": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only orders with an eDesk id less than or equal to this.",
      "exclusiveMinimum": 0
    },
    "status": {
      "enum": [
        "OrderReceived",
        "PaymentReceived",
        "PaymentRejected",
        "PaymentAccepted",
        "OrderShipped",
        "InTransit",
        "Delivered",
        "Canceled",
        "Returned",
        "Hold"
      ],
      "type": "string",
      "description": "Only orders with this status."
    },
    "id_from": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only orders with an eDesk id greater than or equal to this.",
      "exclusiveMinimum": 0
    },
    "order_by": {
      "enum": [
        "id",
        "created_at",
        "last_updated_at"
      ],
      "type": "string",
      "description": "Sort field."
    },
    "channel_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only orders from this channel.",
      "exclusiveMinimum": 0
    },
    "contact_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only orders of this contact.",
      "exclusiveMinimum": 0
    },
    "created_after": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Only orders created on or after this date, yyyy-mm-dd."
    },
    "updated_after": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Only orders last updated on or after this date, yyyy-mm-dd."
    },
    "created_before": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Only orders created on or before this date, yyyy-mm-dd."
    },
    "items_per_page": {
      "type": "integer",
      "maximum": 100,
      "description": "Results per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "updated_before": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Only orders last updated on or before this date, yyyy-mm-dd."
    },
    "order_direction": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "description": "Sort direction."
    },
    "seller_order_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Only the order with this marketplace order id."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "type": {
      "enum": [
        "BuyerNotes",
        "Cancellation",
        "Chat",
        "Chatbot",
        "ContactBuyer",
        "ContactForm",
        "DefectiveItemReceived",
        "FeedbackReply",
        "Incident",
        "InvoiceRequest",
        "NegativeFeedback",
        "OfferQuery",
        "OrderAdjustment",
        "OrderClaim",
        "OrderQuery",
        "OrderShippingInquiry",
        "PaymentsQuery",
        "Presales",
        "ProductQuery",
        "PublicMessage",
        "Query",
        "Refund",
        "ResolutionCase",
        "ReturnRequest",
        "ReturnsQuery",
        "SampleQuery",
        "ShippingQuery",
        "SystemMessage",
        "WrongItemReceived"
      ],
      "type": "string",
      "description": "Only tickets of this type."
    },
    "status": {
      "enum": [
        "Scheduled",
        "Spam",
        "Unread",
        "Read",
        "Unpriority",
        "Priority",
        "Archived",
        "Open",
        "Pending",
        "Closed"
      ],
      "type": "string",
      "description": "Only tickets with this status."
    },
    "order_by": {
      "enum": [
        "id",
        "created_at",
        "last_updated_at"
      ],
      "type": "string",
      "description": "Sort field."
    },
    "channel_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only tickets on this channel (see edesk_list_channels).",
      "exclusiveMinimum": 0
    },
    "contact_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only tickets of this contact (customer).",
      "exclusiveMinimum": 0
    },
    "owner_user_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only tickets assigned to this user.",
      "exclusiveMinimum": 0
    },
    "updated_after": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Only tickets last updated on or after this date, yyyy-mm-dd."
    },
    "items_per_page": {
      "type": "integer",
      "maximum": 100,
      "description": "Results per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "sales_order_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only tickets linked to this eDesk sales order id.",
      "exclusiveMinimum": 0
    },
    "updated_before": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Only tickets last updated on or before this date, yyyy-mm-dd."
    },
    "order_direction": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "description": "Sort direction."
    },
    "seller_order_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Only tickets for this marketplace order id (the id the marketplace shows)."
    }
  }
}