Common API

Object model

Common Fields
API objects have a type field indicating their object type. Each object in the API may be given an identifier, indicated via its id field, and will typically be addressable via a URI. Many objects will also have a created_at field indicating the object’s creation date as a UTC Unix timestamp.

Dates and Timestamps
All temporal fields in the API are encoded as Unix timestamps and are by definition always treated as UTC. The most common time fields in the API are created_at and updated_at.

Parameter Description
created_at The time the object was created. In most, but not all cases, this is the time the object was created according to the API server.
updated_at The time the object was last updated according to the API server.

Optional Fields
Number, String and Boolean types may be returned as having null values.

Arrays and Objects may returned as being empty ([] {})
In general clients should be able to handle null and empty fields.

Data is encoded as defined by JSON in RFC4627. The default encoding for APIs is UTF-8

Use of HTTP
Request methods are used in accordance with HTTP.

GET is used to access resources and perform queries. The API does not allow modifications (creates, updates, deletes) to occur via GET.

POST is used to create or update resources. PATCH is not currently used by the API.

DELETE is used to delete resources.

The a (action) param is added to the request when performing an action other than just common CRUD actions.