API للمطورين

Getting started

The open API lets an organisation's own programs read its data: a website that shows the next events, a spreadsheet that adds up the month, a screen in the hall. It is part of the API access module.

1. In Azonation, open API access and make a key. Tick only what the program needs.
2. Copy the key when it is shown. It is shown once; Azonation keeps only its fingerprint.
3. Send the key with every request, in the Authorization header.

curl -H "Authorization: Bearer YOUR_KEY" \
  "https://api.azonation.com/api/v1/open/events?from=2026-10-01&per_page=20"

The answer is JSON:

{
  "data": [
    { "id": 76, "name": "Summer fair", "starts_on": "2026-08-15", "venue": "Riverside Green" }
  ],
  "meta": { "page": 1, "per_page": 20, "total": 6, "last_page": 1 }
}

Keys

• One key per program. If a key leaks, switch that one off and nothing else stops working.
• A key reads only what was ticked. Asking for anything else answers 403.
• A key can be for one branch. It then reads only that branch's members, meetings and events.
• A key can run out. Give it a number of days; the owners are told before it ends.
• Keep a key on a server. Never put it in a web page or a phone app that other people can open.

A list of everything a key may read: GET https://api.azonation.com/api/v1/open

Asking

Every address starts with https://api.azonation.com/api/v1/open/ followed by the name of what you want. Dates are written YYYY-MM-DD. Times are in the organisation's own time zone. Money is in the smallest unit of the currency (pence, cents) with the currency beside it.

Filters go in the address after a question mark. Each resource has its own (see the table below):

https://api.azonation.com/api/v1/open/members?status=active&updated_since=2026-09-01
https://api.azonation.com/api/v1/open/money?from=2026-01-01&to=2026-12-31&kind=money_in

Pages of results

A list comes in pages: page (from 1) and per_page (50 if you say nothing, 100 at most). meta.last_page says when to stop.

Errors and limits

A key may ask 60 times a minute and send in 10 times a minute. An error answer always has a message in plain words.

What you can read

What you can send in

Three things can be sent in, each from a form on the organisation's own website. Each only adds something that waits for a person: nothing that exists is changed, nobody becomes a member, and no money moves.

curl -X POST -H "Authorization: Bearer YOUR_KEY" -H "Content-Type: application/json" \
  -d '{"name":"James Wood","email":"james.wood@example.com","message":"Can we hire the hall?"}' \
  "https://api.azonation.com/api/v1/open/messages"

Rules of the road

• The API is read-only apart from the three inboxes above. That is on purpose: a leaked key can never change or delete an organisation's records.
• Donors, single gifts, form answers, documents and secret ballots are not readable through the API.
• Whoever holds a key acts for the organisation and must keep to its duties under data protection law and our acceptable use policy.
• New fields may be added to an answer at any time. Fields are not removed or renamed without notice.
• Questions: support@azonation.com.