Xalantis

io.github.xalantis-hub由 GitHub 帳號 xalantis-hub 發布v0.3.1更新於 Oct 25, 2026

Tickets, CRM, contracts, projects and the whole Xalantis public API from your AI assistant.

概覽

AI 產生的概覽

本機 MCP 伺服器,讓助理透過 Xalantis 公開 API 讀取並操作工單、CRM、合約、知識庫、帳務和專案等業務資料。

可以做什麼
列出、檢視、建立、更新、刪除、分流、升級、封存和批次更新支援工單,並處理回覆、內部備註、關聯、關注者、工時、標籤、分類、SLA 違約和報表。從服務目錄建立服務請求,並進行核准、拒絕、履行或重新開啟。處理 CRM 客戶、聯絡人和商機管道,知識庫文章與草稿,合約及其簽核與簽署,帳務發票,以及專案和任務留言。透過四個通用工具搜尋、描述並呼叫公開 API 的全部 323 個操作,包括 GET 讀取和需確認的寫入,二進位或 CSV 結果可存到本機檔案。
適用情境
適合需要助理在 Xalantis 工作區內作業的情境:彙整未結工單、草擬回覆、登記工時、查看合約義務或推進專案任務。也適合希望取得廣泛 API 涵蓋範圍、不必為每個端點各自提供工具的情況。
執行需求
透過 npx 在本機執行,需要 Node.js。需要在 XALANTIS_API_KEY 中提供 Xalantis 組織 API 金鑰,可於組織設定的開發人員、API 金鑰處建立。XALANTIS_BASE_URL 為選用,用於指向自架執行個體;需要能連線至 Xalantis API 的網路。專案相關路由需要綁定工作區成員且具備 projects 權限範圍的金鑰。
安裝前請注意
API 金鑰可存取租戶業務資料,應存放在用戶端環境設定中,不要寫進提示詞。許多工具會寫入、傳送、核准、封存或刪除記錄,並要求 confirm=true,只有使用者明確確認後才應設定。下載內容和報表可能含敏感資料,檔案可寫入本機路徑。操作仍受後端權限、方案限制和速率限制約束。

安裝

在 SourceWeft 中

  1. 開啟 儀表板中的 Xalantis,將其新增到工作區。
  2. 為需要使用其工具的對話啟用該服務。

Desktop only,透過 STDIO。 STDIO 服務會啟動本機處理程序,因此需要 SourceWeft 桌面主機。

其他 MCP 客戶端

參照 儲存庫 中的啟動說明。

README

@xalantis/mcp-server

MCP server for Xalantis. It lets MCP-compatible AI clients read and act on Xalantis business data through the public /api/v1 API.

Release 0.3.0 reaches all 323 operations of the public API (contract 2.11.0): dedicated tools for the most frequent tasks, and four generic tools driven by the bundled OpenAPI spec for everything else.

Registries

Listed in the official MCP Registry as io.github.xalantis-hub/xalantis-mcp, and on Glama.

Installation

bash
npm install -g @xalantis/mcp-server

Configuration

Claude Desktop

Add to claude_desktop_config.json:

json
{  "mcpServers": {    "xalantis": {      "command": "npx",      "args": ["-y", "@xalantis/mcp-server"],      "env": {        "XALANTIS_API_KEY": "sk_live_..."      }    }  }}

Claude Code

bash
claude mcp add xalantis -- npx -y @xalantis/mcp-server

Then set XALANTIS_API_KEY in the shell/session that launches the MCP server.

Cursor

Add to .cursor/mcp.json:

json
{  "mcpServers": {    "xalantis": {      "command": "npx",      "args": ["-y", "@xalantis/mcp-server"],      "env": {        "XALANTIS_API_KEY": "sk_live_..."      }    }  }}

Covered domains

Dedicated tools:

  • Support / Service Desk: tickets, replies, attachments, reports, links, watchers, time entries, subtasks, incidents, service requests, SLA, automations, categories, tags, service catalog, agents.
  • CRM: clients, representatives, contacts, deals, pipelines.
  • Knowledge: articles, search, categories, managed article drafts and reviews.
  • Billing: subscription and invoices.
  • Finance: invoices and expenses read-only APIs.
  • Contracts: contracts, comments, negotiations, obligations, approvals, signatures, clauses, requests, PDF designs, assets, assignments.
  • Projects: projects, statuses, tasks (list, read, create, update, transition) and task comments.

Through the generic tools: every other operation of the public API, including the rest of Projects (sprints, milestones, lists, labels, custom fields, documents, time tracking, automations, analytics, exports, imports, client portal), compliance cases, signature envelopes, contract referentials and CRM imports.

Generic API access

Four tools cover any operation of the public API without a dedicated tool:

  1. search_operations: finds operations by keywords (all required, accents ignored; summaries are in French), area and HTTP method. Without arguments, lists the areas.
  2. describe_operation: returns the path, query and header parameters, the body schema and the scopes of one operation.
  3. read_operation: runs a GET operation. Binary or CSV responses can be written to a local file with save_to.
  4. call_operation: runs a POST, PUT, PATCH or DELETE operation. Requires confirm: true; multipart uploads take local paths in files.
json
{  "operation_id": "post_projects_By_projectUuid_tasks_By_taskUuid_time_entries",  "path_params": { "projectUuid": "project-uuid", "taskUuid": "task-uuid" },  "body": { "duration_minutes": 45, "description": "Review" },  "confirm": true}

The spec ships with the package (openapi/xalantis-openapi.json) and is refreshed at each release. Text responses above 200 KB are refused with a hint to paginate or use save_to.

Every write sends an Idempotency-Key, generated for each call unless one is passed in headers: about 80 routes require it, and replaying the same key returns the first response without a second effect.

Project routes require an API key linked to a member of the workspace (keys created from the Developers settings are) and the matching projects:* scopes.

Confirmation model

Tools that mutate data or may expose sensitive data require a confirm: true argument. The AI client should only pass this after the user explicitly confirms the action.

Examples of confirmed actions:

  • creating, updating or deleting records;
  • sending public ticket replies;
  • approving, rejecting, fulfilling or reopening service requests;
  • merging, splitting, archiving or deleting tickets;
  • requesting contract signatures;
  • downloading attachments or reports;
  • uploading files.

If confirmation is missing, the tool returns an error explaining that confirmation is required.

File transfer tools

Binary endpoints are supported through file-aware tools:

json
{  "ticket_uuid": "ticket-uuid",  "file_path": "/local/path/evidence.pdf",  "confirm": true}

Downloads can either return base64 or write to a local path:

json
{  "ticket_uuid": "ticket-uuid",  "attachment_uuid": "attachment-uuid",  "output_path": "/tmp/evidence.pdf",  "confirm": true}

When output_path is omitted, the tool returns metadata plus base64 content.

Example prompts

Once connected, an MCP-compatible assistant can answer or act on prompts such as:

  • “List open urgent tickets and summarize the oldest ones.”
  • “Find client Acme and show related contacts.”
  • “Search the knowledge base for SLA configuration.”
  • “Create this Knowledge draft and submit it for editorial review after I confirm.”
  • “Update this published Knowledge article; keep the live version unchanged until approval.”
  • “Create a ticket for this incident after I confirm.”
  • “Add an internal note to this ticket.”
  • “Show contract obligations due this month.”
  • “Submit this contract for approval after confirmation.”
  • “Download this ticket report to /tmp/report.xlsx.”
  • “List the overdue tasks of project MXA and move the ones I pick to Done.”
  • “Log 45 minutes on this task and show the sprint burndown.”

Environment variables

VariableRequiredDescription
XALANTIS_API_KEYYesTenant API key used for Xalantis /api/v1 requests.
XALANTIS_BASE_URLNoOrigin or API base of your Xalantis instance, e.g. https://app.example.com. Defaults to https://xalantis.com/api/v1.

Security notes

  • The MCP server does not bypass Xalantis backend permissions, plan gates, tenant scoping or rate limits.
  • Destructive and externally visible actions require confirm: true.
  • File downloads can contain sensitive tenant data; use output_path carefully.
  • API keys should be stored in the MCP client environment configuration, not in prompts.

Development

bash
npm cinpm run lintnpm test            # compiles, then checks every tool against the bundled specnpm run sync-openapi -- path/to/openapi.json

npm test calls every tool with a fake transport and fails if one targets a route the spec does not declare or sends a write without an Idempotency-Key. Run sync-openapi before a release (default source: the sibling xalantis-application/storage/app/openapi.json).

License

MIT

來源:README.md,提交 8e715a8

工具

190

list_tickets

List support tickets with optional filters and pagination.

輸入參數pagesearchstatussort_byper_pageprioritysort_dirrequester_email

get_ticket

Get a single ticket by UUID.

輸入參數uuid必填

create_ticket

Create a new support ticket. The assistant/client should ask for user confirmation before creating user-visible tickets.

輸入參數typechannelconfirmsubject必填prioritydescription必填category_slugrequester_namerequester_email必填

update_ticket

Update an existing ticket. Requires confirmation for status/assignee/priority changes that affect operations.

輸入參數uuid必填due_atstatusconfirmsubjectpriorityassignee_iddescriptioncategory_slug

delete_ticket

Delete a ticket. Destructive: requires explicit confirmation.

輸入參數uuid必填confirm必填

get_ticket_metrics

Get support ticket metrics.

輸入參數tofromgroup_by

list_ticket_activities

List activity history for a ticket.

輸入參數pageper_pageticket_uuid必填

list_ticket_replies

List all replies and notes for a ticket.

輸入參數pageper_pageticket_uuid必填

reply_to_ticket

Add a reply or internal note to a ticket. Public replies should be confirmed by the user first.

輸入參數confirmcontent必填is_internalticket_uuid必填

update_ticket_reply

Update a ticket reply or internal note.

輸入參數confirmcontent必填reply_uuid必填ticket_uuid必填

delete_ticket_reply

Delete a ticket reply. Destructive: requires explicit confirmation.

輸入參數confirm必填reply_uuid必填ticket_uuid必填

list_ticket_time_entries

List time entries for a ticket.

輸入參數pageper_pageticket_uuid必填

create_ticket_time_entry

Create a time entry on a ticket. Requires confirmation.

輸入參數data必填confirm必填ticket_uuid必填

list_ticket_watchers

List watchers for a ticket.

輸入參數pageper_pageticket_uuid必填

toggle_ticket_watcher

Add or remove a ticket watcher. Requires confirmation because it changes notifications.

輸入參數data必填confirm必填ticket_uuid必填

triage_ticket

Run or mark triage for a ticket. Requires confirmation.

輸入參數dataconfirm必填ticket_uuid必填

escalate_ticket

Escalate a ticket. Requires confirmation.

輸入參數dataconfirm必填ticket_uuid必填

deescalate_ticket

De-escalate a ticket. Requires confirmation.

輸入參數dataconfirm必填ticket_uuid必填

list_service_catalog

List service catalog items visible to the API key.

輸入參數pagesearchcategoryper_page

create_service_request_from_catalog

Create a service request from a catalog item. Requires confirmation.

輸入參數data必填confirm必填catalog_item_uuid必填

approve_service_request

Approve a service request. Requires confirmation.

輸入參數dataconfirm必填ticket_uuid必填

reject_service_request

Reject a service request. Requires confirmation.

輸入參數dataconfirm必填ticket_uuid必填

fulfill_service_request

Fulfill a service request. Requires confirmation.

輸入參數dataconfirm必填ticket_uuid必填

reopen_service_request

Reopen a service request. Requires confirmation.

輸入參數dataconfirm必填ticket_uuid必填

list_ticket_categories

List ticket categories.

輸入參數pagesearchper_page

list_ticket_tags

List ticket tags.

輸入參數pagesearchper_page

toggle_ticket_tag

Attach or detach a tag on a ticket. Requires confirmation.

輸入參數dataconfirm必填tag_uuid必填ticket_uuid必填

list_sla_breaches

List SLA breaches.

輸入參數pagestatusper_page

acknowledge_sla_breach

Acknowledge an SLA breach. Requires confirmation.

輸入參數dataconfirm必填breach_uuid必填

bulk_update_tickets

Run a bulk ticket action. Requires confirmation.

輸入參數data必填confirm必填

list_ticket_reports

List generated ticket reports.

輸入參數pageper_page

download_ticket_report

Download a generated ticket report. Returns base64 unless output_path is provided.

輸入參數confirm必填output_pathreport_uuid必填

create_ticket_report

Create a ticket report. Requires confirmation because it may process/export sensitive data.

輸入參數data必填confirm必填

archive_ticket

archiving a ticket. Requires confirmation.

輸入參數dataconfirm必填ticket_uuid必填

unarchive_ticket

unarchiving a ticket. Requires confirmation.

輸入參數dataconfirm必填ticket_uuid必填

restore_independent_ticket

restoring ticket independence. Requires confirmation.

輸入參數dataconfirm必填ticket_uuid必填

duplicate_ticket

duplicating a ticket. Requires confirmation.

輸入參數dataconfirm必填ticket_uuid必填

merge_ticket

merging a ticket. Requires confirmation.

輸入參數dataconfirm必填ticket_uuid必填

split_ticket

splitting a ticket. Requires confirmation.

輸入參數dataconfirm必填ticket_uuid必填

list_ticket_merge_candidates

List merge candidates for a ticket.

輸入參數pageper_pageticket_uuid必填

list_ticket_duplicate_candidates

List duplicate candidates for a ticket.

輸入參數pageper_pageticket_uuid必填

list_ticket_escalation_executions

List escalation executions for a ticket.

輸入參數pageper_pageticket_uuid必填

list_ticket_attachments

List ticket attachments metadata.

輸入參數pageper_pageticket_uuid必填

upload_ticket_attachment

Upload a local file as a ticket attachment. Requires confirmation.

輸入參數dataconfirm必填file_path必填field_nameticket_uuid必填

download_ticket_attachment

Download a ticket attachment. Returns base64 unless output_path is provided.

輸入參數confirm必填output_pathticket_uuid必填attachment_uuid必填

delete_ticket_attachment

Delete a ticket attachment. Destructive: requires confirmation.

輸入參數confirm必填ticket_uuid必填attachment_uuid必填

retry_ticket_reply

Retry a failed ticket reply. Requires confirmation.

輸入參數dataconfirm必填reply_uuid必填ticket_uuid必填

create_ticket_subtask

creating a ticket subtask. Requires confirmation.

輸入參數dataconfirm必填child_uuidticket_uuid必填

toggle_ticket_subtask

toggling a ticket subtask. Requires confirmation.

輸入參數dataconfirm必填child_uuidticket_uuid必填

delete_ticket_subtask

deleting a ticket subtask. Requires confirmation.

輸入參數dataconfirm必填child_uuidticket_uuid必填

update_ticket_time_entry

updating a ticket time entry. Requires confirmation.

輸入參數dataconfirm必填child_uuidticket_uuid必填

delete_ticket_time_entry

deleting a ticket time entry. Requires confirmation.

輸入參數dataconfirm必填child_uuidticket_uuid必填

acknowledge_requester_response

Acknowledge requester response on a ticket. Requires confirmation.

輸入參數dataconfirm必填ticket_uuid必填

list_ticket_incident_updates

List incident updates for a ticket.

輸入參數pageper_pageticket_uuid必填

create_ticket_incident_update

Create an incident update. Requires confirmation.

輸入參數data必填confirm必填ticket_uuid必填

get_ticket_incident_report

Get incident report for a ticket.

輸入參數ticket_uuid必填

get_archived_ticket_incident_report

Get archived incident report for a ticket.

輸入參數ticket_uuid必填

archive_ticket_incident_report

archiving an incident report. Requires confirmation.

輸入參數dataconfirm必填ticket_uuid必填

request_ticket_incident_report_signoff

requesting incident report signoff. Requires confirmation.

輸入參數dataconfirm必填ticket_uuid必填

update_ticket_incident_publication

updating incident publication. Requires confirmation.

輸入參數dataconfirm必填ticket_uuid必填

update_ticket_incident_severity_override

updating incident severity override. Requires confirmation.

輸入參數dataconfirm必填ticket_uuid必填

update_ticket_incident_closure_review

updating incident closure review. Requires confirmation.

輸入參數dataconfirm必填ticket_uuid必填

get_agent_status

Get Service Desk agent status.

輸入參數pageper_page

update_agent_status

Update Service Desk agent status. Requires confirmation.

輸入參數data必填confirm必填

admin_list_service_catalog

List service catalog administration view.

輸入參數pagesearchper_page

get_service_catalog_item

Get a service catalog item by UUID.

輸入參數item_uuid必填

create_service_catalog_item

creating a service catalog item. Requires confirmation.

輸入參數dataconfirm必填item_uuid

update_service_catalog_item

updating a service catalog item. Requires confirmation.

輸入參數dataconfirm必填item_uuid

delete_service_catalog_item

deleting a service catalog item. Requires confirmation.

輸入參數dataconfirm必填item_uuid

duplicate_service_catalog_item

duplicating a service catalog item. Requires confirmation.

輸入參數dataconfirm必填item_uuid

toggle_service_catalog_item

toggling a service catalog item. Requires confirmation.

輸入參數dataconfirm必填item_uuid

list_ticket_reply_templates

List ticket reply template.

輸入參數pagesearchper_page

create_ticket_reply_template

Create a ticket reply template item. Requires confirmation.

輸入參數data必填confirm必填

update_ticket_reply_template

Update a ticket reply template item. Requires confirmation.

輸入參數data必填confirm必填item_uuid必填

delete_ticket_reply_template

Delete a ticket reply template item. Destructive: requires confirmation.

輸入參數confirm必填item_uuid必填

list_ticket_automations

List ticket automation.

輸入參數pagesearchper_page

create_ticket_automation

Create a ticket automation item. Requires confirmation.

輸入參數data必填confirm必填

update_ticket_automation

Update a ticket automation item. Requires confirmation.

輸入參數data必填confirm必填item_uuid必填

delete_ticket_automation

Delete a ticket automation item. Destructive: requires confirmation.

輸入參數confirm必填item_uuid必填

create_ticket_category

Create a ticket category. Requires confirmation.

輸入參數data必填confirm必填

update_ticket_category

Update a ticket category. Requires confirmation.

輸入參數data必填confirm必填item_uuid必填

delete_ticket_category

Delete a ticket category. Destructive: requires confirmation.

輸入參數confirm必填item_uuid必填

create_ticket_tag

Create a ticket tag. Requires confirmation.

輸入參數data必填confirm必填

update_ticket_tag

Update a ticket tag. Requires confirmation.

輸入參數data必填confirm必填item_uuid必填

delete_ticket_tag

Delete a ticket tag. Destructive: requires confirmation.

輸入參數confirm必填item_uuid必填

create_sla_policy

Create a SLA policy. Requires confirmation.

輸入參數data必填confirm必填

update_sla_policy

Update a SLA policy. Requires confirmation.

輸入參數data必填confirm必填item_uuid必填

delete_sla_policy

Delete a SLA policy. Destructive: requires confirmation.

輸入參數confirm必填item_uuid必填

list_sla_policies

List SLA policies.

輸入參數pagesearchper_page

list_escalation_policies

List escalation policies.

輸入參數pagesearchper_page

create_escalation_policy

Create an escalation policy. Requires confirmation.

輸入參數data必填confirm必填

update_escalation_policy

Update an escalation policy. Requires confirmation.

輸入參數data必填confirm必填policy_uuid必填

reorder_ticket_automations

Reorder ticket automations. Requires confirmation.

輸入參數data必填confirm必填

list_ticket_automation_executions

List executions for a ticket automation.

輸入參數pageper_pageautomation_uuid必填

duplicate_ticket_automation

duplicating ticket automation. Requires confirmation.

輸入參數dataconfirm必填automation_uuid必填

toggle_ticket_automation

toggling ticket automation. Requires confirmation.

輸入參數dataconfirm必填automation_uuid必填

list_clients

List client.

輸入參數pagesearchper_page

get_client

Get one client item by UUID.

輸入參數item_uuid必填

create_client

Create a client item. Requires confirmation.

輸入參數data必填confirm必填

update_client

Update a client item. Requires confirmation.

輸入參數data必填confirm必填item_uuid必填

delete_client

Delete a client item. Destructive: requires confirmation.

輸入參數confirm必填item_uuid必填

list_contacts

List contact.

輸入參數pagesearchper_page

get_contact

Get one contact item by UUID.

輸入參數item_uuid必填

create_contact

Create a contact item. Requires confirmation.

輸入參數data必填confirm必填

update_contact

Update a contact item. Requires confirmation.

輸入參數data必填confirm必填item_uuid必填

delete_contact

Delete a contact item. Destructive: requires confirmation.

輸入參數confirm必填item_uuid必填

list_deals

List deal.

輸入參數pagesearchper_page

get_deal

Get one deal item by UUID.

輸入參數item_uuid必填

create_deal

Create a deal item. Requires confirmation.

輸入參數data必填confirm必填

update_deal

Update a deal item. Requires confirmation.

輸入參數data必填confirm必填item_uuid必填

delete_deal

Delete a deal item. Destructive: requires confirmation.

輸入參數confirm必填item_uuid必填

list_client_representatives

List representatives for a client.

輸入參數pageper_pageclient_uuid必填

create_client_representative

Create a representative for a client. Requires confirmation.

輸入參數data必填confirm必填client_uuid必填

list_pipelines

List CRM pipelines.

輸入參數pageper_page

list_knowledge

List knowledge base articles.

輸入參數pagesearchper_page

search_knowledge

Search the knowledge base.

輸入參數qpagesearchper_page

list_knowledge_categories

List knowledge base categories.

輸入參數pageper_page

get_knowledge_article

Get a knowledge article by identifier or slug.

輸入參數identifier必填

get_knowledge_taxonomy

Get UUID-based categories, products and labels accepted by Knowledge article writes.

無需輸入參數。

list_managed_knowledge_articles

List internal Knowledge articles visible to the configured integration actor.

輸入參數pagelocalesearchstatusper_pageproduct_uuidcategory_uuid

get_managed_knowledge_article

Get an internal Knowledge article by UUID.

輸入參數article_uuid必填

create_knowledge_article

Create an internal Knowledge draft. Requires explicit confirmation and a stable idempotency key.

輸入參數data必填confirm必填idempotency_key必填

update_knowledge_article

Update a draft or stage a revision for a published article. Requires explicit confirmation.

輸入參數data必填confirm必填article_uuid必填idempotency_key必填

submit_knowledge_article_for_review

Submit a Knowledge draft or pending revision to editorial review. Requires explicit confirmation.

輸入參數confirm必填article_uuid必填idempotency_key必填

archive_knowledge_article

Archive a Knowledge article while preserving its history. Requires explicit confirmation.

輸入參數confirm必填article_uuid必填idempotency_key必填

delete_knowledge_article

Soft-delete a Knowledge article. Destructive: requires explicit confirmation and the dedicated delete scope.

輸入參數confirm必填article_uuid必填idempotency_key必填

get_billing_subscription

Get the current billing subscription.

無需輸入參數。

list_billing_invoices

List billing invoices.

輸入參數pageper_page

get_billing_invoice

Get a billing invoice by UUID.

輸入參數invoice_uuid必填

list_finance_invoices

List finance invoices.

輸入參數pageper_page

get_finance_invoice

Get a finance invoice by UUID.

輸入參數invoice_uuid必填

list_finance_expenses

List finance expenses.

輸入參數pageper_page

get_finance_expense

Get a finance expense by UUID.

輸入參數expense_uuid必填

list_contracts

List contract.

輸入參數pagesearchper_page

get_contract

Get one contract item by UUID.

輸入參數item_uuid必填

create_contract

Create a contract item. Requires confirmation.

輸入參數data必填confirm必填

update_contract

Update a contract item. Requires confirmation.

輸入參數data必填confirm必填item_uuid必填

delete_contract

Delete a contract item. Destructive: requires confirmation.

輸入參數confirm必填item_uuid必填

list_contract_clauses

List contract clause.

輸入參數pagesearchper_page

get_contract_clause

Get one contract clause item by UUID.

輸入參數item_uuid必填

create_contract_clause

Create a contract clause item. Requires confirmation.

輸入參數data必填confirm必填

update_contract_clause

Update a contract clause item. Requires confirmation.

輸入參數data必填confirm必填item_uuid必填

delete_contract_clause

Delete a contract clause item. Destructive: requires confirmation.

輸入參數confirm必填item_uuid必填

list_contract_pdf_designs

List contract PDF design.

輸入參數pagesearchper_page

get_contract_pdf_design

Get one contract PDF design item by UUID.

輸入參數item_uuid必填

create_contract_pdf_design

Create a contract PDF design item. Requires confirmation.

輸入參數data必填confirm必填

update_contract_pdf_design

Update a contract PDF design item. Requires confirmation.

輸入參數data必填confirm必填item_uuid必填

delete_contract_pdf_design

Delete a contract PDF design item. Destructive: requires confirmation.

輸入參數confirm必填item_uuid必填

list_contract_comments

List comments for a contract.

輸入參數pageper_pagecontract_uuid必填

add_contract_comment

Add a comment to a contract. Requires confirmation.

輸入參數data必填confirm必填contract_uuid必填

update_contract_comment

Update a contract comment. Requires confirmation.

輸入參數data必填confirm必填comment_uuid必填contract_uuid必填

delete_contract_comment

Delete a contract comment. Destructive: requires confirmation.

輸入參數confirm必填comment_uuid必填contract_uuid必填

list_contract_negotiations

List negotiations for a contract.

輸入參數pageper_pagecontract_uuid必填

create_contract_negotiation

Create a contract negotiation entry. Requires confirmation.

輸入參數data必填confirm必填contract_uuid必填

resolve_contract_negotiation

Resolve a contract negotiation. Requires confirmation.

輸入參數dataconfirm必填contract_uuid必填negotiation_uuid必填

list_contract_obligations

List obligations for a contract.

輸入參數pageper_pagecontract_uuid必填

create_contract_obligation

Create a contract obligation. Requires confirmation.

輸入參數data必填confirm必填contract_uuid必填

update_contract_obligation

Update a contract obligation. Requires confirmation.

輸入參數data必填confirm必填contract_uuid必填obligation_uuid必填

fulfill_contract_obligation

Fulfill a contract obligation. Requires confirmation.

輸入參數dataconfirm必填contract_uuid必填obligation_uuid必填

waive_contract_obligation

Waive a contract obligation. Requires confirmation.

輸入參數dataconfirm必填contract_uuid必填obligation_uuid必填

submit_contract_for_approval

Submit a contract for approval. Requires confirmation.

輸入參數dataconfirm必填contract_uuid必填

request_contract_signatures

Request signatures for a contract. Requires confirmation because it may notify signers.

輸入參數dataconfirm必填contract_uuid必填

list_contract_requests

List contract requests.

輸入參數pagesearchper_page

create_contract_request

Create a contract request. Requires confirmation.

輸入參數data必填confirm必填

get_contract_request

Get a contract request by UUID.

輸入參數request_uuid必填

add_contract_pdf_design_asset

adding a contract PDF design asset. Requires confirmation.

輸入參數data必填confirm必填design_uuid必填

add_contract_pdf_design_assignment

adding a contract PDF design assignment. Requires confirmation.

輸入參數data必填confirm必填design_uuid必填

delete_contract_pdf_design_asset

deleting a contract PDF design asset. Destructive: requires confirmation.

輸入參數confirm必填child_uuid必填design_uuid必填

delete_contract_pdf_design_assignment

deleting a contract PDF design assignment. Destructive: requires confirmation.

輸入參數confirm必填child_uuid必填design_uuid必填

list_projects

List the projects visible to the user linked to the API key.

輸入參數searchstatusper_pageinclude_archived

get_project

Get one project by UUID.

輸入參數project_uuid必填

list_project_statuses

List the task statuses of a project, in board order. Use their UUIDs to filter or transition tasks.

輸入參數project_uuid必填

list_project_tasks

Search and paginate the tasks of a project.

輸入參數typelabelssearchsprintstatusepic_idsort_byper_pageassigneesdue_statemilestonepriorities另有 3 個

get_project_task

Get one task with its relations (status, assignees, labels, parent, epic…).

輸入參數task_uuid必填project_uuid必填

create_project_task

Create a task, subtask or epic in a project. Requires confirmation.

輸入參數typetitle必填confirm必填due_datepriorityepic_uuiddescriptionparent_uuidproject_uuid必填task_status_uuid

update_project_task

Update a task and its planning references (sprint, milestone, estimates, custom fields). Use transition_project_task to change only the status. Requires confirmation.

輸入參數typetitleconfirm必填due_datepriorityprogressepic_uuidtask_uuid必填descriptionparent_uuidsprint_uuidproject_uuid必填另有 6 個

transition_project_task

Move a task to another status of the same project. Requires confirmation.

輸入參數confirm必填task_uuid必填status_uuid必填project_uuid必填

list_project_task_comments

List the visible comments of a task.

輸入參數per_pagetask_uuid必填project_uuid必填

add_project_task_comment

Add a comment to a task, attributed to the user linked to the API key. Requires confirmation.

輸入參數confirm必填content必填task_uuid必填project_uuid必填

search_operations

Step 1/3 for any Xalantis API operation without a dedicated tool (projects and tasks, compliance cases, signature envelopes, contract referentials, CRM imports…). Searches the 323 operations of the public API by keywords (all required, accents ignored; summaries are in French, e.g. "tâche commentaire"), area and HTTP method. Without any filter, lists the areas. Next: describe_operation.

輸入參數areaquerymethod

describe_operation

Step 2/3: path, query and header parameters, body schema and required scopes of one operation. Next: read_operation (GET) or call_operation (writes).

輸入參數operation_id必填

read_operation

Step 3/3 for reads: runs a GET operation described by describe_operation. Never modifies data. Binary responses (exports, documents) are written to a local file.

輸入參數querysave_topath_paramsoperation_id必填

call_operation

Step 3/3 for writes: runs a POST, PUT, PATCH or DELETE operation described by describe_operation. Can create, change or delete data within the API key scopes: requires confirm=true after explicit user confirmation. An Idempotency-Key is generated unless one is passed in headers; reuse it only to retry the exact same request.

輸入參數bodyfilesqueryconfirm必填headerssave_topath_paramsoperation_id必填

版本歷史

1
  1. v0.3.1最新Oct 25, 2026

評分

已滿足適用檢查項的 80%

該評分衡量此收錄條目的完整程度,依據註冊中心條目、端點與公開來源計算得出。它不是對伺服器本身的評價,也不表示伺服器安全或目前可用:可連通性是帶日期的檢查結果,評分也不包含安裝量或使用者評價。

  • 近 30 天內可連通25 分
  • 已宣告認證方式10 分

    請在註冊中心條目中宣告憑證請求標頭,或保持端點能夠回應探測,以便判定其認證方式。

  • 已列出工具必需15 分
  • 描述必需15 分
  • 圖示10 分
  • 文件15 分
  • 授權條款10 分

    請在儲存庫或註冊中心條目中宣告授權條款。