API v1

This describes the resources that make up the official Oahu API V1. If you have any problems or requests please contact support.

Note: This API is in a beta state. Breaking changes may occur.

Schema

All API access is over HTTP, and accessed from the api.oahu.fr domain. All data is sent and received as JSON. You must, however, require JSON rendering :

Blank fields are included as null instead of being omitted.

All timestamps are returned in ISO 8601 format:

YYYY-MM-DDTHH:MM:SSZ

HTTP Verbs

Where possible, API v1 strives to use appropriate HTTP verbs for each action.

Pagination

Requests that return multiple items will be paginated to 10 items by default.
You can specify further pages with the ?page parameter.
You can also set a custom page size up to 100 with the ?limit parameter.