NOÉ API
Welcome to the official NOÉ API documentation! This REST API lets you integrate and manage festivals and events programmatically.
🚀 Getting started
If you use Insomnia or Postman, here is a file you can import with many request examples: Download the Insomnia file
Base URL
https://api.noe-app.io/
Data format
All requests and responses use JSON format.
🏗️ Architecture
The NOÉ API follows RESTful principles and uses modern standards:
RESTful principles
- GET - Retrieve resources
- POST - Create resources
- PUT - Fully update
- PATCH - Partially update
- DELETE - Delete resources
Standards used
- Authentication: API keys (
X-Api-Key) - Filtering: MongoDB-like queries on listing endpoints
- Request compression: Gzip
👀 What do you want to do next?
📄️ Authentication
The NOÉ API uses authentication based on API keys to secure access to endpoints.
📄️ Filtering
The NOÉ API filtering system allows applying advanced filters on LIST endpoints using a syntax inspired by MongoDB.
📄️ Pagination and Sorting
The LIST endpoints of the NOÉ API support sorting and pagination parameters to efficiently manage large collections of entities.
📄️ Nested fields
Complete guide to manipulating nested fields in the NOÉ API, including custom fields and complex objects.
📄️ Ticketing
Ticketing is probably what you'll want to automate as soon as possible. Here are some ideas:
📄️ Webhooks
NOÉ allows the use of webhooks. Here's how they work!
📄️ SMS Webhook
NOÉ lets you use a webhook to send bulk SMS through your own SMS sending service.