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

There are two scopes for the events API, you can either request the events for a specific community, or all featured events on Doorkeeper.

List a community's events

GET /groups/:group/events

List all featured events

GET /events

Parameters

To further control the results, we support the following paramters:

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.
since
Only events taking place during or after this date will be included. (ISO 8601 date)
until
Only events taking place during or before this date will be included. (ISO 8601 date)
callback
JSON-P callback that wraps the results in the given function.

Event

Show a specific event

GET /events/:id

Application Showcase