--- title: TOPdesk API Integration on Truto slug: topdesk category: Helpdesk canonical: "https://truto.one/integrations/detail/topdesk/" --- # TOPdesk API Integration on Truto **Category:** Helpdesk **Status:** Beta ## MCP-ready AI tools Truto exposes 441 tools for TOPdesk that AI agents can call directly. - **list_all_to_pdesk_incidents** — 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_to_pdesk_incident** — 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. - **to_pdesk_incidents_deescalate** — Deescalate a TOPdesk incident by id. Returns the updated incident including id, number, briefDescription, caller, operator, and escalationStatus. Required: incident_id. - **to_pdesk_incidents_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. - **to_pdesk_incidents_escalate** — Escalate a TOPdesk incident by id. Returns the updated incident including id, number, briefDescription, caller, operator, and escalationStatus. Required: incident_id. - **get_single_to_pdesk_incident_by_id** — Get a single TOPdesk incident by id. Returns: request, action, caller, operator, operatorGroup, sla. Required: id. - **to_pdesk_incidents_partial_update** — Partially update a TOPdesk incident by id. Returns the updated incident including request, action, caller, operator, and operatorGroup. Required: id. - **to_pdesk_incidents_unarchive** — Unarchive a TOPdesk incident by incident_id. Returns the unarchived incident including request, action, caller, operator, and operatorGroup. Required: incident_id. - **update_a_to_pdesk_incident_by_id** — Update a TOPdesk incident by id. Returns the updated incident including request, action, caller, operator, and operatorGroup. Required: id. - **get_single_to_pdesk_incident_number_by_id** — Get a TOPdesk incident by its incident number. Returns: request, action, caller, operator, operatorGroup. Required: id. - **update_a_to_pdesk_incident_number_by_id** — Update a TOPdesk incident by its incident number with a full replacement body. Returns: request, action, caller, operator, operatorGroup. Required: id. - **to_pdesk_incident_numbers_partial_update** — Partially update a TOPdesk incident by its incident number. Returns: request, action, caller, operator, operatorGroup. Required: id. - **to_pdesk_incident_numbers_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. - **to_pdesk_incident_numbers_escalate** — Escalate a TOPdesk incident by its incident number, optionally providing an escalation reason. Returns: request, action, caller, operator, operatorGroup. Required: number_id. - **to_pdesk_incident_numbers_deescalate** — 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). - **to_pdesk_incident_numbers_unarchive** — 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. - **to_pdesk_incident_attachments_list_by_id** — List attachments for a TOPdesk incident identified by id. Returns: id, name, type, description, invisibleForCaller. Required: incident_id. - **to_pdesk_incident_attachments_upload_by_id** — 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. - **to_pdesk_incident_attachments_list_by_number** — List attachments for a TOPdesk incident identified by number. Returns: id, name, type, description, invisibleForCaller. Required: incident_number. - **to_pdesk_incident_attachments_upload_by_number** — 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. - **to_pdesk_incident_attachments_delete_by_id** — Delete a file attachment from a TOPdesk incident identified by incident id. Returns an empty response on success. Required: incident_id, attachment_id. - **to_pdesk_incident_attachments_delete_by_number** — Delete a file attachment from a TOPdesk incident identified by incident number. Returns an empty 204 response on success. Required: incident_number, attachment_id. - **to_pdesk_incident_attachments_download_by_id** — 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. - **to_pdesk_incident_attachments_download_by_number** — 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. - **to_pdesk_incident_images_list_by_id** — 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. - **to_pdesk_incident_images_list_by_number** — 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. - **to_pdesk_incident_images_get_by_id** — 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. - **to_pdesk_incident_images_get_by_number** — 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_to_pdesk_requester_incidents** — 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_to_pdesk_requester_incident** — 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_to_pdesk_requester_incident_by_id** — 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:… - **to_pdesk_requester_incidents_partial_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_to_pdesk_requester_incident_number_by_id** — Get a single TOPdesk requester incident by incident number. Returns: request, action, caller, operator, operatorGroup, sla. Required: id (the incident number). - **to_pdesk_requester_incident_numbers_partial_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). - **to_pdesk_requester_incident_attachments_list_by_id** — 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. - **to_pdesk_requester_incident_attachments_upload_by_id** — 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. - **to_pdesk_requester_incident_attachments_list_by_number** — 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. - **to_pdesk_requester_incident_attachments_upload_by_number** — 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. - **to_pdesk_requester_incident_attachments_download_by_id** — 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. - **to_pdesk_requester_incident_images_list_by_id** — List inline images for a TOPdesk incident identified by id, for SSP users. Returns: downloadUrl, filename, originalFileName, fileSize, invisibleForCaller. Required: incident_id. - **to_pdesk_requester_incident_images_list_by_number** — List inline images for a TOPdesk incident identified by number, for SSP users. Returns: downloadUrl, filename, originalFileName, fileSize, invisibleForCaller. Required: number_id. - **list_all_to_pdesk_incident_call_types** — List incident call types in TOPdesk. Returns: id, name. - **to_pdesk_incident_call_types_list_requester** — List incident call types for SSP (Self Service Portal) users in TOPdesk. Returns: id, name. - **list_all_to_pdesk_incident_durations** — List available incident duration options in TOPdesk. Returns: id, name. - **list_all_to_pdesk_incident_entry_types** — List incident entry types in TOPdesk. Returns an array of searchlist objects, each containing id and name. - **list_all_to_pdesk_incident_impacts** — List all incident impacts (searchlist values) available in TOPdesk. Returns: id, name. No required parameters. - **list_all_to_pdesk_incident_priorities** — List incident priorities in TOPdesk. Returns: id, name, duration. No required parameters. - **list_all_to_pdesk_incident_statuses** — 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_to_pdesk_incident_categories** — List incident categories in TOPdesk. Returns: id, name. - **to_pdesk_incident_categories_list_requester** — List incident categories available to SSP (self-service portal) users in TOPdesk. Returns: id, name. - **list_all_to_pdesk_incident_subcategories** — 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. - **to_pdesk_incident_subcategories_list_requester** — List incident subcategories available to SSP (Self Service Portal) users in TOPdesk. Returns: id, name. No required parameters. - **list_all_to_pdesk_incident_closure_codes** — List closure codes in TOPdesk available for closing incidents. Returns: id, name. - **list_all_to_pdesk_incident_urgencies** — 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_to_pdesk_incident_deescalation_reasons** — List deescalation reasons available for TOPdesk incidents. Returns: id, name. The deescalation feature must be enabled in TOPdesk. - **list_all_to_pdesk_incident_escalation_reasons** — List the available incident escalation reasons in TOPdesk. Returns: id, name. The escalation feature must be enabled on the TOPdesk environment. - **list_all_to_pdesk_incident_slas** — 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_to_pdesk_sla_services** — List SLA services available in TOPdesk for incident SLA configuration. Returns an array of service entries, each containing id and name. No required parameters. - **to_pdesk_incident_timespents_list_by_id** — Retrieve time spent entries registered on a TOPdesk incident by incident id. Returns: request, action, caller, operator, operatorGroup. Required: incident_id. - **to_pdesk_incident_timespents_create_by_id** — 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. - **to_pdesk_incident_timespents_list_by_number** — Retrieve time spent entries registered on a TOPdesk incident by incident number. Returns: request, action, caller, operator, operatorGroup. Required: number. - **to_pdesk_incident_timespents_create_by_number** — 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_to_pdesk_incident_timeregistrations** — 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_to_pdesk_incident_timeregistration_by_id** — Get a single TOPdesk incident time registration by id. Returns: id, request, action, caller, operator, operatorGroup, timeSpent, creationDate, modificationDate. Required: id. - **list_all_to_pdesk_timespent_reasons** — List reasons for time spent in TOPdesk. Returns: id, name. These are simple IdAndName lookup objects used when registering time spent on incidents. - **to_pdesk_incident_progresstrails_list_by_id** — 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. - **to_pdesk_incident_progresstrails_list_by_number** — 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. - **to_pdesk_incident_progresstrails_list_requester_by_id** — List incident progress trail entries for a TOPdesk incident by incident id. Returns: request, action, caller, operator, operatorGroup. Required: incident_id. - **to_pdesk_incident_progresstrails_list_requester_by_number** — List incident progress trail entries for a TOPdesk incident by incident number. Returns: request, action, caller, operator, operatorGroup. Required: number. - **to_pdesk_incident_progresstrail_counts_list_by_id** — Get the progress trail entry count for a TOPdesk incident by incident id (operator endpoint). Returns: count. Required: incident_id. - **to_pdesk_incident_progresstrail_counts_list_by_number** — Get the progress trail entry count for a TOPdesk incident by incident number (operator endpoint). Returns: count. Required: number. - **to_pdesk_incident_progresstrail_counts_list_requester_by_id** — Get the progress trail entry count for a TOPdesk incident by incident id, accessible by SSP users (persons). Returns: count. Required: incident_id. - **to_pdesk_incident_progresstrail_counts_list_requester_by_number** — Get the progress trail entry count for a TOPdesk incident by incident number, accessible by SSP users (persons). Returns: count. Required: number. - **to_pdesk_incident_actions_list_by_number** — List incident actions in TOPdesk by incident number. Returns: request, action, caller, operator, operatorGroup. Required: number. - **to_pdesk_incident_actions_list_by_id** — List incident actions in TOPdesk by incident id. Returns: request, action, caller, operator, operatorGroup. Required: incident_id. - **to_pdesk_incident_actions_get_by_id** — Get a single incident action in TOPdesk by incident id and action id. Returns: request, action, caller, operator, operatorGroup. Required: incident_id, action_id. - **to_pdesk_incident_actions_delete_by_id** — Delete an incident action in TOPdesk by incident id and action id. Returns an empty 204 response on success. Required: incident_id, action_id. - **to_pdesk_incident_actions_get_by_number** — Get a single incident action in TOPdesk by incident number and action id. Returns: request, action, caller, operator, operatorGroup. Required: incident_number, action_id. - **to_pdesk_incident_actions_delete_by_number** — Delete an incident action by incident number and action id in TOPdesk. Returns an empty 204 response on success. Required: incident_number, action_id. - **to_pdesk_incident_actions_list_requester_by_number** — List incident actions by incident number for SSP users in TOPdesk. Returns: request, action, caller, operator, operatorGroup. Required: number. - **to_pdesk_incident_actions_list_requester_by_id** — List incident actions by incident id for SSP users in TOPdesk. Returns: request, action, caller, operator, operatorGroup. Required: incident_id. - **to_pdesk_incident_actions_get_requester_by_id** — 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. - **to_pdesk_incident_actions_get_requester_by_number** — 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. - **to_pdesk_incident_requests_list_by_number** — List incident requests for a TOPdesk incident by incident number. Returns: request, action, caller, operator, operatorGroup. Required: number. - **to_pdesk_incident_requests_list_by_id** — List incident requests for a TOPdesk incident by incident id. Returns: request, action, caller, operator, operatorGroup. Required: incident_id. - **to_pdesk_incident_requests_get_by_id** — Get a specific TOPdesk incident request by incident id and request id. Returns: request, action, caller, operator, operatorGroup. Required: incident_id, request_id. - **to_pdesk_incident_requests_delete_by_id** — Delete a TOPdesk incident request by incident id and request id. Returns an empty 204 response on success. Required: incident_id, request_id. - **to_pdesk_incident_requests_get_by_number** — Get a TOPdesk incident request by incident number and request id. Returns: request, action, caller, operator, operatorGroup. Required: incident_number, request_id. - **to_pdesk_incident_requests_delete_by_number** — Delete a TOPdesk incident request by incident number and request id. Returns an empty 204 response on success. Required: incident_number, request_id. - **to_pdesk_incident_requests_list_requester_by_number** — 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. - **to_pdesk_incident_requests_list_requester_by_id** — 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. - **to_pdesk_incident_requests_get_requester_by_id** — 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. - **to_pdesk_incident_requests_get_requester_by_number** — 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_to_pdesk_login_operators** — 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_to_pdesk_login_people** — Generate an authentication token for a person in TOPdesk. Returns the authorization token as a string. No caller-supplied parameters required. - **list_all_to_pdesk_logouts** — Log out the current operator or person in TOPdesk. Returns an empty 200 response on success. - **list_all_to_pdesk_archiving_reasons** — List reasons for archiving in TOPdesk. Returns an array of archiving reason objects, each containing id and name. - **get_single_to_pdesk_emails_id_by_id** — Get details of a TOPdesk email by id for incidents, changes, and change activities. Returns: id, subject, content. Required: id. - **delete_a_to_pdesk_emails_id_by_id** — Delete a TOPdesk email by id. Returns an empty 204 response on success. Required: id. - **list_all_to_pdesk_service_window_lookups** — 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_to_pdesk_service_window_lookup_by_id** — 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_to_pdesk_searches** — 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_to_pdesk_versions** — Get the TOPdesk API version. Returns: version. - **list_all_to_pdesk_product_versions** — Get the current TOPdesk product version. Returns: major, minor, patch. - **list_all_to_pdesk_categories** — 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_to_pdesk_requester_categories** — 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_to_pdesk_avatars_operator_by_id** — 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). - **to_pdesk_avatars_operators_get_requester** — 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_to_pdesk_avatars_person_by_id** — Get a TOPdesk person's avatar image by id. Returns the avatar object including its mimeType. Required: id. - **list_all_to_pdesk_branches** — 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_to_pdesk_branch** — 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_to_pdesk_branch_by_id** — 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_to_pdesk_branch_by_id** — 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… - **to_pdesk_branches_partial_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… - **to_pdesk_branches_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. - **to_pdesk_branches_archive_patch** — 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. - **to_pdesk_branches_list_attachments** — List attachments for a specific TOPdesk branch identified by its branch id. Returns: id, name, type. Required: branche_id. - **to_pdesk_branches_upload_attachment** — Upload a file attachment to a TOPdesk branch by branch id. Returns: id, name, type. Required: branche_id, file. - **to_pdesk_branches_delete_attachment** — Delete an attachment from a TOPdesk branch identified by branche_id. Returns an empty 204 response on success. Required: branche_id, attachment_id. - **to_pdesk_branches_download_attachment** — 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_to_pdesk_branches_building_levels** — List building level values configured in TOPdesk. Returns: id, name. - **list_all_to_pdesk_branches_designations** — List branch designation values in TOPdesk. Returns an array of searchlist entries, each containing id and name. No required parameters. - **list_all_to_pdesk_branches_energy_performances** — List all energy performance values available for branches in TOPdesk. Returns: id, name. - **list_all_to_pdesk_branches_environmental_impacts** — List environmental impact values available for branches in TOPdesk. Returns: id, name. - **list_all_to_pdesk_branches_listed_buildings** — List listed building values available for branches in TOPdesk. Returns: id, name. - **list_all_to_pdesk_branches_lookups** — 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_to_pdesk_branches_lookup_by_id** — Get a single TOPdesk branch lookup entry (a lightweight id and name pair) by id. Returns: id, name. Required: id. - **list_all_to_pdesk_budgetholders** — 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_to_pdesk_budgetholder** — Create a new budget holder in TOPdesk. Returns the created budget holder including id, name, and externalLink. Required: name. - **update_a_to_pdesk_budgetholder_by_id** — Update the name of a TOPdesk budget holder by id. Returns the updated budget holder including id, name, and externalLink. Required: id. - **delete_a_to_pdesk_budgetholder_by_id** — Delete a TOPdesk budget holder by id. Returns an empty 204 response on success. Required: id. - **to_pdesk_budgetholders_archive** — Archive a TOPdesk budget holder by id. Returns the archived budget holder including id, name, and externalLink. Required: budgetholder_id. - **list_all_to_pdesk_countries** — List all countries stored in TOPdesk. Returns: id, name for each country entry. - **list_all_to_pdesk_departments** — 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_to_pdesk_department** — Create a department in TOPdesk. Returns: id. Required: name. The name must be unique and not exceed the maximum length. - **update_a_to_pdesk_department_by_id** — Update the name of a department in TOPdesk by id. Returns: id, name, external_link. Required: id, name. - **delete_a_to_pdesk_department_by_id** — 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. - **to_pdesk_departments_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_to_pdesk_languages** — List languages configured in TOPdesk. Returns: id, name. - **list_all_to_pdesk_locations** — 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_to_pdesk_location** — 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_to_pdesk_location_by_id** — 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_to_pdesk_location_by_id** — Update a TOPdesk location by id with full field replacement. Returns the updated location including id, name, roomNumber, branch, and roomSetup. Required: id. - **to_pdesk_locations_partial_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. - **to_pdesk_locations_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. - **to_pdesk_locations_archive_patch** — 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_to_pdesk_locations_building_zones** — List building zones in TOPdesk. Returns: id, name. - **list_all_to_pdesk_locations_ceiling_coverings** — 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_to_pdesk_locations_floor_coverings** — List floor covering values configured in TOPdesk supporting files. Returns: id, name, archived. Operator access only; Category/Branch/Operator filters apply. - **list_all_to_pdesk_locations_functional_uses** — List functional uses for locations in TOPdesk. Returns an array of searchlist entries including id, name, archived, and order. - **list_all_to_pdesk_locations_glass_materials** — List glass materials in TOPdesk. Returns an array of glass material searchlist values, each with id and name. - **list_all_to_pdesk_locations_lookups** — 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_to_pdesk_locations_lookup_by_id** — Get a single TOPdesk location lookup entry by id. Returns: id, name. Required: id. - **list_all_to_pdesk_locations_statuses** — 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_to_pdesk_locations_types** — List all location types configured in TOPdesk. Returns: id, name. Category/Branch/Operator filters apply for operators. - **list_all_to_pdesk_locations_wall_coverings** — List wall coverings in TOPdesk. Returns each wall covering entry with its id and name. - **list_all_to_pdesk_operatorgroups** — List TOPdesk operator groups with optional FIQL filtering and field selection. Returns: id, name. Max 100 per page. - **create_a_to_pdesk_operatorgroup** — 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). - **to_pdesk_operatorgroups_list_by_operator** — 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. - **to_pdesk_operatorgroups_create_by_operator** — Link operator groups to a TOPdesk operator by providing their UUIDs. Returns an empty 204 response on success. Required: operator_id. - **to_pdesk_operatorgroups_delete_by_operator** — Unlink operator groups from a TOPdesk operator by providing their UUIDs. Returns an empty 204 response on success. Required: operator_id. - **get_single_to_pdesk_operatorgroup_by_id** — 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_to_pdesk_operatorgroup_by_id** — 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. - **to_pdesk_operatorgroups_partial_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. - **to_pdesk_operatorgroups_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. - **to_pdesk_operatorgroups_archive_patch** — 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_to_pdesk_operatorgroups_lookups** — 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_to_pdesk_operatorgroups_lookup_by_id** — Get a single TOPdesk operator group id and name pair by id. Returns: id, name. Required: id. - **list_all_to_pdesk_operators** — 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. - **to_pdesk_operators_list_by_operatorgroup** — List operators belonging to a specific TOPdesk operator group. Returns: id, name. Required: operatorgroup_id. - **create_a_to_pdesk_operator** — 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. - **to_pdesk_operators_get_current** — 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. - **to_pdesk_operators_get_current_id** — Get the id of the currently logged-in operator in TOPdesk. Returns: id. No parameters required. - **get_single_to_pdesk_operator_by_id** — Get a single TOPdesk operator by id. Returns the operator object including id, surName, branch, loginName, and archived. Required: id. - **update_a_to_pdesk_operator_by_id** — 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. - **to_pdesk_operators_partial_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. - **to_pdesk_operators_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). - **to_pdesk_operators_archive_patch** — 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_to_pdesk_operators_lookups** — 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_to_pdesk_operators_lookup_by_id** — Get a single TOPdesk operator's id and name pair by id. Returns: id, name. Required: id. - **list_all_to_pdesk_operators_settings** — 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_to_pdesk_filters_branches** — List all branch filters available in TOPdesk. Returns: id, name. - **to_pdesk_filters_branches_list_by_operator** — List branch filters linked to a specific TOPdesk operator. Returns: id, name. Required: operator_id. - **create_a_to_pdesk_filters_branch** — 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. - **to_pdesk_filters_branches_bulk_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_to_pdesk_filters_categories** — List all category filters available in TOPdesk. Returns: id. - **to_pdesk_filters_categories_list_by_operator** — List the category filters linked to a specific TOPdesk operator. Returns: id. Required: operator_id. - **create_a_to_pdesk_filters_category** — 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. - **to_pdesk_filters_categories_bulk_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_to_pdesk_filters_operators** — List all operator filters available in TOPdesk. Returns an array of filter objects, each with id and name. - **to_pdesk_filters_operators_list_by_operator** — 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_to_pdesk_filters_operator** — 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. - **to_pdesk_filters_operators_bulk_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_to_pdesk_permissiongroups** — List permission groups in TOPdesk. Returns an array of permission group entries including id and name. - **to_pdesk_permissiongroups_list_by_operator** — List the permission groups linked to a specific TOPdesk operator. Returns: id, name. Required: operator_id. - **to_pdesk_permissiongroups_create_by_operator** — 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. - **to_pdesk_permissiongroups_delete_by_operator** — 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_to_pdesk_people** — 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_to_pdesk_person** — 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. - **to_pdesk_people_get_current** — 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_to_pdesk_person_by_id** — 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. - **to_pdesk_people_partial_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. - **to_pdesk_people_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. - **to_pdesk_people_archive_patch** — 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_to_pdesk_persons_counts** — Get the total number of persons in TOPdesk, optionally filtered by a FIQL search expression. Returns: count. - **to_pdesk_persons_counts_list_requester** — 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_to_pdesk_person_persongroups** — List person groups that a TOPdesk person is a member of. Returns: id, name, archived. Required: person_id. - **list_all_to_pdesk_avatars** — Get a person's avatar in TOPdesk by person id. Returns: image, mimeType. Required: id. - **list_all_to_pdesk_person_contracts** — 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. - **to_pdesk_person_contracts_bulk_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_to_pdesk_person_private_details** — 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. - **to_pdesk_person_private_details_bulk_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_to_pdesk_persons_lookups** — 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_to_pdesk_persons_lookup_by_id** — Get a single TOPdesk person lookup entry by id, returning a lightweight id and name pair. Returns: id, name. Required: id. - **list_all_to_pdesk_person_extra_field_a_entries** — 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_to_pdesk_person_extra_field_a_entry** — 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_to_pdesk_person_extra_field_b_entries** — List non-archived person extra field B entries in TOPdesk. Returns each entry's id, name, and externalLink. - **create_a_to_pdesk_person_extra_field_b_entry** — Create a person extra field B entry in TOPdesk. Returns the created entry including its id, name, and externalLink. Required: name. - **list_all_to_pdesk_persongroups** — 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_to_pdesk_persongroup** — Create a new TOPdesk person group. Returns the created person group including id, name, archived, and branch. Required: name. - **get_single_to_pdesk_persongroup_by_id** — Get a single TOPdesk person group by id. Returns: id, name. Required: id. - **to_pdesk_persongroups_partial_update** — Update a TOPdesk person group by id. Returns the updated person group including id, name, archived, and branch. Required: id. - **to_pdesk_persongroups_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. - **to_pdesk_persongroups_unarchive** — 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_to_pdesk_persongroup_people** — 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_to_pdesk_persongroups_lookups** — 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_to_pdesk_persongroups_lookup_by_id** — Get a single TOPdesk person group id and name pair by id. Returns: id, name. Required: id. - **create_a_to_pdesk_picture** — Upload an image to TOPdesk. Returns the UUID id of the uploaded picture. Required: file. - **get_single_to_pdesk_picture_by_id** — Get a picture from TOPdesk by id, returned as a binary bytestream. The size parameter selects full or thumbnail. Required: id. - **list_all_to_pdesk_supplier_contacts** — 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_to_pdesk_supplier_contact_by_id** — Get a single TOPdesk supplier contact by id. Returns: id. Required: id. - **list_all_to_pdesk_suppliers** — 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_to_pdesk_supplier_by_id** — 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_to_pdesk_suppliers_lookups** — 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_to_pdesk_suppliers_lookup_by_id** — 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_to_pdesk_requester_branches** — 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_to_pdesk_requester_locations** — 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_to_pdesk_requester_people** — 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_to_pdesk_requester_person_by_id** — 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. - **to_pdesk_free_field_searchlists_list_incidents** — List optional drop-down values for a free-field searchlist on incidents in TOPdesk. Returns: id, name. Required: tab, searchlist. - **to_pdesk_free_field_searchlists_list_branches** — 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. - **to_pdesk_free_field_searchlists_list_locations** — 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). - **to_pdesk_free_field_searchlists_list_operators** — 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). - **to_pdesk_free_field_searchlists_create_operators** — 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. - **to_pdesk_free_field_searchlists_list_persons** — 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). - **to_pdesk_free_field_searchlists_create_persons** — 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_to_pdesk_assets** — 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_to_pdesk_asset** — Create a new TOPdesk asset. Returns: id. Required: type_id plus all mandatory template-specific fields. - **get_single_to_pdesk_asset_by_id** — Get a single TOPdesk asset by id. Returns: id, name. Required: id. - **update_a_to_pdesk_asset_by_id** — Update an existing TOPdesk asset by id with modified field values. Returns: id, name. Required: id. - **to_pdesk_assets_archive** — Archive a TOPdesk asset by providing a reason for archiving. Returns: id, name. Required: asset_id, reasonId. - **to_pdesk_assets_get_grid_field_values** — 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_to_pdesk_assets_template_id_by_id** — 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_to_pdesk_assets_template_id** — 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_to_pdesk_assets_template_id_by_id** — 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. - **to_pdesk_assets_template_ids_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_to_pdesk_asset_assignments** — 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_to_pdesk_asset_assignment_by_id** — 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. - **to_pdesk_asset_assignments_bulk_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_to_pdesk_asset_actions** — 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_to_pdesk_asset_copy** — 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_to_pdesk_asset_unarchive** — 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_to_pdesk_history_current_items** — List current external links to a TOPdesk asset as history items. Returns: id, type, next. Required: asset_id. - **list_all_to_pdesk_history_past_items** — 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_to_pdesk_assets_blanks** — 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_to_pdesk_assets_delete_by_id** — 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_to_pdesk_assets_filter_by_id** — 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_to_pdesk_assets_grid_field_assets** — 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_to_pdesk_assets_grid_field_asset_by_id** — 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_to_pdesk_assets_delete_grid_field_asset_by_id** — Delete a row from a grid widget on a TOPdesk host asset and update the host asset. Returns: id. Required: assetId, hostAssetId. - **create_a_to_pdesk_assets_unlink** — 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_to_pdesk_assets_linked_knowledge_item** — 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_to_pdesk_assets_linked_service** — 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_to_pdesk_assets_linked_task** — 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. - **to_pdesk_assets_assignments_bulk_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_to_pdesk_asset_links** — 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_to_pdesk_asset_link** — 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_to_pdesk_asset_link_by_id** — Remove a link between two TOPdesk assets by relation id. Returns: id, name, type. Required: id. - **list_all_to_pdesk_asset_links_possible_relations** — 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_to_pdesk_asset_statuses** — 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_to_pdesk_capabilities** — List all link types (capabilities) in TOPdesk Asset Management. Returns: id, name, archived. - **create_a_to_pdesk_capability** — 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. - **to_pdesk_capabilities_get_by_id** — Get a specific TOPdesk capability (link type) by its id. Returns: id, name, usage. Required: capability_id. - **update_a_to_pdesk_capability_by_id** — 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_to_pdesk_capability_by_id** — 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. - **to_pdesk_capabilities_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_to_pdesk_capabilitie_unarchive** — 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_to_pdesk_card_types** — 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_to_pdesk_dropdown_by_id** — 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. - **to_pdesk_dropdowns_get_query** — 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_to_pdesk_fields** — 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_to_pdesk_field_by_id** — Get a single TOPdesk asset management field definition by id. Returns: id, name. Required: id. - **delete_a_to_pdesk_field_by_id** — 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_to_pdesk_import_assets** — 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_to_pdesk_stock_quantities** — 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_to_pdesk_stock_quantity** — Link a bulk item to a stock in TOPdesk with a specified initial quantity. Returns: id. Required: stockId, bulkItemId, quantity. - **update_a_to_pdesk_stock_quantity_by_id** — 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_to_pdesk_stock_quantity_by_id** — 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_to_pdesk_stock_totals** — 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_to_pdesk_templates** — 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_to_pdesk_uploads** — List uploaded file blobs attached to a TOPdesk asset. Returns: id. Required: assetId. - **create_a_to_pdesk_upload** — Upload one or more file blobs to a TOPdesk asset using multipart form data. Returns: id. Required: assetId, file. - **delete_a_to_pdesk_upload_by_id** — Delete an uploaded file blob from TOPdesk by id. Returns an empty 204 response on success. Required: id. - **to_pdesk_import_links_children_bulk_update** — 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_to_pdesk_import_links_incoming_by_id** — 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_to_pdesk_import_links_outgoing_by_id** — 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. - **to_pdesk_import_links_parents_bulk_update** — 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. - **to_pdesk_assignment_branches_bulk_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. - **to_pdesk_assignment_locations_bulk_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. - **to_pdesk_assignment_person_groups_bulk_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. - **to_pdesk_assignment_people_bulk_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_to_pdesk_services** — 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_to_pdesk_service** — Create a non-reservable TOPdesk service with the provided name. Returns the created service including its id and name. Required: name. - **get_single_to_pdesk_service_by_id** — Get a single TOPdesk service by its id. Returns the service details including id and name. Required: id. - **list_all_to_pdesk_service_linked_assets** — List TOPdesk assets linked to a service. Returns: id, assetId, name. Required: service_id. - **create_a_to_pdesk_service_linked_asset** — 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_to_pdesk_service_linked_asset_by_id** — 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_to_pdesk_service_linked_asset_by_id** — 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_to_pdesk_operational_activities** — 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_to_pdesk_operational_activity** — 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_to_pdesk_operational_activity_by_id** — Get a single TOPdesk operational activity by id or number. Returns: id, type, schema. Required: identifier. - **update_a_to_pdesk_operational_activity_by_id** — 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. - **to_pdesk_operational_activities_list_attachments** — List attachments for a TOPdesk operational activity, sorted by entry date descending. Returns: id, name, type. Inline images are not returned. Required: identifier. - **to_pdesk_operational_activities_bulk_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_to_pdesk_operational_activities_settings** — 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_to_pdesk_linked_objects** — 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_to_pdesk_linked_asset** — 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_to_pdesk_linked_locations** — 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_to_pdesk_linked_location** — 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_to_pdesk_linked_branches** — 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_to_pdesk_linked_branch** — 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_to_pdesk_time_registrations** — List time registrations for a TOPdesk operational activity, sorted by entry date descending and creation date ascending. Returns: id. Required: identifier. - **create_a_to_pdesk_time_registration** — 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_to_pdesk_attachments_upload** — 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_to_pdesk_operational_activity_emails** — 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_to_pdesk_operational_activity_email_by_id** — 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_to_pdesk_operational_activities_statuses** — List non-archived operational activity statuses in TOPdesk. Returns: id, name. Only non-archived statuses are returned. - **list_all_to_pdesk_operational_activities_reasons_for_skippings** — List non-archived reasons for skipping for operational activities in TOPdesk. Returns: id, name. Only non-archived entries are returned. - **list_all_to_pdesk_operational_activities_reasons_for_anomalies** — List non-archived reasons for anomaly for operational activities in TOPdesk. Returns: id, name. - **list_all_to_pdesk_operational_activities_types** — List operational activity types in TOPdesk, optionally filtered by a FIQL search expression. Returns: id, name. - **list_all_to_pdesk_operational_series** — Get a single TOPdesk operational series by identifier. Returns the series object including id, briefDescription, and number. Required: identifier. - **list_all_to_pdesk_operational_activities_schemas** — 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_to_pdesk_operational_activities_groupings** — List groupings for operational activities in TOPdesk. Returns: id, name. Supports FIQL filtering, field selection, and sorting. Default sort is name ascending. - **delete_a_to_pdesk_operational_activity_attachment_by_id** — Delete a file attachment from an operational activity in TOPdesk. Returns an empty 204 response on success. Required: identifier, id. - **to_pdesk_operational_activity_attachments_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_to_pdesk_reservations** — List TOPdesk reservations. Returns each reservation with id, number, requester, operator, operatorGroup, processingStatus, recurrencySeriesId, modificationDate, and briefDescription. - **create_a_to_pdesk_reservation** — 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_to_pdesk_reservation_by_id** — Get a single TOPdesk reservation by identifier (id or reservation number). Returns: id, number, requester, operator, operatorGroup, processingStatus, recurrencySeriesId, modificationDate, briefDescription. Required: identifier. - **to_pdesk_reservations_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. - **to_pdesk_reservations_cancel** — Cancel a TOPdesk reservation by identifier. Returns the updated reservation including id, number, operator, operatorGroup, and processingStatus. Required: identifier. - **to_pdesk_reservations_reject** — Reject a TOPdesk reservation by identifier. Returns the updated reservation including id, number, operator, operatorGroup, and processingStatus. Required: identifier. - **to_pdesk_reservations_reschedule** — Reschedule a TOPdesk reservation by identifier. Returns the updated reservation including id, number, operator, operatorGroup, and processingStatus. Required: identifier. - **to_pdesk_reservations_list_attachments** — List attachments for a TOPdesk reservation by identifier. Returns each attachment with id, name, and type. Required: identifier. - **to_pdesk_reservations_upload_attachment** — Upload a file attachment to a TOPdesk reservation by identifier. Returns the created attachment object including its id, name, and type. Required: identifier, file. - **to_pdesk_reservations_bulk_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_to_pdesk_reservations_numbers** — Get a TOPdesk reservation by its reservation number. Deprecated; use /reservations/{identifier} instead, which also accepts the number. Returns: id. Required: number. - **to_pdesk_reservations_numbers_bulk_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_to_pdesk_requester_reservation** — 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_to_pdesk_make_recurrent_date** — 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_to_pdesk_occurrences_date** — 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. - **to_pdesk_occurrences_dates_bulk_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_to_pdesk_participants_add** — 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_to_pdesk_participants_remove** — 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_to_pdesk_reserved_facilities_add** — 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_to_pdesk_reserved_facilities_move** — 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_to_pdesk_reserved_facilities_remove** — 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_to_pdesk_reservation_reserved_service** — 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_to_pdesk_reservations_optional_searchlists** — List optional searchlist entries for a given tab and searchlist number in TOPdesk reservations management. Returns: id, name. Required: tab, searchlist. - **create_a_to_pdesk_reservations_optional_searchlist** — Create a new optional searchlist entry for TOPdesk reservations management. Returns the created entry including id and name. Required: tab, searchlist, name. - **to_pdesk_reservations_optional_searchlists_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. - **to_pdesk_reservations_optional_searchlists_bulk_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_to_pdesk_reservation_cancellation_reasons** — 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_to_pdesk_reservation_cancellation_reason** — Create a new TOPdesk reservation cancellation reason for planned reservations. Returns: id, name, archived. Required: name. - **to_pdesk_reservation_cancellation_reasons_archive** — Archive a TOPdesk reservation cancellation reason for planned reservations. Returns: id, name, archived. Required: identifier. - **to_pdesk_reservation_cancellation_reasons_unarchive** — Unarchive a TOPdesk reservation cancellation reason for planned reservations. Returns: id, name, archived. Required: identifier. - **to_pdesk_reservation_cancellation_reasons_bulk_update** — Update the name of a TOPdesk reservation cancellation reason for planned reservations. Returns: id, name, archived. Required: identifier, name. - **list_all_to_pdesk_reservation_processing_status** — 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_to_pdesk_reservation_processing_status** — 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. - **to_pdesk_reservation_processing_status_archive** — Archive a reservation processing status in TOPdesk. Returns the archived searchlist entry including its id, name, and archived status. Required: identifier. - **to_pdesk_reservation_processing_status_unarchive** — Unarchive a reservation processing status in TOPdesk. Returns the unarchived searchlist entry including its id, name, and archived status. Required: identifier. - **to_pdesk_reservation_processing_status_bulk_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_to_pdesk_reservation_rejection_reasons** — 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_to_pdesk_reservation_rejection_reason** — Create a rejection reason for reservation requests in TOPdesk. Returns the created searchlist entry with its id and name. Required: name. - **to_pdesk_reservation_rejection_reasons_archive** — Archive a TOPdesk reservation rejection reason by its identifier or name. Returns the updated searchlist entry including its id and name. Required: identifier. - **to_pdesk_reservation_rejection_reasons_unarchive** — 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. - **to_pdesk_reservation_rejection_reasons_bulk_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_to_pdesk_service_types** — 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_to_pdesk_service_type** — Create a service type in TOPdesk. Returns the created service type with id, name, and archived. Required: name. - **to_pdesk_service_types_archive** — Archive a service type in TOPdesk by its identifier or name. Returns the archived service type with id and name. Required: identifier. - **to_pdesk_service_types_unarchive** — Unarchive a service type in TOPdesk by its identifier or name. Returns the unarchived service type with id, name, and archived. Required: identifier. - **to_pdesk_service_types_bulk_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_to_pdesk_visitors** — 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_to_pdesk_visitor** — 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_to_pdesk_visitor_by_id** — Get a single TOPdesk visitor by identifier. Returns: id, archived, visitor, visit, host. The visit section includes arrivalStatus. Required: identifier. - **to_pdesk_visitors_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. - **to_pdesk_visitors_list_attachments** — List file attachments for a TOPdesk visitor by identifier. Returns: id, name, type, description, entryDate, mimeType. Required: identifier. - **to_pdesk_visitors_upload_attachment** — Upload a file attachment to a TOPdesk visitor. Returns the created attachment including id, name, type, description, entryDate, and mimeType. Required: identifier, file. - **to_pdesk_visitors_bulk_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_to_pdesk_visitor_attachment_by_id** — 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. - **to_pdesk_visitor_attachments_delete_requester** — 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_to_pdesk_visitor_unarchive** — Unarchive a TOPdesk visitor by its id or number. Returns an empty 204 response on success. Required: identifier. - **list_all_to_pdesk_requester_visitors** — 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_to_pdesk_requester_visitor_by_id** — Get a single visitor in TOPdesk by identifier via the requester (SSP) endpoint. Returns: identifier, archived, visitor, visit, host. Required: identifier. - **to_pdesk_requester_visitors_list_attachments** — List attachments for a TOPdesk visitor by identifier. Returns each attachment's id, name, and type. Required: identifier. - **to_pdesk_requester_visitors_upload_attachment** — 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. - **to_pdesk_requester_visitors_bulk_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_to_pdesk_badges** — List TOPdesk badges, optionally filtering by archived status. Returns: id, name. - **create_a_to_pdesk_badge** — Create a new TOPdesk badge. Returns: id, name. Required: name. - **to_pdesk_badges_archive** — Archive a TOPdesk badge by id or name. Returns an empty 204 response on success. Required: identifier. - **to_pdesk_badges_bulk_update** — Update a TOPdesk badge by id or name. Returns an empty 204 response on success. Required: identifier. - **create_a_to_pdesk_badge_unarchive** — Unarchive a TOPdesk badge by its id or name. Returns an empty 204 response on success. Required: identifier. - **list_all_to_pdesk_car_parks** — List car parks available in TOPdesk's Visitor Registration module. Returns: id, number, request, action, briefDescription, changeType, caller, operator, operatorGroup, requester, template. - **create_a_to_pdesk_car_park** — 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. - **to_pdesk_car_parks_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. - **to_pdesk_car_parks_unarchive** — Unarchive a car park in TOPdesk by its identifier. Returns the unarchived car park object including its id. Required: identifier. - **to_pdesk_car_parks_bulk_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_to_pdesk_identification_types** — List identification types in TOPdesk for visitor registration. Returns: id, name, archived. - **create_a_to_pdesk_identification_type** — Create a new identification type in TOPdesk for visitor registration. Returns: id, name, archived. Required: name. - **to_pdesk_identification_types_archive** — Archive an identification type in TOPdesk, marking it as no longer active. Returns: id, name, archived. Required: identifier. - **to_pdesk_identification_types_unarchive** — Unarchive an identification type in TOPdesk, making it active again. Returns: id, name, archived. Required: identifier. - **to_pdesk_identification_types_bulk_update** — Update an existing identification type in TOPdesk. Returns: id, name, archived. Required: identifier. - **list_all_to_pdesk_visitor_optional_searchlists** — 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_to_pdesk_visitor_optional_searchlist** — Create a new TOPdesk visitor optional searchlist (drop-down) entry. Returns: id, name, external_link. Required: tab, searchlist, name. - **to_pdesk_visitor_optional_searchlists_archive** — Archive a TOPdesk visitor optional searchlist (drop-down) entry by identifier. Returns: id, name, external_link. Required: tab, searchlist, identifier. - **to_pdesk_visitor_optional_searchlists_unarchive** — Unarchive a TOPdesk visitor optional searchlist (drop-down) entry by identifier. Returns: id, name, external_link. Required: tab, searchlist, identifier. - **to_pdesk_visitor_optional_searchlists_bulk_update** — Update a TOPdesk visitor optional searchlist (drop-down) entry by identifier. Returns: id, name, external_link. Required: tab, searchlist, identifier. - **list_all_to_pdesk_facility_occupancies** — 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_to_pdesk_overview_reservations** — List overview reservations in TOPdesk. Returns: id, operator, operatorGroup, processingStatus. - **get_single_to_pdesk_overview_reservation_by_id** — Get a single overview reservation in TOPdesk by id. Returns: id, operator, operatorGroup, processingStatus. Required: id. - **list_all_to_pdesk_overview_reservations_numbers** — Retrieve a reservation overview from TOPdesk by its reservation number. Returns reservation overview details. Required: number. - **list_all_to_pdesk_reservable_assets** — 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. - **to_pdesk_reservable_intervals_list_by_asset** — List reservable intervals for a specific reservable asset in TOPdesk. Returns the time intervals during which the asset is available for reservation. Required: identifier. - **to_pdesk_reservable_intervals_list_by_location** — 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_to_pdesk_reservable_locations** — 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_to_pdesk_reservable_location_by_id** — Get a single reservable location in TOPdesk by id. Returns: id. Required: id. - **list_all_to_pdesk_reservable_services** — List reservable services available in TOPdesk's Reservations Management API. Returns: id, name. - **get_single_to_pdesk_reservable_service_by_id** — Get a specific reservable service by id in TOPdesk. Returns: id, name. Required: id. - **list_all_to_pdesk_currencies** — Get the TOPdesk currency settings. Returns the currency configuration object with currency details used across TOPdesk modules. - **list_all_to_pdesk_optionalfield_fields** — 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_to_pdesk_tasknotifications_custom** — 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_to_pdesk_public** — 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. ## How it works 1. **Link your customer's TOPdesk account.** Use Truto's frontend SDK; we handle every OAuth and API key flow so you don't need to create the OAuth app. 2. **Authentication is automatic.** Truto refreshes tokens, stores credentials securely, and injects them into every API request. 3. **Call Truto's API to reach TOPdesk.** The Proxy API is a 1-to-1 mapping of the TOPdesk API. 4. **Get a unified response format.** Every response uses a single shape, with cursor-based pagination and data in the `result` field. ## Use cases - **Embed ITSM ticketing for European mid-market customers** — TOPdesk has deep penetration in European mid-market and enterprise accounts, particularly in higher education, healthcare, and public sector. Offering a native TOPdesk integration removes a major procurement blocker for SaaS vendors expanding into these segments. - **Automate employee lifecycle workflows** — HRIS, IAM, and onboarding platforms can push new hire, role change, and offboarding events directly into TOPdesk to trigger Change templates that fan out tasks to IT, HR, and Facilities teams — eliminating manual ticket creation for every joiner and leaver. - **Sync assets and device context into the service desk** — MDM, ITAM, and endpoint management SaaS can keep TOPdesk's asset registry in lockstep with real-world device state, so service agents see accurate hardware, ownership, and status data when handling incidents. - **Auto-create incidents from monitoring and security alerts** — Observability, SIEM, and threat detection platforms can convert alerts into prioritized TOPdesk incidents with enriched context (affected asset, user, severity), giving IT ops a single pane of glass for triage. - **Power AI assistants with Knowledge Base grounding** — Conversational AI and virtual agent products can retrieve TOPdesk Knowledge Base articles to answer employee questions inside Slack or Teams, and log a ticket on the requester's behalf when human help is needed. ## What you can build - **Two-way incident sync** — Create, update, and read TOPdesk incidents from your product, keeping status, assignee, and comments in sync with your own workflow. - **Requester (Person) lookup and provisioning** — Resolve external user identities to TOPdesk Person records — or create new Persons on the fly — so tickets are always logged against the correct requester. - **Asset registry sync with assignment control** — Push device inventory into TOPdesk's Asset Management module and manage user/location assignments to keep hardware records authoritative. - **Change template automation** — Trigger predefined Change templates (like New Hire or Offboarding) from your app to spawn coordinated task lists across IT, HR, and Facilities. - **Knowledge Base retrieval for AI agents** — Query published Knowledge Base articles to ground LLM responses in the customer's own documentation for RAG-based deflection experiences. - **Alert-to-incident pipeline** — Convert monitoring or security events into high-priority TOPdesk incidents with dynamically populated fields, and optionally flag related assets as quarantined. ## FAQs ### How does authentication work with TOPdesk? TOPdesk uses Application Passwords tied to an Operator account for its REST APIs, sent as HTTP Basic Auth. Truto handles credential storage, refresh, and per-tenant configuration so your end users only see a simple connect flow. ### Does TOPdesk have a single unified API? No. TOPdesk exposes separate REST APIs per module — Incident, Change, Asset Management, Knowledge Base, Persons/Operators, and more. Truto abstracts these behind a consistent interface so you don't need to learn each module's quirks. ### Can I work with custom fields on incidents and assets? Yes. TOPdesk instances are heavily customized, especially in the Asset Management module where the schema is customer-defined. Truto surfaces custom fields so you can read and write them without hardcoding per-tenant logic. ### What's the difference between Persons and Operators, and why does it matter? Persons are end-user requesters (typically employees using the Self-Service Portal), while Operators are the agents fulfilling tickets. Most integrations log tickets on behalf of a Person, so you'll need to resolve or create the correct Person record before creating an incident. ### How do I keep TOPdesk data fresh in my product? TOPdesk's webhook coverage varies by module and version, so many integrations rely on scheduled polling for changes. Truto manages polling cadence, pagination, and delta detection so you get near-real-time updates without building the sync layer yourself. ### This integration isn't listed as available yet — what does that mean? TOPdesk is built on request. Once you tell us which modules and operations you need (Incident, Change, Assets, Persons, Knowledge Base, etc.), Truto ships the connector and exposes it through the same API and dashboard you use for every other integration. ## Related reading - [Connect TOPdesk to ChatGPT: Manage Incidents & Assets via MCP](https://truto.one/blog/connect-topdesk-to-chatgpt-manage-incidents-assets-reservations/) — Learn how to connect TOPdesk to ChatGPT using Truto's managed MCP server. Automate IT tickets, provision assets, and manage reservations with AI agents. - [Connect TOPdesk to Claude: Automate Tickets, Assets & Visitor Logs](https://truto.one/blog/connect-topdesk-to-claude-automate-tickets-assets-visitor-logs/) — Learn how to connect TOPdesk to Claude using a managed MCP server. This guide covers the technical reality of the TOPdesk API, tool calling, and workflow automation. - [Connect TOPdesk to AI Agents: Orchestrate Tickets, Assets & Bookings](https://truto.one/blog/connect-topdesk-to-ai-agents-orchestrate-tickets-assets-bookings/) — Learn how to connect TOPdesk to AI agents using Truto's tools endpoint to automate IT tickets, asset orchestration, and facility reservations.