Welcome to Quinyx's API reference. Our APIs are designed to help you integrate seamlessly with the our platform and build reliable and scalable integrations.
We expose Resources through a RESTful API using standard HTTP methods (GET, POST, PUT, PATCH, DELETE) and other web standards.
This section provides a high-level overview of the fundamental concepts you need to know before making your first request.
Our APIs use JSON as the payload data interchange format. Every request and response will use JSON objects as the top-level structure.
When sending data to the API, specify the content type of your request with the Content-Type header:
Content-Type: application/jsonAll date and time values returned by our APIs are rendered in UTC by default.
Date and time fields use standard string formats based on the RFC-3339 internet profile, which is a subset of ISO-8601.
While UTC is the default, some APIs may support returning timestamps in alternative time zones to reduce client-side conversion complexity. When supported, this is controlled using the standard HTTP Prefer header and the Preference-Applied will be available on the response.
For example:
Prefer: timezone=Europe/Stockholm
The Quinyx platform is available in two regions: North America and Europe. Each region has its own base URL, and you should use the one that corresponds to your organization’s environment.
Quinyx provides two environments: Production and Release Candidate (RC).
The Production environment is the live environment where your organization’s real data is stored and processed. Use this environment for all operational workloads.
The RC environment is a customer-facing sandbox environment that allows you to test integrations against real-world data without affecting your live setup.
- It contains your organization’s customer data from Production up until the end of the previous month.
- The data is refreshed on the evening of the 1st of each month, overwriting any changes made in RC.
- RC is ideal for testing upcoming changes, validating integrations, and experimenting with non-production workloads.
| Region | Environment | Base URL |
|---|---|---|
| Europe | Production | https://api.eu.quinyx.com |
| North America | Production | https://api.na.quinyx.com |
| Europe | RC | https://api.rc.eu.quinyx.com |
| North America | RC | https://api.rc.na.quinyx.com |
All communication with our APIs must be made over HTTPS using TLS 1.2 or higher. Connections over plain HTTP or older TLS versions are not supported and will be rejected.
- Understand how to authenticate requests
- Review how to handle errors
- Learn about pagination and rate limits
- Explore our Problem Registry for standard error types.