API Documentation

Thank you for considering building with our API. Our mission is to help build memory and accountability. We hope our API helps you, as you work towards the same goals.

API Endpoints

Our API endpoints are all GET request and return json. No authentication is required.

• /api/v1/areas
• /api/v1/units
• /api/v1/presences

The data is paginated. There are 100 records per page. Add ?page=2 to access the second page.

Every attribute of an object that isn't an array, except the id (int), is a string. An empty string is used instead of null when there is no value. Note: This only applies to records, not pagination data.

Our Definition of Breaking Changes

The v1 API will be improved over time via additional endpoints and new attributes. Please do not hard code any vocabulary, such as area or unit names. We will not delete or rename any attributes, but we may edit vocabulary.

If you write your application accordingly, this API should support it for years to come.

Custom Endpoints

We are potentially open to building custom endpoints. Please reach out to Databases for Palestine to discuss.