eBrigade API module
Connect eBrigade to your information system
Stop re-entering your staff, schedules and qualifications from one tool to another. The eBrigade API exposes your data through documented inbound and outbound feeds, secured by key: your HR system (HRIS), payroll software or internal portal synchronise automatically, with no custom development on the eBrigade side.
These buttons are about the full eBrigade subscription: this module is included at no extra cost in every plan.
Import/export API keys, REST API v2 and inbound/outbound feeds to connect eBrigade to your information system.
What is the eBrigade API module?
Import/export API keys, REST API v2 and inbound/outbound feeds to connect eBrigade to your information system. It is included at no extra cost in every eBrigade plan.
Why use the API?
Your eBrigade data stays siloed from your other tools: HR system, payroll software, business software or web portal. Every manual Excel export, every re-entry of a staff member or a qualification takes time and eventually creates discrepancies between your databases. Without programmatic access, your IT teams have no reliable way of keeping eBrigade aligned with your reference information system.
What the API changes in eBrigade
The API exposes your staff, your activities and participation, your skills and their expiry dates, your organisations, your registrations, your availability and absences, your time-clock records, your vehicles and your equipment through standardised feeds. Your developers read this data (GET) and push data back from your third-party tools (POST) with a simple key. REST API v2 returns consistent, paginated, self-documented JSON; every call is counted, capped and reported in a usage dashboard, and access can be locked to your own IP addresses only.
What you can do with API
Two separate keys — one for inbound feeds (import), one for outbound feeds (export) — are generated and regenerated in one click from the administration area. Regenerating a compromised key immediately invalidates the old one, without affecting the other feed.
Push your staff, activities/training courses and skills to eBrigade from your HR system or reference directory. The import handles updates as well as creation (create_if_not_exists) and matching by internal ID or external ID (use_external_id), including UUIDs.
Expose read-only your staff, activities and participation over a period, the skills reference list and each person’s expiry dates, your organisations, sign-ups to paid activities, availability, absences and time-clock records, as well as your vehicles and equipment. Ideal for feeding payroll, reporting or a business intelligence dashboard.
Authentication through the Authorization: Bearer header, uniform JSON responses {success, data, meta}, pagination (page, per_page), partial updates of a record with PATCH, CORS headers and explicit HTTP codes. Endpoints, parameters and cURL examples are documented directly in the interface, with no external documentation.
The instance is capped (by default 10,000 requests/day, and 60 requests/minute per key) with X-RateLimit headers and an HTTP 429 response when the limit is exceeded. A dashboard shows the day’s requests, the remaining quota, the last endpoint called and the time of the last call.
Switch on IP address filtering to accept calls only from authorised servers: any request from an IP not on the allowlist is rejected (HTTP 403), even with a valid key.
Step by step
From the administration area, switch on the export API and generate the export key and the import token in one click. You can regenerate them at any time to revoke access.
If needed, switch on restriction to an allowlist of IP addresses, then test your calls with the cURL examples provided in the interface for each endpoint (people, events, skills, sections, registrations).
Your information system queries (GET) or pushes (POST) data through the documented feeds. The usage dashboard shows the day’s requests, the remaining quota and the last call so you can keep an eye on your integrations.
Where this module really pays off
Local authorities & multi-site organisations: keep eBrigade aligned with your HR system or internal portal through standardised feeds, without re-entry.
Fire and rescue services (SDIS) & emergency organisations: automatically export participation, qualifications and attendance over a period to your third-party systems.
Training centres: import your sessions and the skills acquired, and export sign-ups to paid activities (with SIRET, the French company identification number) to your invoicing.
Business services & field maintenance: synchronise staff and activities with your business software through REST API v2.
Software vendors & IT departments: integrate eBrigade into an in-house application thanks to a paginated, self-documented and auditable Bearer API.
Frequently asked questions
What types of data can be accessed through the API?
Read access (outbound feeds): staff, activities and participation over a period, the skills reference list and the expiry dates of skills held, organisations, sign-ups to paid activities, availability, absences, time-clock records, the vehicle fleet and equipment. Write access (inbound feeds): import and update of staff (whole record or only the fields sent, with PATCH), import of activities/training courses and assignment of skills.
How many API keys can be created?
The API relies on two keys: one for export (outbound feeds) and a token for import (inbound feeds). Each is generated and regenerated independently from the administration area. In API v2, a single key can serve both purposes through the Authorization: Bearer header.
Is there a modern REST API, or do you have to use the old format?
Both coexist. API v2 adds Bearer authentication, standardised JSON {success, data, meta}, pagination, CORS headers and explicit HTTP codes, while remaining backward compatible with the existing v1 endpoints.
Are there rate limits?
Yes. By default the instance is capped at 10,000 requests per day, and each key at 60 requests per minute. Responses include X-RateLimit headers and return an HTTP 429 code when the limit is exceeded. A usage dashboard tracks your consumption in real time.
How is access to the API secured?
Beyond the key, you can switch on restriction to an allowlist of IP addresses: any call from an IP not on the list is refused (HTTP 403). Authentication is preferably done through a Bearer header rather than in plain text in the URL.
Do you need technical skills to use the API?
Yes, the API is aimed at IT teams and developers. Configuration (activation, key generation, IP restriction) is done from the eBrigade administration area, and the endpoint documentation with cURL examples is built directly into the interface.