Skip to content

Setup

This guide describes how to get access to the xTool API and start making requests.

Prerequisites

  • Access to the xTool web application (URL from your administrator).
  • An organisation in xTool. Documents and API keys belong to an organisation. See Organisation and users.
  • Permissions to create and manage API keys (or an existing key with the right permissions).

Getting an API key

  1. Sign in to the xTool web app.
  2. Select the organisation for which you want to use the API.
  3. Open API (in the organisation menu or sidebar).
  4. Create a new key: specify a name (e.g. "Backend integration"), choose permissions (documents, formats, transactions, organisations, auth me, Peppol lookup, PDF, integrations as needed).
  5. Copy the secret immediately after creation — it is shown only once. Store it securely (e.g. in a secrets manager).

!!! warning "Secret is shown once" If you lose the secret, you will need to create a new key and revoke the old one.

See API keys and permissions and Organisation UI.

Making requests

  • Base URL — use the API base URL of your environment (e.g. https://xtool.invoice-portal.de/api/v2).
  • Authentication — send the API key in the request header:
1
x-api-key: YOUR_API_KEY
  • Content type — for JSON: Content-Type: application/json; for XML: Content-Type: application/xml or application/xml; charset=utf-8.

Example — list documents:

1
2
curl -X GET "https://xtool.invoice-portal.de/api/v2/documents" \
  -H "x-api-key: YOUR_API_KEY"

Full list of endpoints: API reference.