# TOPdesk MCP connector The TOPdesk connector brings incidents and their attachments into Claude, ChatGPT, Cursor, and any other MCP client, so your service desk can log, update, escalate, and archive TOPdesk incidents in plain language, inside each person's own TOPdesk access. Source: https://elaichi.ai/connectors/topdesk/ ## Facts | | | | --- | --- | | Application | TOPdesk | | Category | Helpdesk | | AI tools | 441 | | Authentication | Connects with an API key | | Needs your own OAuth app | No | | MCP endpoint | https://api.elaichi.ai/mcp | | Works with | Claude, ChatGPT, Cursor, any MCP client, and the Elaichi Agent | | Tools advertised by name | No. 441 tools is past the 30-tool threshold, so clients use `search_tools` and `execute_tool` | ## What you can ask once TOPdesk is connected - Show open TOPdesk incidents escalated this week. - Create a TOPdesk incident for the printer outage. - Which TOPdesk incidents were archived yesterday, and by whom? ## Connect TOPdesk in Elaichi This happens once for the organization, before any client is involved. 1. Open Connections, choose Add connection, and pick TOPdesk. 2. Optionally set Share with, then press Connect. 3. Paste a TOPdesk API key. One person generates a token in TOPdesk and pastes it once. Everyone else works through Share with, and never sees it. Credentials are vaulted and nobody, including the AI, reads them back. The connection becomes a toolbox immediately, so you can curate which TOPdesk tools are exposed, rename them, or freeze arguments before anyone points a client at it. ## Connect TOPdesk to Claude Endpoint: https://api.elaichi.ai/mcp 1. Open Customize, then Connectors. 2. Press Add. 3. Name it, paste the MCP server URL, then Continue. 4. Sign in and approve. On Team and Enterprise, an Owner adds it once. Everyone else turns it on for themselves. ## Connect TOPdesk to ChatGPT Endpoint: https://api.elaichi.ai/mcp 1. Open Plugins, then press the + button. 2. Name it and paste the endpoint into Server URL. 3. Leave Authentication on OAuth, then tick the risk acknowledgement. 4. Press Create, then sign in and approve. Works on the web today. The plugin directory lives at chatgpt.com/plugins. ## Connect TOPdesk to Cursor Endpoint: https://api.elaichi.ai/mcp 1. Open `~/.cursor/mcp.json`. 2. Add the endpoint under `mcpServers`. 3. Reload Cursor, then sign in and approve. Set up per machine, so repeat it on each computer you work from. ## Connect TOPdesk to any MCP client Endpoint: https://api.elaichi.ai/mcp 1. Add the endpoint as a remote MCP server. 2. Sign in and approve. The Elaichi Agent already has these tools, with nothing to set up. ## What the consent screen decides Only Read is granted by default, which is not enough to call a TOPdesk tool. Over MCP there is no trusted place to confirm a write in the moment, so the consent screen is the standing approval rather than a formality. Grant Read and Run tools. Think hard before granting Delete, which reaches into connected apps and cannot be undone. ## What teams do with TOPdesk through Elaichi ### Log an incident from a chat message IT service desk. A colleague describes a broken laptop in a message and the agent creates the TOPdesk incident with the right caller, category, and description, so nothing waits for someone to open a form. ### Catch an incident up after a call IT service desk. After a phone call with the caller, update the TOPdesk incident with what was tried, change its status, and attach the screenshot they sent, in one ask. ### Escalate stalled requests to the right level Facilities. Ask which facilities incidents have been open longest and escalate the ones that are overdue, or de-escalate a ticket that turned out to be minor. ### Find every incident about the same problem Support. When a printer, building, or application keeps coming up, list the open TOPdesk incidents that mention it and get a summary of what callers are reporting. ### Handle onboarding requests without leaving the conversation HR. Create the TOPdesk incident for a new starter's access request, check on it later by number, and pull down the signed form attached to it when payroll asks. ### Clean up the incident backlog Operations. Archive TOPdesk incidents that have been resolved for months, unarchive one when a caller reopens the case, and remove attachments that should no longer be kept on a ticket. ## Frequently asked questions ### How do I connect TOPdesk to Claude? First connect TOPdesk in Elaichi, which asks for a TOPdesk API key, the application password you create for your own TOPdesk operator account. There is no OAuth application to register and no client ID or secret to generate. Then in Claude open Customize, then Connectors, then Add, and paste https://api.elaichi.ai/mcp. Claude signs you in through Elaichi and TOPdesk incidents are available in your next conversation. ### Does TOPdesk work with ChatGPT and Cursor as well as Claude? Yes. TOPdesk is connected once in Elaichi, and the same endpoint, https://api.elaichi.ai/mcp, is added to Claude, ChatGPT, Cursor, any other MCP client, and the Elaichi Agent. Each person signs in as themselves in whichever client they use, and the same restrictions and audit log apply everywhere. ### What can an AI agent actually do with my TOPdesk data? An agent can list your TOPdesk incidents, open one by its ID or incident number, create a new incident, and update an existing one with notes, status, or a new category. It can escalate or de-escalate an incident, archive and unarchive it, and add, download, or remove attachments such as screenshots and forms. Because TOPdesk exposes hundreds of actions, short concrete asks like "escalate incident I-2403-118" work better than long paragraphs. ### Does connecting TOPdesk give the AI access to every incident? No. Every request runs inside the TOPdesk access of the person who signed in, so an agent sees only the incidents, operator groups, and attachments that person can already open in TOPdesk. Elaichi can narrow that further, for example to reading incidents only, but it can never grant more than TOPdesk itself allows that person. ### Can my team share one TOPdesk connection? Yes. One person connects TOPdesk in Elaichi and shares the connection with a team, and nobody else ever handles the TOPdesk API key. Each teammate still signs in to Elaichi as themselves, so every incident created or updated is logged under the name of the person who asked for it, not the person who connected TOPdesk. ### Can I stop an agent from deleting or changing things in TOPdesk? Yes. Restrictions in Elaichi work per action, so you can allow reading and creating TOPdesk incidents while blocking updates, archiving, or deleting attachments. A blocked action is never advertised to Claude, ChatGPT, Cursor, or any other client, so no prompt, however worded, can reach it. ### What happens to a TOPdesk connection when someone leaves? Offboarding a person in Elaichi ends their access to TOPdesk through every client at once, with no clean-up needed in Claude, ChatGPT, or Cursor. If they had shared a TOPdesk connection with a team, that connection keeps working for everyone else. Disconnecting TOPdesk once in Elaichi removes it from every client for the whole organization. ## All 441 TOPdesk tools Every tool below is callable through https://api.elaichi.ai/mcp once TOPdesk is connected, subject to the toolbox it is in and the restrictions on the caller. - **List all TOPdesk incidents** (List). List TOPdesk incidents with optional FIQL filtering, field selection, and sorting. Returns: id, number, request, action, briefDescription, caller, operator, operatorGroup, callType, category, subcategory, object, location, callDate, creationDate, modificationDate, targetDate, closedDate, escalationStatus, externalLinks, attachments, partialIncidents, responded, responseDate, sla, departmentId,… - **Create a TOPdesk incident** (Create). Create a new incident in TOPdesk. Returns the created incident including id, number, briefDescription, caller, operator, and operatorGroup. Persons can only set request, briefDescription, callType, category, subcategory, object, location, and operatorGroup. - **TOPdesk incidents deescalate** (Action). Deescalate a TOPdesk incident by id. Returns the updated incident including id, number, briefDescription, caller, operator, and escalationStatus. Required: incident_id. - **TOPdesk incidents archive** (Archive). Archive a TOPdesk incident by id. If the incident has partial incidents they will also be archived. Returns the updated incident including id, number, briefDescription, caller, operator, and escalationStatus. Required: incident_id. - **TOPdesk incidents escalate** (Action). Escalate a TOPdesk incident by id. Returns the updated incident including id, number, briefDescription, caller, operator, and escalationStatus. Required: incident_id. - **Get single TOPdesk incident by ID** (Get). Get a single TOPdesk incident by id. Returns: request, action, caller, operator, operatorGroup, sla. Required: id. - **TOPdesk incidents partial update** (Update). Partially update a TOPdesk incident by id. Returns the updated incident including request, action, caller, operator, and operatorGroup. Required: id. - **TOPdesk incidents unarchive** (Action). Unarchive a TOPdesk incident by incident_id. Returns the unarchived incident including request, action, caller, operator, and operatorGroup. Required: incident_id. - **Update a TOPdesk incident by ID** (Update). Update a TOPdesk incident by id. Returns the updated incident including request, action, caller, operator, and operatorGroup. Required: id. - **Get single TOPdesk incident number by ID** (Get). Get a TOPdesk incident by its incident number. Returns: request, action, caller, operator, operatorGroup. Required: id. - **Update a TOPdesk incident number by ID** (Update). Update a TOPdesk incident by its incident number with a full replacement body. Returns: request, action, caller, operator, operatorGroup. Required: id. - **TOPdesk incident numbers partial update** (Update). Partially update a TOPdesk incident by its incident number. Returns: request, action, caller, operator, operatorGroup. Required: id. - **TOPdesk incident numbers archive** (Archive). Archive a TOPdesk incident by its incident number, optionally providing an archiving reason. Partial incidents are also archived. Returns: request, action, caller, operator, operatorGroup. Required: number_id. - **TOPdesk incident numbers escalate** (Action). Escalate a TOPdesk incident by its incident number, optionally providing an escalation reason. Returns: request, action, caller, operator, operatorGroup. Required: number_id. - **TOPdesk incident numbers deescalate** (Action). Deescalate a TOPdesk incident by its incident number. Returns the updated incident object including request, action, caller, operator, and operatorGroup. Required: number_id. The optional id or name body field supplies a deescalation reason (mandatory when reason is required and no default is set). - **TOPdesk incident numbers unarchive** (Action). Unarchive a TOPdesk incident by its incident number. Returns the incident object including request, action, caller, operator, and operatorGroup. Required: number_id. Partial calls are also unarchived by default; set unarchive_partials to false to keep them archived. - **TOPdesk incident attachments list by ID** (List). List attachments for a TOPdesk incident identified by id. Returns: id, name, type, description, invisibleForCaller. Required: incident_id. - **TOPdesk incident attachments upload by ID** (Upload). Upload a file to a TOPdesk incident identified by id. Returns the uploaded attachment including its id, name, type, description, and invisibleForCaller. Required: incident_id, file. - **TOPdesk incident attachments list by number** (List). List attachments for a TOPdesk incident identified by number. Returns: id, name, type, description, invisibleForCaller. Required: incident_number. - **TOPdesk incident attachments upload by number** (Upload). Upload a file to a TOPdesk incident identified by its incident number. Returns the uploaded attachment object including its id, name, and type. Required: incident_number, file. - **TOPdesk incident attachments delete by ID** (Delete). Delete a file attachment from a TOPdesk incident identified by incident id. Returns an empty response on success. Required: incident_id, attachment_id. - **TOPdesk incident attachments delete by number** (Delete). Delete a file attachment from a TOPdesk incident identified by incident number. Returns an empty 204 response on success. Required: incident_number, attachment_id. - **TOPdesk incident attachments download by ID** (Download). Download a file attachment from a TOPdesk incident identified by incident id. Returns the raw binary file content with a content-type matching the attachment's mime type (e.g. image/png, application/octet-stream). Required: incident_id, attachment_id. - **TOPdesk incident attachments download by number** (Download). Download a file attachment from a TOPdesk incident identified by incident number. Returns the raw binary file content with a content-type matching the attachment's mime type (e.g. image/png, application/octet-stream). Required: incident_number, attachment_id. - **TOPdesk incident images list by ID** (List). List inline images for a TOPdesk incident identified by id. Returns an array of image objects including downloadUrl, filename, originalFileName, fileSize, and invisibleForCaller. Required: incident_id. - **TOPdesk incident images list by number** (List). List inline images for a TOPdesk incident identified by number. Returns an array of image objects including downloadUrl, filename, originalFileName, fileSize, and invisibleForCaller. Required: number_id. - **TOPdesk incident images get by ID** (Get). Retrieve a specific inline image file from a TOPdesk incident identified by id. Returns the raw image file content with the appropriate mime-type (e.g. image/png, or application/octet-stream when the type cannot be determined). Required: incident_id, file_name. - **TOPdesk incident images get by number** (Get). Retrieve a specific inline image file from a TOPdesk incident identified by incident number. Returns the raw image file content with the appropriate mime-type (e.g. image/png, or application/octet-stream when the type cannot be determined). Required: incident_number, file_name. - **List all TOPdesk requester incidents** (List). List TOPdesk requester incidents for SSP users with optional FIQL filtering and field selection. Returns: id, number, request, action, briefDescription, caller, operator, operatorGroup, callType, category, subcategory, object, location, callDate, creationDate, modificationDate, targetDate, closedDate, closed, escalationStatus, externalLinks, attachments, partialIncidents, feedbackRating,… - **Create a TOPdesk requester incident** (Create). Create a first-line incident in TOPdesk for an SSP user. Returns the created incident including id, number, request, briefDescription, caller, and creationDate. Only request, briefDescription, callType, category, subcategory, object, location, and operatorGroup can be set, depending on new call form settings. - **Get single TOPdesk requester incident by ID** (Get). Get a single TOPdesk requester incident by id. Returns: id, number, request, action, briefDescription, caller, operator, operatorGroup, callType, category, subcategory, object, location, callDate, creationDate, modificationDate, targetDate, closedDate, closed, escalationStatus, externalLinks, attachments, partialIncidents, feedbackRating, feedbackMessage, responded, responseDate, sla. Required:… - **TOPdesk requester incidents partial update** (Update). Partially update a TOPdesk requester incident for an SSP user by id. Returns the updated incident including id, number, request, briefDescription, caller, and creationDate. Depending on settings, only action, closed, feedbackRating, and feedbackMessage can be updated. Required: id. - **Get single TOPdesk requester incident number by ID** (Get). Get a single TOPdesk requester incident by incident number. Returns: request, action, caller, operator, operatorGroup, sla. Required: id (the incident number). - **TOPdesk requester incident numbers partial update** (Update). Partially update a TOPdesk requester incident by incident number. Depending on settings, updatable fields include action, closed, feedbackRating, and feedbackMessage. Returns the updated incident including request, action, caller, operator, and operatorGroup. Required: id (the incident number). - **TOPdesk requester incident attachments list by ID** (List). List attachments for a TOPdesk incident identified by id, accessible to SSP (Self Service Portal) users. Returns: id, name, type, description, invisibleForCaller. Required: incident_id. - **TOPdesk requester incident attachments upload by ID** (Upload). Upload a file to a TOPdesk incident identified by id for a SSP user. Returns the uploaded attachment including id, name, type, description, and invisibleForCaller. Required: incident_id, file. - **TOPdesk requester incident attachments list by number** (List). List attachments for a TOPdesk incident identified by number, accessible to SSP (Self Service Portal) users. Returns: id, name, type, description, invisibleForCaller. Required: incident_number. - **TOPdesk requester incident attachments upload by number** (Upload). Upload a file to a TOPdesk incident identified by number for a SSP user. Returns the uploaded attachment including id, name, type, description, and invisibleForCaller. Required: incident_number, file. - **TOPdesk requester incident attachments download by ID** (Download). Download an attachment file from a TOPdesk incident by incident id and attachment id for a SSP user. Returns the file content as a binary stream with a content-type based on the file type. Required: incident_id, attachment_id. - **TOPdesk requester incident images list by ID** (List). List inline images for a TOPdesk incident identified by id, for SSP users. Returns: downloadUrl, filename, originalFileName, fileSize, invisibleForCaller. Required: incident_id. - **TOPdesk requester incident images list by number** (List). List inline images for a TOPdesk incident identified by number, for SSP users. Returns: downloadUrl, filename, originalFileName, fileSize, invisibleForCaller. Required: number_id. - **List all TOPdesk incident call types** (List). List incident call types in TOPdesk. Returns: id, name. - **TOPdesk incident call types list requester** (List). List incident call types for SSP (Self Service Portal) users in TOPdesk. Returns: id, name. - **List all TOPdesk incident durations** (List). List available incident duration options in TOPdesk. Returns: id, name. - **List all TOPdesk incident entry types** (List). List incident entry types in TOPdesk. Returns an array of searchlist objects, each containing id and name. - **List all TOPdesk incident impacts** (List). List all incident impacts (searchlist values) available in TOPdesk. Returns: id, name. No required parameters. - **List all TOPdesk incident priorities** (List). List incident priorities in TOPdesk. Returns: id, name, duration. No required parameters. - **List all TOPdesk incident statuses** (List). List processing statuses for incidents in TOPdesk. Returns an array of status objects, each with id and name. Only unarchived status values are returned. No required parameters. - **List all TOPdesk incident categories** (List). List incident categories in TOPdesk. Returns: id, name. - **TOPdesk incident categories list requester** (List). List incident categories available to SSP (self-service portal) users in TOPdesk. Returns: id, name. - **List all TOPdesk incident subcategories** (List). List incident subcategories in TOPdesk. Returns an array of subcategory objects with id and name. Category, branch, and operator filters may apply depending on operator permissions. - **TOPdesk incident subcategories list requester** (List). List incident subcategories available to SSP (Self Service Portal) users in TOPdesk. Returns: id, name. No required parameters. - **List all TOPdesk incident closure codes** (List). List closure codes in TOPdesk available for closing incidents. Returns: id, name. - **List all TOPdesk incident urgencies** (List). List incident urgencies available in TOPdesk. Returns an array of urgency entries, each with id and name. Category, branch, and operator filters apply. - **List all TOPdesk incident deescalation reasons** (List). List deescalation reasons available for TOPdesk incidents. Returns: id, name. The deescalation feature must be enabled in TOPdesk. - **List all TOPdesk incident escalation reasons** (List). List the available incident escalation reasons in TOPdesk. Returns: id, name. The escalation feature must be enabled on the TOPdesk environment. - **List all TOPdesk incident slas** (List). List SLA services in TOPdesk, filterable by incident, contract, person, branch, service, call type, category, subcategory, asset, and other contract/service criteria. Returns: id. There is no way to request later pages — use more specific filter parameters to narrow results. - **List all TOPdesk SLA services** (List). List SLA services available in TOPdesk for incident SLA configuration. Returns an array of service entries, each containing id and name. No required parameters. - **TOPdesk incident timespents list by ID** (List). Retrieve time spent entries registered on a TOPdesk incident by incident id. Returns: request, action, caller, operator, operatorGroup. Required: incident_id. - **TOPdesk incident timespents create by ID** (Create). Register time spent on a TOPdesk incident by incident id. Returns the created time spent entry including request, action, caller, operator, and operatorGroup. Required: incident_id. - **TOPdesk incident timespents list by number** (List). Retrieve time spent entries registered on a TOPdesk incident by incident number. Returns: request, action, caller, operator, operatorGroup. Required: number. - **TOPdesk incident timespents create by number** (Create). Register time spent on a TOPdesk incident by incident number. Returns the created time spent entry including request, action, caller, operator, and operatorGroup. Required: number. - **List all TOPdesk incident timeregistrations** (List). List TOPdesk incident time registrations. By default only 1st and 2nd line incident entries are returned, and only id is included unless the fields parameter is specified. Returns: id, request, action, caller, operator, operatorGroup, timeSpent, creationDate, modificationDate. - **Get single TOPdesk incident timeregistration by ID** (Get). Get a single TOPdesk incident time registration by id. Returns: id, request, action, caller, operator, operatorGroup, timeSpent, creationDate, modificationDate. Required: id. - **List all TOPdesk timespent reasons** (List). List reasons for time spent in TOPdesk. Returns: id, name. These are simple IdAndName lookup objects used when registering time spent on incidents. - **TOPdesk incident progresstrails list by ID** (List). List TOPdesk incident progress trail entries by incident id. Returns each entry's request, action, caller, operator, and operatorGroup. Required: incident_id. Max 100 entries per page. - **TOPdesk incident progresstrails list by number** (List). List TOPdesk incident progress trail entries by incident number. Returns each entry's request, action, caller, operator, and operatorGroup. Required: number. Max 100 entries per page. - **TOPdesk incident progresstrails list requester by ID** (List). List incident progress trail entries for a TOPdesk incident by incident id. Returns: request, action, caller, operator, operatorGroup. Required: incident_id. - **TOPdesk incident progresstrails list requester by number** (List). List incident progress trail entries for a TOPdesk incident by incident number. Returns: request, action, caller, operator, operatorGroup. Required: number. - **TOPdesk incident progresstrail counts list by ID** (List). Get the progress trail entry count for a TOPdesk incident by incident id (operator endpoint). Returns: count. Required: incident_id. - **TOPdesk incident progresstrail counts list by number** (List). Get the progress trail entry count for a TOPdesk incident by incident number (operator endpoint). Returns: count. Required: number. - **TOPdesk incident progresstrail counts list requester by ID** (List). Get the progress trail entry count for a TOPdesk incident by incident id, accessible by SSP users (persons). Returns: count. Required: incident_id. - **TOPdesk incident progresstrail counts list requester by number** (List). Get the progress trail entry count for a TOPdesk incident by incident number, accessible by SSP users (persons). Returns: count. Required: number. - **TOPdesk incident actions list by number** (List). List incident actions in TOPdesk by incident number. Returns: request, action, caller, operator, operatorGroup. Required: number. - **TOPdesk incident actions list by ID** (List). List incident actions in TOPdesk by incident id. Returns: request, action, caller, operator, operatorGroup. Required: incident_id. - **TOPdesk incident actions get by ID** (Get). Get a single incident action in TOPdesk by incident id and action id. Returns: request, action, caller, operator, operatorGroup. Required: incident_id, action_id. - **TOPdesk incident actions delete by ID** (Delete). Delete an incident action in TOPdesk by incident id and action id. Returns an empty 204 response on success. Required: incident_id, action_id. - **TOPdesk incident actions get by number** (Get). Get a single incident action in TOPdesk by incident number and action id. Returns: request, action, caller, operator, operatorGroup. Required: incident_number, action_id. - **TOPdesk incident actions delete by number** (Delete). Delete an incident action by incident number and action id in TOPdesk. Returns an empty 204 response on success. Required: incident_number, action_id. - **TOPdesk incident actions list requester by number** (List). List incident actions by incident number for SSP users in TOPdesk. Returns: request, action, caller, operator, operatorGroup. Required: number. - **TOPdesk incident actions list requester by ID** (List). List incident actions by incident id for SSP users in TOPdesk. Returns: request, action, caller, operator, operatorGroup. Required: incident_id. - **TOPdesk incident actions get requester by ID** (Get). Get a single incident action by incident id and action id for SSP users in TOPdesk. Returns: request, action, caller, operator, operatorGroup. Required: incident_id, action_id. - **TOPdesk incident actions get requester by number** (Get). Get a single incident action by incident number and action id for SSP users in TOPdesk. Returns: request, action, caller, operator, operatorGroup. Required: incident_number, action_id. - **TOPdesk incident requests list by number** (List). List incident requests for a TOPdesk incident by incident number. Returns: request, action, caller, operator, operatorGroup. Required: number. - **TOPdesk incident requests list by ID** (List). List incident requests for a TOPdesk incident by incident id. Returns: request, action, caller, operator, operatorGroup. Required: incident_id. - **TOPdesk incident requests get by ID** (Get). Get a specific TOPdesk incident request by incident id and request id. Returns: request, action, caller, operator, operatorGroup. Required: incident_id, request_id. - **TOPdesk incident requests delete by ID** (Delete). Delete a TOPdesk incident request by incident id and request id. Returns an empty 204 response on success. Required: incident_id, request_id. - **TOPdesk incident requests get by number** (Get). Get a TOPdesk incident request by incident number and request id. Returns: request, action, caller, operator, operatorGroup. Required: incident_number, request_id. - **TOPdesk incident requests delete by number** (Delete). Delete a TOPdesk incident request by incident number and request id. Returns an empty 204 response on success. Required: incident_number, request_id. - **TOPdesk incident requests list requester by number** (List). List incident requests for a TOPdesk incident identified by number, accessible to SSP (Self-Service Portal) users. Returns: request, action, caller, operator, operatorGroup. Required: number. - **TOPdesk incident requests list requester by ID** (List). List incident requests for a TOPdesk incident identified by id, accessible to SSP (Self-Service Portal) users. Returns: request, action, caller, operator, operatorGroup. Required: incident_id. - **TOPdesk incident requests get requester by ID** (Get). Get a single TOPdesk incident request by incident id and request id, accessible to SSP (Self-Service Portal) users. Returns: request, action, caller, operator, operatorGroup. Required: incident_id, request_id. - **TOPdesk incident requests get requester by number** (Get). Get a single TOPdesk incident request by incident number and request id, accessible to SSP (Self-Service Portal) users. Returns: request, action, caller, operator, operatorGroup. Required: incident_number, request_id. - **List all TOPdesk login operators** (List). Authenticate as a TOPdesk operator and retrieve an authorization token. Deprecated in favor of application passwords. Returns the authorization token as a string. - **List all TOPdesk login people** (List). Generate an authentication token for a person in TOPdesk. Returns the authorization token as a string. No caller-supplied parameters required. - **List all TOPdesk logouts** (List). Log out the current operator or person in TOPdesk. Returns an empty 200 response on success. - **List all TOPdesk archiving reasons** (List). List reasons for archiving in TOPdesk. Returns an array of archiving reason objects, each containing id and name. - **Get single TOPdesk emails ID by ID** (Get). Get details of a TOPdesk email by id for incidents, changes, and change activities. Returns: id, subject, content. Required: id. - **Delete a TOPdesk emails ID by ID** (Delete). Delete a TOPdesk email by id. Returns an empty 204 response on success. Required: id. - **List all TOPdesk service window lookups** (List). List service windows in TOPdesk. This is a lightweight lookup that returns only id and name pairs. Returns: id, name. Filter by name prefix or archived state. - **Get single TOPdesk service window lookup by ID** (Get). Get a single service window in TOPdesk by id. This is a lightweight lookup that returns only id and name. Returns: id, name. Required: id. - **List all TOPdesk searches** (List). Search TOPdesk via the REST API across supported indices. Returns up to 30 search results, each containing id and type. The index parameter selects the search index (currently only incidents). - **List all TOPdesk versions** (List). Get the TOPdesk API version. Returns: version. - **List all TOPdesk product versions** (List). Get the current TOPdesk product version. Returns: major, minor, patch. - **List all TOPdesk categories** (List). List TOPdesk categories and subcategories. Returns each category with id, name, archived, parent, modules, and translations (when requested via fields). No paging is currently supported; translations require fields=translations or fields=all. - **List all TOPdesk requester categories** (List). List requester categories and subcategories in TOPdesk. Returns: id, name, archived, parent, modules, translations. Translations are only returned when explicitly requested via fields=translations or fields=all. Currently no pagination support — all categories are returned at once, though a next-page link may be present if the result set is exceptionally large. - **Get single TOPdesk avatars operator by ID** (Get). Get a TOPdesk operator's avatar by id. Returns the avatar object including the image data and its mime type. Required: id (the operator id, UUID format). - **TOPdesk avatars operators get requester** (Get). Get a TOPdesk operator's avatar for an SSP (Self Service Portal) user by operator id. Returns the avatar object including the image data and its mime type. Required: operator_id. - **Get single TOPdesk avatars person by ID** (Get). Get a TOPdesk person's avatar image by id. Returns the avatar object including its mimeType. Required: id. - **List all TOPdesk branches** (List). List TOPdesk branches with optional FIQL filtering and field selection. Returns the full branch object per item including id, name, specification, branchType, headBranch, address, postalAddress, realEstate, accountManager, contact, attention, serviceWindow, creator, modifier, optionalFields1, optionalFields2, externalLink, archived, status, customerReferenceNumber, VATnumber, creationDate, and… - **Create a TOPdesk branch** (Create). Create a new TOPdesk branch. Returns the created branch including id, name, specification, branchType, headBranch, address, postalAddress, realEstate, accountManager, contact, and other branch details. branchType must be one of independentBranch, headBranch, or hasAHeadBranch; when set to hasAHeadBranch a headBranch must be supplied, and when set to independentBranch no headBranch is allowed. - **Get single TOPdesk branch by ID** (Get). Get a single TOPdesk branch by id. Returns the full branch object including id, name, specification, branchType, headBranch, address, postalAddress, realEstate, accountManager, contact, attention, serviceWindow, creator, modifier, optionalFields1, optionalFields2, externalLink, archived, status, customerReferenceNumber, VATnumber, creationDate, and modificationDate. Required: id. - **Update a TOPdesk branch by ID** (Update). Update a TOPdesk branch by id. Returns the updated branch including id, name, specification, branchType, headBranch, address, postalAddress, realEstate, accountManager, contact, attention, serviceWindow, creator, modifier, optionalFields1, optionalFields2, externalLink, archived, status, customerReferenceNumber, VATnumber, creationDate, and modificationDate. Required: id. When branchType is… - **TOPdesk branches partial update** (Update). Partially update a TOPdesk branch by id. Returns the updated branch including id, name, specification, branchType, headBranch, address, postalAddress, realEstate, accountManager, contact, attention, serviceWindow, creator, modifier, optionalFields1, optionalFields2, externalLink, archived, status, customerReferenceNumber, VATnumber, creationDate, and modificationDate. Required: id. Only fields… - **TOPdesk branches archive** (Archive). Archive a TOPdesk branch by id with an archiving reason. Returns the archived branch including id, name, specification, headBranch, branchType, and archived. Required: branche_id and a body containing the archiving reason id. - **TOPdesk branches archive patch** (Archive). Archive a TOPdesk branch by id with an archiving reason using PATCH. Returns the archived branch including id, name, specification, headBranch, branchType, and archived. Required: branche_id and a body containing the archiving reason id. - **TOPdesk branches list attachments** (List). List attachments for a specific TOPdesk branch identified by its branch id. Returns: id, name, type. Required: branche_id. - **TOPdesk branches upload attachment** (Upload). Upload a file attachment to a TOPdesk branch by branch id. Returns: id, name, type. Required: branche_id, file. - **TOPdesk branches delete attachment** (Delete). Delete an attachment from a TOPdesk branch identified by branche_id. Returns an empty 204 response on success. Required: branche_id, attachment_id. - **TOPdesk branches download attachment** (Download). Download an attachment file from a TOPdesk branch. Returns the attachment as a binary byte stream with the original file's MIME type. Required: branche_id, attachment_id. Branch filters apply for operator access. - **List all TOPdesk branches building levels** (List). List building level values configured in TOPdesk. Returns: id, name. - **List all TOPdesk branches designations** (List). List branch designation values in TOPdesk. Returns an array of searchlist entries, each containing id and name. No required parameters. - **List all TOPdesk branches energy performances** (List). List all energy performance values available for branches in TOPdesk. Returns: id, name. - **List all TOPdesk branches environmental impacts** (List). List environmental impact values available for branches in TOPdesk. Returns: id, name. - **List all TOPdesk branches listed buildings** (List). List listed building values available for branches in TOPdesk. Returns: id, name. - **List all TOPdesk branches lookups** (List). List TOPdesk branch lookup entries (lightweight id and name pairs) sorted by ascending name. Returns: id, name. Filter by name prefix or archived status. - **Get single TOPdesk branches lookup by ID** (Get). Get a single TOPdesk branch lookup entry (a lightweight id and name pair) by id. Returns: id, name. Required: id. - **List all TOPdesk budgetholders** (List). List TOPdesk budget holders, optionally filtered by external link. Returns: id, name, externalLink. The external_link_id and external_link_type filters should be used in combination with each other. - **Create a TOPdesk budgetholder** (Create). Create a new budget holder in TOPdesk. Returns the created budget holder including id, name, and externalLink. Required: name. - **Update a TOPdesk budgetholder by ID** (Update). Update the name of a TOPdesk budget holder by id. Returns the updated budget holder including id, name, and externalLink. Required: id. - **Delete a TOPdesk budgetholder by ID** (Delete). Delete a TOPdesk budget holder by id. Returns an empty 204 response on success. Required: id. - **TOPdesk budgetholders archive** (Archive). Archive a TOPdesk budget holder by id. Returns the archived budget holder including id, name, and externalLink. Required: budgetholder_id. - **List all TOPdesk countries** (List). List all countries stored in TOPdesk. Returns: id, name for each country entry. - **List all TOPdesk departments** (List). List departments in TOPdesk, optionally filtered by external link. Returns: id, name, externalLink. The external_link_id and external_link_type filters should be used in combination. - **Create a TOPdesk department** (Create). Create a department in TOPdesk. Returns: id. Required: name. The name must be unique and not exceed the maximum length. - **Update a TOPdesk department by ID** (Update). Update the name of a department in TOPdesk by id. Returns: id, name, external_link. Required: id, name. - **Delete a TOPdesk department by ID** (Delete). Delete a TOPdesk department by id. Returns an empty 204 response on success. Required: id. The delete fails with a 409 if the department is still referenced by other cards. - **TOPdesk departments archive** (Archive). Archive a department in TOPdesk by its identifier. Returns the archived department object including its id, name, and external_link. Required: department_id. - **List all TOPdesk languages** (List). List languages configured in TOPdesk. Returns: id, name. - **List all TOPdesk locations** (List). List TOPdesk locations with optional FIQL filtering and field selection. Returns: id, name, type. Use the $fields parameter to control which fields are included. - **Create a TOPdesk location** (Create). Create a new TOPdesk location. Returns the created location including id, name, roomNumber, branch, and roomSetup. Accepts name (max 100 chars), branch, roomSetup (standardLocation, divisibleLocation, or isASubLocation), majorLocation, and reservationManagement settings. - **Get single TOPdesk location by ID** (Get). Get a single TOPdesk location by id. Returns the full location object including id, name, roomNumber, branch, roomSetup, capacity, and reservationManagement settings. Required: id. - **Update a TOPdesk location by ID** (Update). Update a TOPdesk location by id with full field replacement. Returns the updated location including id, name, roomNumber, branch, and roomSetup. Required: id. - **TOPdesk locations partial update** (Update). Partially update a TOPdesk location by id, changing only the provided fields. Returns the updated location including id, name, roomNumber, branch, and roomSetup. Required: id. - **TOPdesk locations archive** (Archive). Archive a TOPdesk location by id with an archiving reason. Returns the full archived location object including id, name, roomNumber, branch, roomSetup, archived, and status. Required: location_id. An archiving reason (id or name) must be supplied in the body when no default reason is configured. - **TOPdesk locations archive patch** (Archive). Archive a TOPdesk location by id with an archiving reason using the PATCH method. Returns the full archived location object including id, name, roomNumber, branch, roomSetup, archived, and status. Required: location_id. An archiving reason (id or name) must be supplied in the body when no default reason is configured. - **List all TOPdesk locations building zones** (List). List building zones in TOPdesk. Returns: id, name. - **List all TOPdesk locations ceiling coverings** (List). List ceiling covering values in TOPdesk supporting files. Returns an array of searchlist entries, each with id and name. Category/Branch/Operator filters apply for operator access. - **List all TOPdesk locations floor coverings** (List). List floor covering values configured in TOPdesk supporting files. Returns: id, name, archived. Operator access only; Category/Branch/Operator filters apply. - **List all TOPdesk locations functional uses** (List). List functional uses for locations in TOPdesk. Returns an array of searchlist entries including id, name, archived, and order. - **List all TOPdesk locations glass materials** (List). List glass materials in TOPdesk. Returns an array of glass material searchlist values, each with id and name. - **List all TOPdesk locations lookups** (List). List TOPdesk location lookup entries (id and name pairs) sorted by ascending name. Returns: id, name. Filter by name prefix or archived status; use $all to return all entries ignoring $top. - **Get single TOPdesk locations lookup by ID** (Get). Get a single TOPdesk location lookup entry by id. Returns: id, name. Required: id. - **List all TOPdesk locations statuses** (List). List room (location) statuses in TOPdesk. Returns an array of searchlist entries with id and name for each room status value. Category/Branch/Operator filters apply for operator access. - **List all TOPdesk locations types** (List). List all location types configured in TOPdesk. Returns: id, name. Category/Branch/Operator filters apply for operators. - **List all TOPdesk locations wall coverings** (List). List wall coverings in TOPdesk. Returns each wall covering entry with its id and name. - **List all TOPdesk operatorgroups** (List). List TOPdesk operator groups with optional FIQL filtering and field selection. Returns: id, name. Max 100 per page. - **Create a TOPdesk operatorgroup** (Create). Create a TOPdesk operator group. Returns the created operator group including id, name, groupName, branch, location, budgetHolder, contact, accessRoles, archived, stockManager. Required: name (max 50 characters). - **TOPdesk operatorgroups list by operator** (List). List operator groups linked to a specific TOPdesk operator. Returns: id, name. Required: operator_id. Supports FIQL filtering on the archived status of linked operator groups. - **TOPdesk operatorgroups create by operator** (Create). Link operator groups to a TOPdesk operator by providing their UUIDs. Returns an empty 204 response on success. Required: operator_id. - **TOPdesk operatorgroups delete by operator** (Delete). Unlink operator groups from a TOPdesk operator by providing their UUIDs. Returns an empty 204 response on success. Required: operator_id. - **Get single TOPdesk operatorgroup by ID** (Get). Get a TOPdesk operator group by id. Returns the full operator group object including id, groupName, branch, contact, accessRoles, archived, and stockManager. Required: id. - **Update a TOPdesk operatorgroup by ID** (Update). Update a TOPdesk operator group by id with a full replacement of all writable fields. Returns the updated operator group including id, groupName, branch, contact, accessRoles, archived, and stockManager. Required: id. - **TOPdesk operatorgroups partial update** (Update). Partially update a TOPdesk operator group by id, changing only the supplied fields. Returns the updated operator group including id, groupName, branch, contact, accessRoles, archived, and stockManager. Required: id. - **TOPdesk operatorgroups archive** (Archive). Archive a TOPdesk operator group by id. Returns the archived operator group including id, groupName, branch, accessRoles, and archived. Required: operatorgroup_id and a request body containing the archiving reason id. - **TOPdesk operatorgroups archive patch** (Archive). Archive an operator group in TOPdesk by providing an archiving reason. Returns the archived operator group object including id, groupName, branch, contact, and accessRoles. Required: operatorgroup_id, id (archiving reason id in the body). Reason for archiving is mandatory and must reference a valid archiving reason retrievable via the archiving-reasons endpoint. - **List all TOPdesk operatorgroups lookups** (List). List TOPdesk operator group id and name pairs, sorted by ascending name. Returns: id, name. Filter by name prefix, archived status, role, or operatorid. - **Get single TOPdesk operatorgroups lookup by ID** (Get). Get a single TOPdesk operator group id and name pair by id. Returns: id, name. Required: id. - **List all TOPdesk operators** (List). List TOPdesk operators with optional FIQL query filtering and field selection. Returns: id. When the query parameter is not used, only active (non-archived) operators are returned. - **TOPdesk operators list by operatorgroup** (List). List operators belonging to a specific TOPdesk operator group. Returns: id, name. Required: operatorgroup_id. - **Create a TOPdesk operator** (Create). Create a new TOPdesk operator with basic fields, linkedPerson, and optional login credentials. Returns: id. If loginPermission is set to true, loginName and password must be provided; loginName must be unique. - **TOPdesk operators get current** (Get). Get the currently logged-in TOPdesk operator. Returns: id, surName, branch, archived, accessRoles, hasApplicationPasswords, operatorGroup, language, location, department, budgetHolder, attention, creator, modifier, optionalFields1, optionalFields2, externalLink, linkedPerson. The accessRoles and hasApplicationPasswords fields may be excluded depending on the caller's permissions. - **TOPdesk operators get current ID** (Get). Get the id of the currently logged-in operator in TOPdesk. Returns: id. No parameters required. - **Get single TOPdesk operator by ID** (Get). Get a single TOPdesk operator by id. Returns the operator object including id, surName, branch, loginName, and archived. Required: id. - **Update a TOPdesk operator by ID** (Update). Update a TOPdesk operator by id with a full replacement of all settable fields. Returns the updated operator including id, surName, branch, loginName, and archived. The linkedPerson field cannot be changed on an existing operator. Required: id. - **TOPdesk operators partial update** (Update). Partially update a TOPdesk operator by id, changing only the provided fields. Returns the updated operator including id, surName, branch, loginName, and archived. The linkedPerson field cannot be changed on an existing operator. Required: id. - **TOPdesk operators archive** (Archive). Archive a TOPdesk operator by id with an archiving reason. Returns the archived operator including id, surName, branch, and archived. Cannot archive yourself or administrators. Required: operator_id, id (archiving reason in request body). - **TOPdesk operators archive patch** (Archive). Archive a TOPdesk operator using PATCH by id with an archiving reason. Returns the archived operator including id, surName, branch, and archived. Cannot archive yourself or administrators. Required: operator_id, id (archiving reason in request body). - **List all TOPdesk operators lookups** (List). List TOPdesk operator id and name pairs, sorted by ascending name. Returns: id, name. Filter by name prefix, archived status, role, operator group, or whether to include service principals. - **Get single TOPdesk operators lookup by ID** (Get). Get a single TOPdesk operator's id and name pair by id. Returns: id, name. Required: id. - **List all TOPdesk operators settings** (List). Get the logged-in TOPdesk operator's personal settings. Returns the operator settings object (OperatorSettingsDto) with operator-specific configuration fields whose shape is defined upstream in the TOPdesk OpenAPI schema; consult the upstream API documentation for the full field-level breakdown. - **List all TOPdesk filters branches** (List). List all branch filters available in TOPdesk. Returns: id, name. - **TOPdesk filters branches list by operator** (List). List branch filters linked to a specific TOPdesk operator. Returns: id, name. Required: operator_id. - **Create a TOPdesk filters branch** (Create). Link branch filters to a TOPdesk operator by providing an array of filter UUIDs in the request body. Returns an empty 204 response on success. Required: operator_id, and a request body array of objects each with an id (branch filter UUID). Non-existent ids, filters applying to all operators, and already-linked filters are ignored. - **TOPdesk filters branches bulk delete** (Delete). Unlink branch filters from a TOPdesk operator by providing an array of filter UUIDs in the request body. Returns an empty 204 response on success. Required: operator_id, and a request body array of objects each with an id (branch filter UUID). Non-existent ids, filters applying to all operators, and already-unlinked filters are ignored. - **List all TOPdesk filters categories** (List). List all category filters available in TOPdesk. Returns: id. - **TOPdesk filters categories list by operator** (List). List the category filters linked to a specific TOPdesk operator. Returns: id. Required: operator_id. - **Create a TOPdesk filters category** (Create). Link category filters to an operator in TOPdesk by providing a list of filter UUIDs. Returns an empty 204 response on success. Required: operator_id. - **TOPdesk filters categories bulk delete** (Delete). Unlink category filters from an operator in TOPdesk by providing a list of filter UUIDs. Returns an empty 204 response on success. Required: operator_id. - **List all TOPdesk filters operators** (List). List all operator filters available in TOPdesk. Returns an array of filter objects, each with id and name. - **TOPdesk filters operators list by operator** (List). List the operator filters linked to a specific TOPdesk operator. Returns an array of filter objects, each with id and name. Required: operator_id. - **Create a TOPdesk filters operator** (Create). Link operator filters to a TOPdesk operator by providing an array of filter UUIDs. Non-existent ids, filters applying to all operators, or filters already linked are ignored. Returns an empty 204 response on success. Required: operator_id. - **TOPdesk filters operators bulk delete** (Delete). Unlink operator filters from a TOPdesk operator by providing an array of filter UUIDs. Non-existent ids, filters applying to all operators, or unlinked filters are ignored. Returns an empty 204 response on success. Required: operator_id. - **List all TOPdesk permissiongroups** (List). List permission groups in TOPdesk. Returns an array of permission group entries including id and name. - **TOPdesk permissiongroups list by operator** (List). List the permission groups linked to a specific TOPdesk operator. Returns: id, name. Required: operator_id. - **TOPdesk permissiongroups create by operator** (Create). Link permission groups to a TOPdesk operator by passing a list of permission group UUIDs in the request body. Returns an empty 204 response on success. Required: operator_id. - **TOPdesk permissiongroups delete by operator** (Delete). Unlink permission groups from a TOPdesk operator by passing a list of permission group UUIDs in the request body. Returns an empty 204 response on success. Required: operator_id. - **List all TOPdesk people** (List). List TOPdesk persons with optional FIQL filtering, field selection, and sorting. Returns person records including id, firstName, surName, dynamicName, email, phoneNumber, mobileNumber, jobTitle, department, branch, location, archived, and loginName. The V2 endpoint returns a limited field set by default; use the fields parameter to request additional fields. Max 5000 per page. - **Create a TOPdesk person** (Create). Create a new TOPdesk person. Returns the created person object including id, firstName, surName, dynamicName, email, branch, and department. Defaults hasSspAccess and isCaller to true when omitted. The department field accepts an id (drop-down list mode) or a name (plain text field mode) depending on settings. - **TOPdesk people get current** (Get). Get the currently logged-in TOPdesk person (SSP user). Returns: id, firstName, surName, dynamicName, email, phoneNumber, mobileNumber, fax, city, jobTitle, employeeNumber, loginName, networkLoginName, privateMobileNumber, isManager, hasSspAccess, isCaller, archived, gender, showBranch, showSubsidiaries, authorizeBranch, authorizeSubsidiaryBranches, creationDate, modificationDate, department,… - **Get single TOPdesk person by ID** (Get). Get a single person in TOPdesk by id. Returns the full person object including id, firstName, surName, dynamicName, email, phoneNumber, mobileNumber, fax, jobTitle, department, city, branch, location, and archived. Required: id. - **TOPdesk people partial update** (Update). Partially update a TOPdesk person by id (v2). Returns the updated person including id, firstName, surName, dynamicName, email, branch, department, and language. Required: id. The 'department' field varies based on user settings — use an object with 'id' for a drop-down list or 'name' for a plain text field. This v2 endpoint is not backward compatible with the previous version. - **TOPdesk people archive** (Archive). Archive a person and its linked operator (if any) in TOPdesk. Returns the archived person object including id, firstName, surName, and email. Required: person_id. An archiving reason must be supplied in the request body. - **TOPdesk people archive patch** (Archive). Archive a person (and its linked operator if one exists) in TOPdesk by providing an archiving reason. Returns the archived person object including id, firstName, surName, email, archived, and archivingReason. Required: person_id. The archiving reason body may be omitted if a default archiving reason is configured; if omitted and no default exists, the request fails. - **List all TOPdesk persons counts** (List). Get the total number of persons in TOPdesk, optionally filtered by a FIQL search expression. Returns: count. - **TOPdesk persons counts list requester** (List). Get the total number of active persons for SSP users in TOPdesk — only counts persons marked as callers (requesters) that are not archived. Returns: count. Archived persons are never returned. - **List all TOPdesk person persongroups** (List). List person groups that a TOPdesk person is a member of. Returns: id, name, archived. Required: person_id. - **List all TOPdesk avatars** (List). Get a person's avatar in TOPdesk by person id. Returns: image, mimeType. Required: id. - **List all TOPdesk person contracts** (List). Get a person's contract in TOPdesk. Returns: personId, contractInformation (including contractHours). Required: person_id. This endpoint version is not backward compatible with the previous contract endpoint version. - **TOPdesk person contracts bulk update** (Update). Update a person's contract in TOPdesk. Returns: personId, contractInformation (including contractHours). Required: id. This endpoint version is not backward compatible with the previous contract endpoint version. - **List all TOPdesk person private details** (List). Get a person's private details in TOPdesk. Returns: personId, address (including address.city). Required: person_id. This endpoint version is not backward compatible with the previous privateDetails endpoint. - **TOPdesk person private details bulk update** (Update). Update a person's private details in TOPdesk. Returns: personId, address (including address.city). Required: id. This endpoint version is not backward compatible with the previous privateDetails endpoint. - **List all TOPdesk persons lookups** (List). List TOPdesk person id and name pairs sorted by ascending name, with optional filtering by name prefix, archived status, and caller status. Returns: id, name. - **Get single TOPdesk persons lookup by ID** (Get). Get a single TOPdesk person lookup entry by id, returning a lightweight id and name pair. Returns: id, name. Required: id. - **List all TOPdesk person extra field a entries** (List). List non-archived person extra field A entries in TOPdesk. Returns each entry including its id and name. Optional filters: external_link_id (use with external_link_type), external_link_type (use with external_link_id). - **Create a TOPdesk person extra field a entry** (Create). Create a person extra field A entry in TOPdesk. Returns the created entry including id, name, and externalLink (id, type, date). Required: name. The name must be unique among person extra field A entries. - **List all TOPdesk person extra field b entries** (List). List non-archived person extra field B entries in TOPdesk. Returns each entry's id, name, and externalLink. - **Create a TOPdesk person extra field b entry** (Create). Create a person extra field B entry in TOPdesk. Returns the created entry including its id, name, and externalLink. Required: name. - **List all TOPdesk persongroups** (List). List TOPdesk person groups with FIQL filtering, sorting, and field selection. Returns: id, name. Without a query filter, all person groups including archived are returned. - **Create a TOPdesk persongroup** (Create). Create a new TOPdesk person group. Returns the created person group including id, name, archived, and branch. Required: name. - **Get single TOPdesk persongroup by ID** (Get). Get a single TOPdesk person group by id. Returns: id, name. Required: id. - **TOPdesk persongroups partial update** (Update). Update a TOPdesk person group by id. Returns the updated person group including id, name, archived, and branch. Required: id. - **TOPdesk persongroups archive** (Archive). Archive a TOPdesk person group by id. Returns: id, name. Required: persongroup_id. If the request body is omitted, a default archiving reason is applied when available. - **TOPdesk persongroups unarchive** (Action). Unarchive a person group in TOPdesk by its id. Returns the person group's id, name, archived state, and archiving reason. Required: persongroup_id. - **List all TOPdesk persongroup people** (List). List persons belonging to a specific person group in TOPdesk. Returns: id. Required: persongroup_id. Supports FIQL filtering via the query parameter and field selection via the fields parameter. - **List all TOPdesk persongroups lookups** (List). List TOPdesk person group id and name pairs, sorted by ascending name. Returns: id, name. Enabling $all bypasses page size and may degrade system performance. - **Get single TOPdesk persongroups lookup by ID** (Get). Get a single TOPdesk person group id and name pair by id. Returns: id, name. Required: id. - **Create a TOPdesk picture** (Create). Upload an image to TOPdesk. Returns the UUID id of the uploaded picture. Required: file. - **Get single TOPdesk picture by ID** (Get). Get a picture from TOPdesk by id, returned as a binary bytestream. The size parameter selects full or thumbnail. Required: id. - **List all TOPdesk supplier contacts** (List). List TOPdesk supplier contacts, optionally filtered by a FIQL search expression. Returns: id. When no query is provided, only active supplier contacts are returned. - **Get single TOPdesk supplier contact by ID** (Get). Get a single TOPdesk supplier contact by id. Returns: id. Required: id. - **List all TOPdesk suppliers** (List). List TOPdesk suppliers with optional FIQL filtering. Returns each supplier with id, name, forFirstLine, forSecondLine, forService, forOperationalActivity, forChangeManagement, archived, mainContact, visitorAddress, postalAddress, and externalLink. Max 100 per page. - **Get single TOPdesk supplier by ID** (Get). Get a single TOPdesk supplier by id. Returns the supplier object including id, name, forFirstLine, forSecondLine, forService, forOperationalActivity, forChangeManagement, archived, mainContact, visitorAddress, postalAddress, and externalLink. Required: id. - **List all TOPdesk suppliers lookups** (List). List TOPdesk suppliers as lightweight id and name lookup pairs, sorted by ascending name. Returns: id, name. Filter by name prefix or archived status; use $all to retrieve all entries at once (may impact performance). - **Get single TOPdesk suppliers lookup by ID** (Get). Get a single TOPdesk supplier as a lightweight lookup entry by id, returning only the supplier's id and name pair. Returns: id, name. Required: id. - **List all TOPdesk requester branches** (List). List branches available to SSP users in TOPdesk. Returns: id, name, archived. When no FIQL query is provided, only active branches are returned; using the query parameter returns both archived and non-archived branches. - **List all TOPdesk requester locations** (List). List TOPdesk requester locations available to SSP users. Returns: id, name. When no FIQL query filter is supplied, only active locations are returned by default. - **List all TOPdesk requester people** (List). List active TOPdesk requester persons (callers only) for SSP users. Archived persons are never returned. Returns: id. Use the fields parameter to select specific fields. - **Get single TOPdesk requester person by ID** (Get). Get a single TOPdesk requester person by id for SSP users. Only returns the person when marked as a caller and active (not archived). Returns: id. Required: id. Use the fields parameter to select specific fields. - **TOPdesk free field searchlists list incidents** (List). List optional drop-down values for a free-field searchlist on incidents in TOPdesk. Returns: id, name. Required: tab, searchlist. - **TOPdesk free field searchlists list branches** (List). List optional drop-down values for a free-field searchlist on branches in TOPdesk, optionally filtered by external link. Returns: id, name, externalLink. Required: tab, searchlist. - **TOPdesk free field searchlists list locations** (List). List optional drop-down values for a TOPdesk location free-field searchlist. Returns each entry's id, name, and externalLink (containing id, type, date). Required: tab (1 or 2), searchlist (1–5). - **TOPdesk free field searchlists list operators** (List). List optional free-field drop-down values for operators in TOPdesk. Returns each entry's id, name, and externalLink. Required: tab (1 or 2), searchlist (1–5). - **TOPdesk free field searchlists create operators** (Create). Create an optional operator drop-down list entry in TOPdesk for a specific free-fields tab and searchlist. Returns: id, name, externalLink. Required: tab, searchlist, name. The tab must be 1 or 2; the searchlist must be between 1 and 5. Entry names must be unique within the searchlist. - **TOPdesk free field searchlists list persons** (List). List optional drop-down values for a person free-field searchlist in TOPdesk. Returns an array of entries including id, name, order, archived status, and external link details. Required: tab (1 or 2), searchlist (1-5). - **TOPdesk free field searchlists create persons** (Create). Create an optional person free-field drop-down list entry in TOPdesk. Returns the created entry including its id, name, and externalLink. Required: tab (must be 1 or 2), searchlist (must be 1–5), and a request body containing the entry name. - **List all TOPdesk assets** (List). List TOPdesk assets with extensive filtering by template, status, linked entities, and OData expressions. Returns: id, name, etag, state, type, icon. Additional fields can be requested via the fields parameter. - **Create a TOPdesk asset** (Create). Create a new TOPdesk asset. Returns: id. Required: type_id plus all mandatory template-specific fields. - **Get single TOPdesk asset by ID** (Get). Get a single TOPdesk asset by id. Returns: id, name. Required: id. - **Update a TOPdesk asset by ID** (Update). Update an existing TOPdesk asset by id with modified field values. Returns: id, name. Required: id. - **TOPdesk assets archive** (Archive). Archive a TOPdesk asset by providing a reason for archiving. Returns: id, name. Required: asset_id, reasonId. - **TOPdesk assets get grid field values** (Get). Get the asset values stored in a grid widget field of a TOPdesk asset. Returns the grid asset structure response including id and schema-specific attribute fields. Required: assetId, fieldId. The v1 media type is deprecated; use the v2 Accept header. - **Get single TOPdesk assets template ID by ID** (Get). List all TOPdesk assets of a given type by template ID. By default only active assets are returned, each with its id; additional fields can be requested via the field parameter. Returns: id, name, type. Required: id (template ID). - **Create a TOPdesk assets template ID** (Create). Create a new TOPdesk asset by template ID. The request body maps field IDs to desired values. Returns: id, name, type. Required: template_id and a request body. - **Update a TOPdesk assets template ID by ID** (Update). Update an existing TOPdesk asset by mapping field IDs to new values. Returns: id. Required: template_id, id. Only specified fields are updated; null clears a value (required fields cannot be cleared). Updating an archived asset unarchives it. - **TOPdesk assets template IDS archive** (Archive). Archive a TOPdesk asset with a reason for archiving. Returns an empty 204 response on success. Required: template_id, asset_id, reasonId. If already archived, nothing happens. - **List all TOPdesk asset assignments** (List). List TOPdesk asset assignments for a specific asset, including assigned locations, branches, persons, and person groups. Returns: linkId, linkType, linkToId, branchId, inheritanceParentId. Required: asset_id. - **Delete a TOPdesk asset assignment by ID** (Delete). Remove an assigned branch, location, person, or person group from a TOPdesk asset by assignment link id. Returns an empty 200 response on success. Required: asset_id, id. - **TOPdesk asset assignments bulk update** (Update). Add a branch, location, person, or person group assignment to a single TOPdesk asset, stock, or bulk item. Returns: linkId, linkType, linkToId, branchId, inheritanceParentId. Required: asset_id, linkType, linkToId. - **List all TOPdesk asset actions** (List). List available actions (manual triggers) for a TOPdesk asset. Returns the manual triggers response object describing the actions that can be executed on the asset. Required: asset_id (UUID of the asset). - **Create a TOPdesk asset copy** (Create). Copy an active TOPdesk asset to create one or more duplicate assets. Returns a list of created asset copies, each including an id. Required: asset_id, numberOfCopies. Only available for active assets; when auto numbering is disabled on the source asset's template, prefix and startAt are also mandatory in the request body. - **Create a TOPdesk asset unarchive** (Create). Unarchive a TOPdesk asset by its id, restoring it from an archived state. Returns the unarchived asset object including its id, name, creationDate, and modificationDate. Required: asset_id. - **List all TOPdesk history current items** (List). List current external links to a TOPdesk asset as history items. Returns: id, type, next. Required: asset_id. - **List all TOPdesk history past items** (List). List past history items from the audit log for a specific TOPdesk asset, optionally including events from external sources. Returns: id, type. Required: asset_id. - **List all TOPdesk assets blanks** (List). Retrieve a blank, not-yet-persisted TOPdesk asset card for a specific template, showing all card fields and their properties including which are mandatory. Returns the blank asset object with id and template-specific field attributes. At least one of templateId or templateName must be provided; if both are given they must reference the same template. templateName only matches templates with a… - **Delete a TOPdesk assets delete by ID** (Delete). Delete several TOPdesk assets in bulk by providing a list of asset IDs. Returns: failed (asset IDs that could not be deleted due to existing links from other components). Required: assetIds. Assets that cannot be deleted do not prevent deletion of the remaining assets. - **Get single TOPdesk assets filter by ID** (Get). Search TOPdesk assets by submitting filter criteria in the request body, accepting the same parameters as the GET /assets endpoint but in JSON form to support complex multi-parameter filters. Returns matching asset records including id, name, modificationDate, and creationDate. Default page size is 50 entries. - **List all TOPdesk assets grid field assets** (List). Retrieve a single grid field asset row in TOPdesk identified by its asset ID and the host asset it belongs to. Returns: id. Required: assetId, hostAssetId. - **Update a TOPdesk assets grid field asset by ID** (Update). Update an existing grid field asset row in TOPdesk by providing modified field values as key-value pairs. Returns: id. A 202 response indicates some unknown fields in the request were ignored. Required: assetId, hostAssetId. - **Delete a TOPdesk assets delete grid field asset by ID** (Delete). Delete a row from a grid widget on a TOPdesk host asset and update the host asset. Returns: id. Required: assetId, hostAssetId. - **Create a TOPdesk assets unlink** (Create). Delete links between a specified entity and one or more assets in TOPdesk. Returns an UnlinkResponse object confirming the deletion result. Required: type, target_id, and a body containing assetIds. - **Create a TOPdesk assets linked knowledge item** (Create). Create links between a TOPdesk knowledge item and one or more assets in a single request. Returns a BulkLinkResponse indicating the results of the linking operation. Linking archived knowledge items is supported. Requires a request body specifying the knowledge item and the target assets. Maximum 50 assets per request. - **Create a TOPdesk assets linked service** (Create). Link a service to one or more assets in TOPdesk's Asset Management module. Returns: id, name. Archived assets or services cannot be linked. - **Create a TOPdesk assets linked task** (Create). Create links between a TOPdesk task (change, change activity, incident, operational activity, operational series, or problem) and one or more assets in a single request. Returns a bulk link response. Maximum 50 assets per request; linking archived assets or archived tasks is not allowed. Requires a request body specifying the task and asset identifiers. - **TOPdesk assets assignments bulk update** (Update). Add branch, location, person and person group assignments to multiple assets, stocks or bulk items in TOPdesk. Returns: links. Required: assetIds, linkType, linkToId. Maximum 50 asset IDs per request. - **List all TOPdesk asset links** (List). List TOPdesk asset links (relationships) for a given source asset. Returns: id, name, type. When both sourceId and targetId are provided, the direction of the link is also matched. Required: sourceId. - **Create a TOPdesk asset link** (Create). Create a link (relationship) between two TOPdesk assets. Returns: id, name, type. Required: sourceId, targetId. Use the possibleRelations endpoint to discover available relationship types before creating a link. - **Delete a TOPdesk asset link by ID** (Delete). Remove a link between two TOPdesk assets by relation id. Returns: id, name, type. Required: id. - **List all TOPdesk asset links possible relations** (List). List the possible relationship types between two TOPDESK assets. Returns an array of available link type ID strings (child, parent, and other link types). Required: sourceId, targetId. Returns an empty array if both assets are already linked in every possible way. - **List all TOPdesk asset statuses** (List). List all asset statuses in TOPdesk. By default only the ID of each status is returned; pass field=name to also include the translated display name. Returns: id, name. The field query parameter only accepts the value "name"; any other value returns a 400 error. - **List all TOPdesk capabilities** (List). List all link types (capabilities) in TOPdesk Asset Management. Returns: id, name, archived. - **Create a TOPdesk capability** (Create). Create a new link type (capability) in TOPdesk Asset Management. Returns: id. Required: name. The name must be non-empty, not too long, and unique among all link types. - **TOPdesk capabilities get by ID** (Get). Get a specific TOPdesk capability (link type) by its id. Returns: id, name, usage. Required: capability_id. - **Update a TOPdesk capability by ID** (Update). Update the name or inheritance status of an existing TOPdesk link type (capability). Returns: id, name. Required: id. A 400 is returned if the new name is empty, too long, or already used by another link type; a 409 indicates concurrent modification. - **Delete a TOPdesk capability by ID** (Delete). Delete a TOPdesk capability (link type) by id. Built-in link types and types currently used in relations cannot be deleted. Returns an empty 204 response on success. Required: id. - **TOPdesk capabilities archive** (Archive). Archive a TOPdesk capability (link type) by its id. Returns the archived capability object including its id and name. Required: capability_id. Returns 400 if the link type is already archived. - **Create a TOPdesk capabilitie unarchive** (Create). Unarchive a TOPdesk capability (link type) by its id, restoring a previously archived link type to active status. Returns the unarchived capability object including its id and name. Required: capability_id. Returns a 400 if the link type isn't currently archived. - **List all TOPdesk card types** (List). List all active asset templates (card types) in TOPdesk. Returns: name, id, fields, and operations for each template. Only active templates are returned. - **Get single TOPdesk dropdown by ID** (Get). Get all options for a TOPdesk dropdown in Asset Management by id. Returns a list of dropdown option objects, each with id and optionally name (include name via field=name). Required: id. - **TOPdesk dropdowns get query** (Search). Retrieve or create a dropdown option in TOPdesk Asset Management. If an option with the given name already exists (case-insensitive), its id is returned and archived options are unarchived; otherwise a new option is created. Returns: id. Required: dropdown_id, name. Name must not be null, blank, or exceed 60 characters. - **List all TOPdesk fields** (List). List TOPdesk asset management fields with optional filtering by display name, template, or resource category. Returns: id, name. Fields can be filtered by searchTerm, resourceCategory, templateId, excludedTemplateId, includeFromVisibleTemplatesOnly, and includeInUse. - **Get single TOPdesk field by ID** (Get). Get a single TOPdesk asset management field definition by id. Returns: id, name. Required: id. - **Delete a TOPdesk field by ID** (Delete). Delete a TOPdesk asset management field permanently by id. This also removes all recorded data and removes the field from templates, summary fields, data set widgets, and saved overview filters. Returns an empty response on success. Required: id. - **List all TOPdesk import assets** (List). List all non-archived assets in TOPdesk. Returns: id, name. By default only the asset ID is included; use the 'field' query parameter to request additional fields — only 'name' and 'id' are supported. To retrieve other fields, use the API for querying assets of a specific type instead. - **List all TOPdesk stock quantities** (List). List stock quantities in TOPdesk by stock or bulk item. When using stockId, returns all bulk items linked to that stock with their quantities; when using bulkItemId, returns all stocks linked to that bulk item with their quantities. Returns: id, name, quantity. Exactly one of stockId or bulkItemId must be provided; providing both or neither returns an error. - **Create a TOPdesk stock quantity** (Create). Link a bulk item to a stock in TOPdesk with a specified initial quantity. Returns: id. Required: stockId, bulkItemId, quantity. - **Update a TOPdesk stock quantity by ID** (Update). Update the quantity of a bulk item on a stock in TOPdesk by relationship id. Returns: id, name, quantity. Required: id, quantity. An If-Match header with the current ETag is required. - **Delete a TOPdesk stock quantity by ID** (Delete). Remove the link between a bulk item and a stock in TOPdesk by relationship id. Returns an empty 204 response on success. Required: id. - **List all TOPdesk stock totals** (List). List stock statistics in TOPdesk showing which asset types and bulk items are in stock, how many stocks each appears in, instance counts for asset types, and total quantities for bulk items. Returns: attributes. Archived items are always included; items without read permission or excluded by branch filters are omitted. - **List all TOPdesk templates** (List). List TOPdesk asset management templates (asset types). Returns each template's id and name. Template IDs are needed when creating new assets or filtering assets by type. - **List all TOPdesk uploads** (List). List uploaded file blobs attached to a TOPdesk asset. Returns: id. Required: assetId. - **Create a TOPdesk upload** (Create). Upload one or more file blobs to a TOPdesk asset using multipart form data. Returns: id. Required: assetId, file. - **Delete a TOPdesk upload by ID** (Delete). Delete an uploaded file blob from TOPdesk by id. Returns an empty 204 response on success. Required: id. - **TOPdesk import links children bulk update** (Import). Set the children of a TOPdesk asset by providing a list of asset IDs representing the desired child links; assets not yet linked are linked and those no longer listed are unlinked. Returns a LinkResults object listing any errors encountered during (un)linking. Required: asset_id. Only available for active assets with a relationships widget; response code is 200 even when individual link… - **Update a TOPdesk import links incoming by ID** (Update). Set an asset's incoming dependency links by link type in TOPdesk. The body is a list of asset or stock UUIDs representing the desired state — new entries are assigned, absent ones unlinked. Returns: errors. Required: asset_id, id. Response is 200 even when individual linking errors occur; an asset cannot be linked to itself. - **Update a TOPdesk import links outgoing by ID** (Update). Set an asset's outgoing (provided) links by link type in TOPdesk. The body is a list of asset IDs representing the desired state; assets not in the list are unlinked. Returns: errors. Required: asset_id, id (link_type_id). Only available for active assets with a relationships widget providing the specified link type; an asset cannot be linked to itself. - **TOPdesk import links parents bulk update** (Import). Set the parent links of a TOPdesk asset by providing the desired list of parent asset IDs — new IDs are linked and previously linked parents not in the list are unlinked. Returns: linked, unlinked, errors. Required: asset_id. Only available for active assets with a relationships widget; an asset cannot be linked to itself or to an asset it already directly or indirectly parents. - **TOPdesk assignment branches bulk update** (Update). Assign branches to a TOPdesk asset by submitting a list of branch IDs that represents the desired state of branch assignments. Returns the link results, with any errors encountered during (un)assignment listed in the response body. Required: template_id, asset_id. Only available for active assets with an assignment widget. - **TOPdesk assignment locations bulk update** (Update). Assign locations to a TOPdesk asset with a list of location IDs representing the desired state; locations not in the list are unassigned. Returns the link results including any errors that occurred during (un)assignment. Required: template_id, asset_id. Only available for active assets with an assignment widget; the response code is still 200 when errors occur. - **TOPdesk assignment person groups bulk update** (Update). Set the desired state of person group assignments for a TOPdesk asset. Returns: errors encountered during (un)assignment. Required: template_id, asset_id, and a body listing person group IDs. Only available for active assets with an assignment widget; the response is always 200 even when errors occur. - **TOPdesk assignment people bulk update** (Update). Assign persons to a TOPdesk asset by submitting the desired list of person IDs. The supplied list represents the desired state — persons in the list but not yet assigned will be assigned, and persons assigned but absent from the list will be unassigned. Returns: errors (any errors encountered during assignment are listed in the response body, and the HTTP status remains 200 even when errors… - **List all TOPdesk services** (List). List TOPdesk services sorted alphabetically, optionally filtered by a linked object. Returns: id, name. Archived services are not included. objectId and assetId are mutually exclusive and cannot be combined in the same query. - **Create a TOPdesk service** (Create). Create a non-reservable TOPdesk service with the provided name. Returns the created service including its id and name. Required: name. - **Get single TOPdesk service by ID** (Get). Get a single TOPdesk service by its id. Returns the service details including id and name. Required: id. - **List all TOPdesk service linked assets** (List). List TOPdesk assets linked to a service. Returns: id, assetId, name. Required: service_id. - **Create a TOPdesk service linked asset** (Create). Link one or more assets to a TOPdesk service by their id or assetId. Returns the updated list of linked assets for the service. Required: service_id. Cannot link an asset if either the service or asset is archived, or if the asset is already linked to the service. - **Update a TOPdesk service linked asset by ID** (Update). Update properties of a link between an asset and a service in TOPdesk. Returns an empty 204 response on success. Required: service_id, id. The link cannot be updated if either or both cards are archived. - **Delete a TOPdesk service linked asset by ID** (Delete). Unlink an asset from a service in TOPdesk. Returns an empty 204 response on success. Required: service_id, id. The asset cannot be unlinked if either or both cards are archived. - **List all TOPdesk operational activities** (List). List TOPdesk operational activities, returning both archived and non-archived items by default. Returns: id, number, creationDate, modificationDate, plannedStartDate, plannedEndDate, estimatedCosts, estimatedTime, request, action, operator, operatorGroup, status, type, category, subcategory, supplier, schema, grouping, series, creator, modifier, caller, searchlist, skipped, anomaly, archived,… - **Create a TOPdesk operational activity** (Create). Create a new TOPdesk operational activity. Returns the created activity with id, number, operator, operatorGroup, status, type, and other fields. Fields like type, category, subcategory, operator, operatorGroup, supplier, status, and searchlist can be set by UUID or name. Required: briefDescription, plannedStartDate, plannedEndDate. - **Get single TOPdesk operational activity by ID** (Get). Get a single TOPdesk operational activity by id or number. Returns: id, type, schema. Required: identifier. - **Update a TOPdesk operational activity by ID** (Update). Update an existing operational activity in TOPdesk using the deprecated POST endpoint — prefer partial_update (PATCH) where possible. Only send fields that need updating; sending null clears optional fields or causes a Bad Request for mandatory ones. operator and operatorGroup must be sent together. Returns an empty 204 response on success. Required: identifier. - **TOPdesk operational activities list attachments** (List). List attachments for a TOPdesk operational activity, sorted by entry date descending. Returns: id, name, type. Inline images are not returned. Required: identifier. - **TOPdesk operational activities bulk update** (Update). Partially update an existing operational activity in TOPdesk using merge-patch semantics. Only send fields that need updating; sending null clears their value. Co-dependent field pairs must be sent together: operator with operatorGroup, category with subcategory, grouping with schema. Returns an empty 204 response on success. Required: identifier. - **List all TOPdesk operational activities settings** (List). Get operational activities settings in TOPdesk. Returns a settings object indicating which fields that can be set as mandatory on operational activities are currently mandatory. No caller-supplied parameters are required. - **List all TOPdesk linked objects** (List). List linked configuration management objects of a TOPdesk operational activity by identifier. Returns: id, name. This endpoint only returns configuration management objects, not linked assets. Required: identifier. - **Create a TOPdesk linked asset** (Create). Link one or more assets to an operational activity in TOPdesk by sending an array of assets, each identified by either id or name (not both). Archived assets cannot be linked. Returns an empty 201 response on success. Required: identifier. - **List all TOPdesk linked locations** (List). List linked locations of a TOPdesk operational activity, returning an array of IdAndName objects with id and name for each location. This endpoint is deprecated; use the operational activity details endpoint with accept-header application/x.topdesk-om-activity-v1+json instead. Returns: id, name. Required: identifier. - **Create a TOPdesk linked location** (Create). Link one or more locations to a TOPdesk operational activity. Each location is specified by either id or name; archived locations cannot be linked. Returns an empty 201 response on success. Required: identifier. - **List all TOPdesk linked branches** (List). List branches linked to a TOPdesk operational activity. Returns each linked branch's id and name. This endpoint is deprecated; use the operational activity details endpoint with the appropriate accept header instead. Required: identifier. - **Create a TOPdesk linked branch** (Create). Link one or more branches to a TOPdesk operational activity. Each branch is specified by either id or name. Returns an empty 201 Created response on success. Archived branches cannot be linked. Required: identifier. - **List all TOPdesk time registrations** (List). List time registrations for a TOPdesk operational activity, sorted by entry date descending and creation date ascending. Returns: id. Required: identifier. - **Create a TOPdesk time registration** (Create). Register time spent on a TOPdesk operational activity by submitting a JSON request body based on the timeRegistrationCreate schema. Returns an empty 200 response on success. Required: identifier. - **Create a TOPdesk attachments upload** (Create). Upload a file attachment to a TOPdesk operational activity identified by its id. Returns: id, name, type. Suitable for adding files only, not links. Required: identifier. - **List all TOPdesk operational activity emails** (List). List emails of a TOPdesk operational activity. Emails are sorted by send date descending; archived emails are not returned. Returns: id, subject, actionName. Required: identifier. - **Get single TOPdesk operational activity email by ID** (Get). Get a single email from a TOPdesk operational activity by id. Archived emails are also returned by this endpoint. Returns: id, subject, content. Required: id, identifier. - **List all TOPdesk operational activities statuses** (List). List non-archived operational activity statuses in TOPdesk. Returns: id, name. Only non-archived statuses are returned. - **List all TOPdesk operational activities reasons for skippings** (List). List non-archived reasons for skipping for operational activities in TOPdesk. Returns: id, name. Only non-archived entries are returned. - **List all TOPdesk operational activities reasons for anomalies** (List). List non-archived reasons for anomaly for operational activities in TOPdesk. Returns: id, name. - **List all TOPdesk operational activities types** (List). List operational activity types in TOPdesk, optionally filtered by a FIQL search expression. Returns: id, name. - **List all TOPdesk operational series** (List). Get a single TOPdesk operational series by identifier. Returns the series object including id, briefDescription, and number. Required: identifier. - **List all TOPdesk operational activities schemas** (List). List operational activity schemas in TOPdesk. Returns: id, name. Items are sorted by name:asc by default and can be filtered with a FIQL expression via the query parameter or narrowed with the fields parameter. - **List all TOPdesk operational activities groupings** (List). List groupings for operational activities in TOPdesk. Returns: id, name. Supports FIQL filtering, field selection, and sorting. Default sort is name ascending. - **Delete a TOPdesk operational activity attachment by ID** (Delete). Delete a file attachment from an operational activity in TOPdesk. Returns an empty 204 response on success. Required: identifier, id. - **TOPdesk operational activity attachments download** (Download). Download a file attachment from an operational activity in TOPdesk. Returns the raw file content as a binary stream with Content-Disposition and Content-Length headers; suitable for retrieving files but not links. Required: identifier, attachment_id. - **List all TOPdesk reservations** (List). List TOPdesk reservations. Returns each reservation with id, number, requester, operator, operatorGroup, processingStatus, recurrencySeriesId, modificationDate, and briefDescription. - **Create a TOPdesk reservation** (Create). Create a new TOPdesk reservation, specifying the requester and optional details such as operator, operatorGroup, and processingStatus. Returns the created reservation including id, number, requester, operator, operatorGroup, processingStatus, recurrencySeriesId, modificationDate, and briefDescription. - **Get single TOPdesk reservation by ID** (Get). Get a single TOPdesk reservation by identifier (id or reservation number). Returns: id, number, requester, operator, operatorGroup, processingStatus, recurrencySeriesId, modificationDate, briefDescription. Required: identifier. - **TOPdesk reservations approve** (Approve). Approve a TOPdesk reservation by identifier, triggering the approval workflow for the reservation. Returns: id, number, operator, operatorGroup, processingStatus, modificationDate, plannedStartDate, participants, reservedFacilities, recurrencySeriesId. Required: identifier. - **TOPdesk reservations cancel** (Cancel). Cancel a TOPdesk reservation by identifier. Returns the updated reservation including id, number, operator, operatorGroup, and processingStatus. Required: identifier. - **TOPdesk reservations reject** (Reject). Reject a TOPdesk reservation by identifier. Returns the updated reservation including id, number, operator, operatorGroup, and processingStatus. Required: identifier. - **TOPdesk reservations reschedule** (Action). Reschedule a TOPdesk reservation by identifier. Returns the updated reservation including id, number, operator, operatorGroup, and processingStatus. Required: identifier. - **TOPdesk reservations list attachments** (List). List attachments for a TOPdesk reservation by identifier. Returns each attachment with id, name, and type. Required: identifier. - **TOPdesk reservations upload attachment** (Upload). Upload a file attachment to a TOPdesk reservation by identifier. Returns the created attachment object including its id, name, and type. Required: identifier, file. - **TOPdesk reservations bulk update** (Update). Partially update a TOPdesk reservation by identifier — send only the fields that need to be updated; fields with empty or null values will clear their value. Returns: id, number, operator, operatorGroup, processingStatus, modificationDate, plannedStartDate, participants, reservedFacilities, recurrencySeriesId. Required: identifier. - **List all TOPdesk reservations numbers** (List). Get a TOPdesk reservation by its reservation number. Deprecated; use /reservations/{identifier} instead, which also accepts the number. Returns: id. Required: number. - **TOPdesk reservations numbers bulk update** (Update). Partially update a TOPdesk reservation by its number. Deprecated; use /reservations/{identifier} instead. Status, plannedStart/EndDate, and reservedFacilities require dedicated endpoints. Setting requester updates related person fields; only one external link can be set. Returns: id, number, status, archived, briefDescription, notes, numberOfPersons, plannedStartDate, plannedEndDate,… - **Create a TOPdesk requester reservation** (Create). Create a reservation for an SSP (Self Service Portal) user in TOPdesk. Returns: id. Required: requester (must be set to the SSP user's own person-id). SSP users can only reserve assets; setting requester auto-populates related person fields. - **Create a TOPdesk make recurrent date** (Create). Make a TOPdesk reservation recurrent on specific dates. Returns a list of all reservations in the new series including id, number, status, series, plannedStartDate, and plannedEndDate. Required: identifier, dates. Dates must be unique ISO 8601 date-only strings (yyyy-MM-dd) after the original reservation; the series cannot exceed 999 total occurrences. - **Create a TOPdesk occurrences date** (Create). Add occurrences to a recurrent TOPdesk reservation series using the specific-dates pattern. Returns a list of all reservations in the new series including id, number, status, series, plannedStartDate, and plannedEndDate. Required: identifier, dates. Dates must be unique ISO 8601 date-only strings (yyyy-MM-dd) after the specified reservation; the series cannot exceed 999 occurrences total. - **TOPdesk occurrences dates bulk update** (Update). Set occurrences for a recurrent TOPdesk reservation series using the specific-dates pattern, keeping occurrences before the specified reservation and deleting those after it if not included. Returns a list of all reservations in the new series including id, number, status, series, plannedStartDate, and plannedEndDate. Required: identifier, dates. Dates must be unique ISO 8601 date-only strings… - **Create a TOPdesk participants add** (Create). Add participants to a TOPdesk reservation. Already-linked participants are silently ignored. Returns the updated reservation including id, reservationNumber, briefDescription, startDate, endDate, and status. Required: identifier. - **Create a TOPdesk participants remove** (Create). Remove participants from a TOPdesk reservation. Participants not already linked are silently ignored. Returns the updated reservation including id, number, status, briefDescription, plannedStartDate, plannedEndDate, and participants. Required: identifier. - **Create a TOPdesk reserved facilities add** (Create). Add reserved facilities to a reservation in TOPdesk. Returns the updated reservation including id, briefDescription, startDate, endDate, and status. Required: identifier and a request body specifying the facilities to add. Only planned or requested reservations and conflicts can have facilities changed; archived, cancelled, rejected, or recurring-series occurrences with issued facilities cannot… - **Create a TOPdesk reserved facilities move** (Create). Reschedule a reserved facility in a TOPdesk reservation, replacing one facility with another. Returns the updated reservation including id, briefDescription, and reservedFacilities. Required: identifier (the reservation id or number). Only planned or requested reservations and conflicts are eligible; archived, cancelled, or rejected reservations, reservations with issued facilities, and… - **Create a TOPdesk reserved facilities remove** (Create). Remove reserved facilities from a TOPdesk reservation. Returns the updated reservation including id, number, status, briefDescription, plannedStartDate, plannedEndDate, and reservedFacilities. Required: identifier. Only planned, requested, or conflicting reservations can be modified; archived, cancelled, or rejected reservations, reservations with issued facilities, and occurrences of recurring… - **Create a TOPdesk reservation reserved service** (Create). Add and remove services for a reserved facility on a TOPdesk reservation. Returns the updated reservation including id, number, briefDescription, status, startDate, endDate, and reservedFacilities. Required: identifier. Added services are reserved with default values from the service card; for removal, use the reserved service id from reservation.reservedFacilities.reservedServices.id, not the… - **List all TOPdesk reservations optional searchlists** (List). List optional searchlist entries for a given tab and searchlist number in TOPdesk reservations management. Returns: id, name. Required: tab, searchlist. - **Create a TOPdesk reservations optional searchlist** (Create). Create a new optional searchlist entry for TOPdesk reservations management. Returns the created entry including id and name. Required: tab, searchlist, name. - **TOPdesk reservations optional searchlists archive** (Archive). Archive an optional searchlist entry for reservations management in TOPdesk. Returns the archived entry including its id, name, external_link_id, and external_link_type. Required: tab, searchlist, identifier. - **TOPdesk reservations optional searchlists bulk update** (Update). Update the name or external link of an optional searchlist entry for reservations management in TOPdesk. Returns the updated entry including its id, name, external_link_id, and external_link_type. Required: tab, searchlist, identifier. - **List all TOPdesk reservation cancellation reasons** (List). List TOPdesk reservation cancellation reasons for planned reservations. Returns: id, name, archived. The archived query parameter defaults to false and does not allow null/unspecified. - **Create a TOPdesk reservation cancellation reason** (Create). Create a new TOPdesk reservation cancellation reason for planned reservations. Returns: id, name, archived. Required: name. - **TOPdesk reservation cancellation reasons archive** (Archive). Archive a TOPdesk reservation cancellation reason for planned reservations. Returns: id, name, archived. Required: identifier. - **TOPdesk reservation cancellation reasons unarchive** (Action). Unarchive a TOPdesk reservation cancellation reason for planned reservations. Returns: id, name, archived. Required: identifier. - **TOPdesk reservation cancellation reasons bulk update** (Update). Update the name of a TOPdesk reservation cancellation reason for planned reservations. Returns: id, name, archived. Required: identifier, name. - **List all TOPdesk reservation processing status** (List). List reservation processing statuses in TOPdesk. Returns: id, name, archived. Use the optional archived parameter to filter for archived or active entries only. - **Create a TOPdesk reservation processing status** (Create). Create a processing status option for reservations and requests in TOPdesk. Returns the created searchlist entry including its id, name, and archived flag. Required: name. - **TOPdesk reservation processing status archive** (Archive). Archive a reservation processing status in TOPdesk. Returns the archived searchlist entry including its id, name, and archived status. Required: identifier. - **TOPdesk reservation processing status unarchive** (Action). Unarchive a reservation processing status in TOPdesk. Returns the unarchived searchlist entry including its id, name, and archived status. Required: identifier. - **TOPdesk reservation processing status bulk update** (Update). Update the name of a reservation processing status option for reservations and requests in TOPdesk. Returns the updated processing status entry including its id and name. Required: identifier. - **List all TOPdesk reservation rejection reasons** (List). List reservation rejection reasons in TOPdesk. Returns each rejection reason with its id, name, and archived status. The archived parameter defaults to false, showing only active entries by default. - **Create a TOPdesk reservation rejection reason** (Create). Create a rejection reason for reservation requests in TOPdesk. Returns the created searchlist entry with its id and name. Required: name. - **TOPdesk reservation rejection reasons archive** (Archive). Archive a TOPdesk reservation rejection reason by its identifier or name. Returns the updated searchlist entry including its id and name. Required: identifier. - **TOPdesk reservation rejection reasons unarchive** (Action). Unarchive a TOPdesk reservation rejection reason by its identifier or name. Returns the updated searchlist entry including its id, name, and archived status. Required: identifier. - **TOPdesk reservation rejection reasons bulk update** (Update). Update the name of a reservation rejection reason in TOPdesk. Returns the updated rejection reason including its id and name. Required: identifier. - **List all TOPdesk service types** (List). List service types in TOPdesk, optionally filtering by archived status. Returns each entry with id and name. Omit the archived parameter to return both active and archived entries. - **Create a TOPdesk service type** (Create). Create a service type in TOPdesk. Returns the created service type with id, name, and archived. Required: name. - **TOPdesk service types archive** (Archive). Archive a service type in TOPdesk by its identifier or name. Returns the archived service type with id and name. Required: identifier. - **TOPdesk service types unarchive** (Action). Unarchive a service type in TOPdesk by its identifier or name. Returns the unarchived service type with id, name, and archived. Required: identifier. - **TOPdesk service types bulk update** (Update). Update a service type in TOPdesk by its identifier or name. Returns the updated service type with id and name. Required: identifier, name. - **List all TOPdesk visitors** (List). List TOPdesk visitors with RSQL filtering and field selection. Returns: id, archived, visitor, visit, host. Use the query parameter for RSQL filtering (e.g. archived==false, visit.arrivalStatus==expected) and the fields parameter to select specific response fields. - **Create a TOPdesk visitor** (Create). Create a new visitor in TOPdesk. Returns the created visitor object including id, archived, visitor, visit, and host. The POST /visitors endpoint is not documented in the source; refer to the TOPdesk Visitor Registration API documentation for available request fields. - **Get single TOPdesk visitor by ID** (Get). Get a single TOPdesk visitor by identifier. Returns: id, archived, visitor, visit, host. The visit section includes arrivalStatus. Required: identifier. - **TOPdesk visitors archive** (Archive). Archive a visitor in TOPdesk by identifier. Optionally supply an archiving reason in the request body; if omitted, the default archiving reason is applied when available. Returns: id, name, archived. Required: identifier. - **TOPdesk visitors list attachments** (List). List file attachments for a TOPdesk visitor by identifier. Returns: id, name, type, description, entryDate, mimeType. Required: identifier. - **TOPdesk visitors upload attachment** (Upload). Upload a file attachment to a TOPdesk visitor. Returns the created attachment including id, name, type, description, entryDate, and mimeType. Required: identifier, file. - **TOPdesk visitors bulk update** (Update). Partially update a TOPdesk visitor by identifier. Returns the updated visitor including id, visitor (name, phoneNumber), host, visit (arrivalStatus, expectedArrival), and archived. Required: identifier. - **Delete a TOPdesk visitor attachment by ID** (Delete). Delete an attachment from a TOPdesk visitor. Returns an empty 204 response on success. Required: identifier, id. Only available for operators; SSP users should use the delete_requester method instead. - **TOPdesk visitor attachments delete requester** (Delete). Delete an attachment from a TOPdesk visitor for SSP users. Returns an empty 204 response on success. Required: identifier, attachment_id. Only available when SSP users can view visitors; not available for operators. - **Create a TOPdesk visitor unarchive** (Create). Unarchive a TOPdesk visitor by its id or number. Returns an empty 204 response on success. Required: identifier. - **List all TOPdesk requester visitors** (List). List visitors in TOPdesk via the requester (SSP) endpoint, an alternative for GET /visitors. Returns: identifier, archived, visitor, visit, host. Supports FIQL query filtering (e.g. by archived status, visitor phone number, or host branch) and field selection via the fields parameter. - **Get single TOPdesk requester visitor by ID** (Get). Get a single visitor in TOPdesk by identifier via the requester (SSP) endpoint. Returns: identifier, archived, visitor, visit, host. Required: identifier. - **TOPdesk requester visitors list attachments** (List). List attachments for a TOPdesk visitor by identifier. Returns each attachment's id, name, and type. Required: identifier. - **TOPdesk requester visitors upload attachment** (Upload). Upload a file attachment to a TOPdesk visitor registration identified by identifier. Returns the uploaded attachment object including id, name, and type. Required: identifier, file. - **TOPdesk requester visitors bulk update** (Update). Partially update a visitor in TOPdesk by identifier via the requester (SSP) endpoint, an alternative for PATCH /visitors/{identifier}. Returns the updated visitor object including identifier, archived, visitor, visit, host. Required: identifier. - **List all TOPdesk badges** (List). List TOPdesk badges, optionally filtering by archived status. Returns: id, name. - **Create a TOPdesk badge** (Create). Create a new TOPdesk badge. Returns: id, name. Required: name. - **TOPdesk badges archive** (Archive). Archive a TOPdesk badge by id or name. Returns an empty 204 response on success. Required: identifier. - **TOPdesk badges bulk update** (Update). Update a TOPdesk badge by id or name. Returns an empty 204 response on success. Required: identifier. - **Create a TOPdesk badge unarchive** (Create). Unarchive a TOPdesk badge by its id or name. Returns an empty 204 response on success. Required: identifier. - **List all TOPdesk car parks** (List). List car parks available in TOPdesk's Visitor Registration module. Returns: id, number, request, action, briefDescription, changeType, caller, operator, operatorGroup, requester, template. - **Create a TOPdesk car park** (Create). Create a new car park in TOPdesk's visitor management module. Returns the created car park record including its id and resource-specific attributes. Accepts a JSON request body with car park properties as defined in the TOPdesk Visitors API explorer. - **TOPdesk car parks archive** (Archive). Archive a car park in TOPdesk by its identifier. Returns the archived car park object including its id, name, and archived state. Required: identifier. - **TOPdesk car parks unarchive** (Action). Unarchive a car park in TOPdesk by its identifier. Returns the unarchived car park object including its id. Required: identifier. - **TOPdesk car parks bulk update** (Update). Update a car park in TOPdesk by its identifier. Returns: id. Required: identifier. Send the fields to update as a JSON body; consult the TOPdesk Visitor Registration API documentation for the full list of updatable car park fields. - **List all TOPdesk identification types** (List). List identification types in TOPdesk for visitor registration. Returns: id, name, archived. - **Create a TOPdesk identification type** (Create). Create a new identification type in TOPdesk for visitor registration. Returns: id, name, archived. Required: name. - **TOPdesk identification types archive** (Archive). Archive an identification type in TOPdesk, marking it as no longer active. Returns: id, name, archived. Required: identifier. - **TOPdesk identification types unarchive** (Action). Unarchive an identification type in TOPdesk, making it active again. Returns: id, name, archived. Required: identifier. - **TOPdesk identification types bulk update** (Update). Update an existing identification type in TOPdesk. Returns: id, name, archived. Required: identifier. - **List all TOPdesk visitor optional searchlists** (List). List TOPdesk visitor optional searchlist (drop-down) entries for a given tab and searchlist number. Returns: id, name, external_link. Required: tab, searchlist. - **Create a TOPdesk visitor optional searchlist** (Create). Create a new TOPdesk visitor optional searchlist (drop-down) entry. Returns: id, name, external_link. Required: tab, searchlist, name. - **TOPdesk visitor optional searchlists archive** (Archive). Archive a TOPdesk visitor optional searchlist (drop-down) entry by identifier. Returns: id, name, external_link. Required: tab, searchlist, identifier. - **TOPdesk visitor optional searchlists unarchive** (Action). Unarchive a TOPdesk visitor optional searchlist (drop-down) entry by identifier. Returns: id, name, external_link. Required: tab, searchlist, identifier. - **TOPdesk visitor optional searchlists bulk update** (Update). Update a TOPdesk visitor optional searchlist (drop-down) entry by identifier. Returns: id, name, external_link. Required: tab, searchlist, identifier. - **List all TOPdesk facility occupancies** (List). List facility occupancies from TOPdesk's Reservations API. Returns a collection of occupancy records, each with an id and facility-specific attributes whose shape depends on the upstream schema. - **List all TOPdesk overview reservations** (List). List overview reservations in TOPdesk. Returns: id, operator, operatorGroup, processingStatus. - **Get single TOPdesk overview reservation by ID** (Get). Get a single overview reservation in TOPdesk by id. Returns: id, operator, operatorGroup, processingStatus. Required: id. - **List all TOPdesk overview reservations numbers** (List). Retrieve a reservation overview from TOPdesk by its reservation number. Returns reservation overview details. Required: number. - **List all TOPdesk reservable assets** (List). List reservable assets in TOPdesk for a given time period and asset template. Returns: id, name, branches, location. The endpoint calculates availability based on service windows and block time. - **TOPdesk reservable intervals list by asset** (List). List reservable intervals for a specific reservable asset in TOPdesk. Returns the time intervals during which the asset is available for reservation. Required: identifier. - **TOPdesk reservable intervals list by location** (List). Get the reservable interval for a specific TOPdesk reservable location, representing the period starting from a given date/time in which the location is still reservable. The returned date/time format can be used for the plannedFrom and plannedTo parameters of the /api/reservations endpoints. Returns: start, end. Required: reservablelocation_id. - **List all TOPdesk reservable locations** (List). List reservable locations in TOPdesk that are available for booking via the Reservations Management API. Returns: id, name, roomNumber, branch, capacity. Supports FIQL query filtering and field selection via $fields. When no query filter is used, only active (non-archived) locations are returned by default. - **Get single TOPdesk reservable location by ID** (Get). Get a single reservable location in TOPdesk by id. Returns: id. Required: id. - **List all TOPdesk reservable services** (List). List reservable services available in TOPdesk's Reservations Management API. Returns: id, name. - **Get single TOPdesk reservable service by ID** (Get). Get a specific reservable service by id in TOPdesk. Returns: id, name. Required: id. - **List all TOPdesk currencies** (List). Get the TOPdesk currency settings. Returns the currency configuration object with currency details used across TOPdesk modules. - **List all TOPdesk optionalfield fields** (List). Retrieve the names of enabled optional fields for a specified TOPdesk database table and field type. Returns a map of optional field identifiers to their display names (e.g., vrijedatum1 → 'Birthday', vrijedatum2 → 'Start Date', vrijetekst1 → 'Job Title'). Required: table, type. - **Create a TOPdesk tasknotifications custom** (Create). Create a custom task notification in TOPdesk sent to specified operators and operator groups. Returns an empty 201 response on success. Required: title. At least one of operatorIds or operatorGroupIds must be provided; if url is supplied it must start with '/tas/secure/'. - **Create a TOPdesk public** (Create). Create a record in TOPdesk via the public API endpoint, supporting incident-style payloads (request, action, caller, operator, operatorGroup) or change-style payloads (requester, briefDescription, template). Returns: id, number, requester, briefDescription, changeType.