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.
All temporal fields in the API are encoded as ISO 8601 and are by definition always treated as UTC. The most common time fields are
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.
The time the object was last updated according to the API server.
Unpopulated optional data is returned as follows
- Number, String, and Boolean types may be returned as having
- Arrays and Objects may be returned as empty (
In general clients should be able to handle null and empty fields.
Some object types have a
meta field that allows clients to get more info about an object.