# NeetoDesk Docs

> Developer docs for NeetoDesk: the REST API, the CLI and the MCP server.

- [NeetoDesk API](https://apidocs.neetodesk.com/api/introduction.md): Welcome to the NeetoDesk API documentation.
- [Workspace subdomain](https://apidocs.neetodesk.com/api/workspace-subdomain.md): Learn how to find your workspace subdomain.
- [Authentication](https://apidocs.neetodesk.com/api/authentication.md): Learn how to authenticate your requests to the NeetoDesk API using API keys.
- [Pagination](https://apidocs.neetodesk.com/api/pagination.md): Learn how to handle paginated responses in the NeetoDesk API.
- [HTTP response codes](https://apidocs.neetodesk.com/api/response-codes.md): Learn about the HTTP status codes returned by the NeetoDesk API.
- [Getting the ticket ID](https://apidocs.neetodesk.com/api/getting-ticket-id.md): Understand how to retrieve ticket IDs and numbers for API calls and customer communication.
- [List tickets](https://apidocs.neetodesk.com/api/tickets/list.md): Retrieves a list of tickets in a workspace, newest first unless `sort` and `order` say otherwise.
- [Create ticket](https://apidocs.neetodesk.com/api/tickets/create.md): Creates a new ticket.
- [Get ticket](https://apidocs.neetodesk.com/api/tickets/get.md): Retrieves details of a specific ticket.
- [Update ticket](https://apidocs.neetodesk.com/api/tickets/update.md): Updates a ticket. Setting `status` to `moved` is refused. `tags` replaces every tag on the ticket, so use `add_tags` and `remove_tags` to change tags without losing the others; `tags` cannot be combined with either of them.
- [List comments](https://apidocs.neetodesk.com/api/comments/list.md): Retrieves all comments for a specific ticket.
- [Get a comment](https://apidocs.neetodesk.com/api/comments/get.md): Retrieves a specific comment for a ticket.
- [Create comment](https://apidocs.neetodesk.com/api/comments/create.md): Creates a comment for a specific ticket.
- [Create draft comment](https://apidocs.neetodesk.com/api/comments/create-draft.md): Creates a draft comment for a specific ticket.
- [Upload attachment](https://apidocs.neetodesk.com/api/attachments/create.md): Uploads a file and returns a `signed_id` for it. Pass that id in `attachments` on [Create ticket](/api/tickets/create) or [Create comment](/api/comments/create) to attach the file.
- [Reserve an attachment upload](https://apidocs.neetodesk.com/api/attachments/create-upload.md): Reserves storage for a file and returns where to send its bytes, for callers that would rather not route the file through this API. Use [Upload attachment](/api/attachments/create) instead to send the file in one request.
- [List customers](https://apidocs.neetodesk.com/api/customers/list.md): Lists the customers in the workspace, oldest first.
- [Get customer](https://apidocs.neetodesk.com/api/customers/get.md): Retrieves details of a specific customer.
- [Create customer](https://apidocs.neetodesk.com/api/customers/create.md): Creates a new customer.
- [List ticket fields](https://apidocs.neetodesk.com/api/fields/list.md): Lists the custom ticket fields in the workspace, ordered by their display order.
- [Get ticket field](https://apidocs.neetodesk.com/api/fields/get.md): Retrieves details of a specific custom ticket field.
- [Create ticket field](https://apidocs.neetodesk.com/api/fields/create.md): Creates a custom ticket field in the workspace.
- [Update ticket field](https://apidocs.neetodesk.com/api/fields/update.md): Updates a custom ticket field.
- [Delete ticket field](https://apidocs.neetodesk.com/api/fields/delete.md): Deletes a custom ticket field along with the values stored against it in tickets. The field must be `inactive` before it can be deleted.
- [List forms](https://apidocs.neetodesk.com/api/forms/list.md): Lists the enabled web forms through which customers raise tickets. Disabled forms are not returned.
- [Get ticket volume report](https://apidocs.neetodesk.com/api/reports/get-ticket-volume.md): This API retrieves ticket volume statistics including counts by status and change percentages compared to the previous period.
- [Get ticket volume time series](https://apidocs.neetodesk.com/api/reports/get-ticket-time-series.md): This API retrieves ticket volume data over time in a format suitable for charting, showing daily ticket counts for new and closed tickets.
- [Get agent performance report](https://apidocs.neetodesk.com/api/reports/get-agent-performance.md): This API retrieves performance metrics for all agents, including average response times, resolution times, and ticket counts with comparisons to the previous period.
- [Get team performance report](https://apidocs.neetodesk.com/api/reports/get-team-performance.md): This API retrieves performance metrics for all teams (groups), including average response times, resolution times, and ticket counts with comparisons to the previous period.
- [Get customer satisfaction report](https://apidocs.neetodesk.com/api/reports/get-customer-satisfaction.md): This API retrieves customer satisfaction survey results showing response counts for each rating option.
- [List team members](https://apidocs.neetodesk.com/api/team-members/list.md): Lists all team members in the workspace.
- [Get team member details](https://apidocs.neetodesk.com/api/team-members/get.md): Retrieves details of a specific team member.
- [Add team members](https://apidocs.neetodesk.com/api/team-members/add.md): Adds team members to the workspace.
- [Update team member](https://apidocs.neetodesk.com/api/team-members/update.md): Updates the details of a team member in the organization.
- [Remove a team member](https://apidocs.neetodesk.com/api/team-members/remove.md): Removes a team member from the workspace.
- [List tickets](https://apidocs.neetodesk.com/api-reference-v1/tickets/list.md): Retrieves a list of tickets in a workspace.
- [Create ticket](https://apidocs.neetodesk.com/api-reference-v1/tickets/create.md): Creates a new ticket.
- [Get ticket](https://apidocs.neetodesk.com/api-reference-v1/tickets/get.md): Retrieves details of a specific ticket.
- [Update ticket](https://apidocs.neetodesk.com/api-reference-v1/tickets/update.md): Updates a ticket.
- [List comments](https://apidocs.neetodesk.com/api-reference-v1/comments/list.md): Retrieves all comments for a specific ticket.
- [Create comment](https://apidocs.neetodesk.com/api-reference-v1/comments/create.md): Creates a comment for a specific ticket.
- [Create draft comment](https://apidocs.neetodesk.com/api-reference-v1/comments/create-draft.md): Creates a draft comment for a specific ticket.
- [Create customer](https://apidocs.neetodesk.com/api-reference-v1/customers/create.md): Creates a new customer.
- [Get ticket volume report](https://apidocs.neetodesk.com/api-reference-v1/reports/get-ticket-volume.md): This API retrieves ticket volume statistics including counts by status and change percentages compared to the previous period.
- [Get ticket volume time series](https://apidocs.neetodesk.com/api-reference-v1/reports/get-ticket-time-series.md): This API retrieves ticket volume data over time in a format suitable for charting, showing daily ticket counts for new and closed tickets.
- [Get agent performance report](https://apidocs.neetodesk.com/api-reference-v1/reports/get-agent-performance.md): This API retrieves performance metrics for all agents, including average response times, resolution times, and ticket counts with comparisons to the previous period.
- [Get team performance report](https://apidocs.neetodesk.com/api-reference-v1/reports/get-team-performance.md): This API retrieves performance metrics for all teams (groups), including average response times, resolution times, and ticket counts with comparisons to the previous period.
- [Get customer satisfaction report](https://apidocs.neetodesk.com/api-reference-v1/reports/get-customer-satisfaction.md): This API retrieves customer satisfaction survey results showing response counts for each rating option.
- [List team members](https://apidocs.neetodesk.com/api-reference-v1/team-members/list.md): Lists all team members in the workspace.
- [Add team members](https://apidocs.neetodesk.com/api-reference-v1/team-members/add.md): Adds team members to the workspace.
- [Update team member](https://apidocs.neetodesk.com/api-reference-v1/team-members/update.md): Updates the details of a team member in the organization.
- [Remove a team member](https://apidocs.neetodesk.com/api-reference-v1/team-members/remove.md): Removes a team member from the workspace. The team member is deactivated (soft-deleted).
- [NeetoDesk CLI](https://apidocs.neetodesk.com/cli/introduction.md): Manage tickets, comments, customers, reports, and more from your terminal.
- [Installation](https://apidocs.neetodesk.com/cli/installation.md): Install the neetodesk CLI on macOS, Linux, or Windows.
- [Workspace subdomain](https://apidocs.neetodesk.com/cli/workspace-subdomain.md): Find your workspace subdomain and tell the CLI which workspace to use.
- [Authentication](https://apidocs.neetodesk.com/cli/authentication.md): Sign in through the browser and manage credentials for one or more workspaces.
- [Output formats](https://apidocs.neetodesk.com/cli/output-formats.md): Pretty tables, JSON, quiet, and TOON - and when to use each.
- [AI assistants](https://apidocs.neetodesk.com/cli/ai-assistants.md): Set up NeetoDesk for Claude, Cursor, Copilot, and other AI coding assistants.
- [Troubleshooting](https://apidocs.neetodesk.com/cli/troubleshooting.md): Diagnose authentication and connectivity issues with neetodesk doctor.
- [Commands overview](https://apidocs.neetodesk.com/cli-reference/overview.md): Every neetodesk command grouped by resource, with links to the full reference.
- [Attachments](https://apidocs.neetodesk.com/cli-reference/attachments.md): Upload a file so a ticket or comment can carry it.
- [Tickets](https://apidocs.neetodesk.com/cli-reference/tickets.md): List, view, create, and update tickets, and manage their comments and drafts.
- [Customers](https://apidocs.neetodesk.com/cli-reference/customers.md): List, view, and create the customers who raise tickets.
- [Fields](https://apidocs.neetodesk.com/cli-reference/fields.md): List, view, create, update, and delete the custom fields on tickets.
- [Forms](https://apidocs.neetodesk.com/cli-reference/forms.md): List the web forms through which customers raise tickets.
- [Reports](https://apidocs.neetodesk.com/cli-reference/reports.md): Show ticket volume, ticket time series, agent and group performance, and survey results.
- [Team members](https://apidocs.neetodesk.com/cli-reference/team-members.md): List, view, add, update, and delete the agents in your workspace.
- [Utility commands](https://apidocs.neetodesk.com/cli-reference/utility.md): Authentication, diagnostics, versioning, upgrades, AI-assistant setup, and shell completion.
- [NeetoDesk MCP](https://apidocs.neetodesk.com/mcp/introduction.md): Manage your NeetoDesk tickets from an AI assistant in plain language.
- [Workspace subdomain](https://apidocs.neetodesk.com/mcp/workspace-subdomain.md): Find your workspace subdomain and use it to connect an assistant.
- [Authentication](https://apidocs.neetodesk.com/mcp/authentication.md): Connect as yourself with OAuth, or as the whole workspace with an API key.
- [MCP server](https://apidocs.neetodesk.com/mcp/server.md): The NeetoDesk MCP server endpoint, transport, and the sign-in options each agent supports.
- [Connect agent](https://apidocs.neetodesk.com/mcp/connect.md): Step-by-step setup for Claude, ChatGPT, and other AI agents.
- [Examples](https://apidocs.neetodesk.com/mcp/examples.md): Prompts to try once your assistant is connected to NeetoDesk.
- [Troubleshooting](https://apidocs.neetodesk.com/mcp/troubleshooting.md): What to check when an assistant cannot reach NeetoDesk.
- [Tools](https://apidocs.neetodesk.com/mcp/tools.md): Every tool the NeetoDesk MCP server exposes, grouped by resource.

## OpenAPI Specs

- [comments](/bundled-v1/comments.yaml)
- [customers](/bundled-v1/customers.yaml)
- [reports](/bundled-v1/reports.yaml)
- [team-members](/bundled-v1/team-members.yaml)
- [tickets](/bundled-v1/tickets.yaml)
- [attachments](/bundled/attachments.yaml)
- [comments](/bundled/comments.yaml)
- [customers](/bundled/customers.yaml)
- [fields](/bundled/fields.yaml)
- [forms](/bundled/forms.yaml)
- [reports](/bundled/reports.yaml)
- [team-members](/bundled/team-members.yaml)
- [tickets](/bundled/tickets.yaml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.