Request & Response Format

We recommend making JSON requests against our API. This is done by setting the Content-Type HTTP header to "application/json". You are able to make requests using form encoded requests, but you may experience quirks that come from limitations in this request format.

All responses will follow the same basic format, although responses will have different fields based on the type of request.

data

The key that all returned data lives under is called data and will be provided in all responses that have a body.

metadata

This key is provided by responses in order to return information about the specific request made. For all "list" requests, this key will include filtering, paging, and sorting parameters. This allows you to know exactly how your request was processed, in case your request was not handled like expected.

error

HTTP status code 403, 404 will always include a singular error message to let you know why the request was rejected.

errors

HTTP status code 422 will always include an errors object consisting of key/value pairs in the format field/errors[]. This allows the API to communicate many errors back in a single response.

{
  "errors": {
    "email_address": ["is already taken"],
    "first_name": ["is required"]
  }
}

}