Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Quaderno Authentication API
description: The Quaderno API is a REST API for tax compliance, invoicing, and sales tax / VAT automation.
version: '1.0'
contact:
name: Quaderno
url: https://developers.quaderno.io
license:
name: Proprietary
url: https://quaderno.io/terms/
servers:
- url: https://{account}.quadernoapp.com/api
description: Production (account-scoped)
variables:
account:
default: ACCOUNT_NAME
description: Your Quaderno account subdomain.
security:
- basicAuth: []
tags:
- name: Authentication
description: Ping the API and inspect the authenticated account and rate-limit state.
paths:
/ping.json:
get:
operationId: ping
tags:
- Authentication
summary: Ping the API
description: Tests service availability, validates your API key, and returns your remaining request allowance without consuming rate limit.
responses:
'200':
description: The service is available and the token is valid.
content:
application/json:
schema:
type: object
properties:
status:
type: string
'401':
$ref: '#/components/responses/Unauthorized'
/authorization.json:
get:
operationId: getAuthorization
tags:
- Authentication
summary: Get authorization details
description: Returns the identity and account details associated with the authenticated API key, including the account-scoped API URL to use.
responses:
'200':
description: Authorization details for the authenticated key.
content:
application/json:
schema:
type: object
additionalProperties: true
'401':
$ref: '#/components/responses/Unauthorized'
components:
schemas:
Error:
type: object
properties:
error:
type: string
errors:
type: object
additionalProperties: true
responses:
Unauthorized:
description: Missing or invalid API key.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
basicAuth:
type: http
scheme: basic
description: HTTP Basic Authentication. Use your private API key as the username; the password can be any value. API keys are managed in the Quaderno account settings.