Doorkeeper API
This describes the resources that make up the official Doorkeeper API. If you have any problems or requests, please contact support.
Note: This API is in an alpha state. Breaking changes are expected to occur.
Schema
All API access is over HTTP, and accessed via api.doorkeeper.jp. All data is sent and received as JSON or XML.
Example
$ curl -i http://api.doorkeeper.jp/
HTTP/1.1 200 OK
Content-Length: 2
Status: 200
Content-Type: application/json; charset=utf-8
{}
Blank fields are included as null instead of being omitted.
All timestamps are returned in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
Pagination
Requests that return multiple items will be paginated to 25 items. You can specify further pages with the ?page parameter.
Events
List a community's events
GET /groups/:group/events
List all featured events
GET /events
Parameters
- q
- Keyword to search for from the title or description field.
- page
- The page offset of the results.
- locale
- The localized text for an event. One of
en,ja. Default:en. - sort
- The order of the results. One of
published_at,starts_at,updated_at. Default:published_at.