API Overview

The Poyst API is organized around REST. The API accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes.

Base URL

All API requests are made to:

https://api.poyst.com

Request format

Send JSON-encoded request bodies with the Content-Type: application/json header. All responses are returned as JSON.

Response format

Successful responses return a 200 status code with a JSON body. Error responses include an error message:

{
  "error": {
    "code": "not_found",
    "message": "The requested resource was not found."
  }
}