Neon is a JSON-based Web API organized around resource-oriented URLs.

The API generally follows these rules:

• The URL path is always lowercase.
• Kebab case is used for multiple words (e.g. /line-items/).
• Resources are named using plural nouns, e.g. /orders/.
• A path such as /orders/ returns a list of orders and /orders/:id returns a specific order.
• Nested resources are supported, such as /orders/:id/line-items/:id
• Field names and URL parameters use camelCase, E.g. ?lineItemId=123
• If a URL param accepts multiple values, we use the plural form and accept a comma-separated list, like so: ?userIds=1,2,3

Response body containing a single object:

  { 
    field: "value"
  }
  

Response body containing a list of objects:

  {
    results: [{field: "value"},{field: "value"}], 
    continuationToken: ""
  }
  

Responses may optionally include page, pageSize, and count fields in some cases. If the continuationToken is null, you are at the end of the list.

  {
    results: [{name: "a"},{name: "b"}]
    continuationToken: "",
    page: 1,
    pageSize: 25,
    count: 100
  }
  

Standard error response body (e.g. Status codes: 400 and 500):

  {
    errors: ["Error message 1", "Error message 2"]
  }