Welcome to the API Reference
This section provides everything you need to understand, explore, and use Qonto’s APIs. Whether you’re building a new integration or enhancing an existing one, you’ll find detailed information about each endpoint, request, and response here.
How to Read This Section
The API Reference is organized to help you quickly find what you’re looking for and understand how to use each endpoint:- Endpoint structure: Each endpoint is described with its HTTP method, URL, and a concise summary of its purpose.
- Parameters: You’ll see all required and optional parameters, including where to include them (in the path, query, or body).
- Request examples: Sample requests show you how to format your calls.
- Response details: Example responses and field descriptions help you process the data you receive.
- Authentication: Each endpoint specifies the authentication method you need to use. Most endpoints are available through either an API key or OAuth, while a specific subset is only accessible via OAuth.
- Error handling: Common error responses are included so you can handle issues gracefully.
How to Use the API Reference
-
Start with the overviews:
If you’re new to Qonto’s APIs, begin with the Business API or Onboarding API overview. These pages explain the main use cases and show how the APIs fit into your workflow. -
Read the developer guidelines:
Before you start building, take a look at our Developer Guidelines. You’ll find important information on authentication, error handling, API versioning, and best practices. -
Use the endpoint documentation:
Browse the API Reference to find the resources you need. Each page follows the same structure, making it easy to scan and find the details you’re after. -
Try it out:
Use the provided examples to help you get started with your own calls. Testing with sample data is a great way to confirm your integration is working as expected.Need help accessing your API keys? Check out our guide on how to access your API keys. -
Handle errors appropriately:
Error examples are included to help you build robust error handling into your application.
Good to Know
- All API requests require authentication.
Make sure to keep your credentials secure at all times. - The APIs are versioned.
Always specify the version you want to use to ensure stability. - Follow rate limits.
Respecting rate limits helps keep your integration running smoothly.
Next steps:
- Read the general introduction to get familiar with Qonto’s API approach.
- Explore the Business API or Onboarding API.
- Review our Developer Guidelines for best practices.