Open API v2 / Get started / Requests & responses

Requests & responses

The API is organized around REST. It uses predictable resource-oriented URLs, accepts and returns JSON, and relies on standard HTTP verbs and status codes.

Base URL

Every endpoint lives under your site's domain. Replace {site} with your site's subdomain.

Base URL

https://{site}.webinone.com/api/v2/admin/...

Content type

Send request bodies as JSON with Content-Type: application/json. Responses are JSON.

HTTP methods

GET	Read a resource or list resources.
POST	Create a new resource.
PUT	Replace an existing resource.
DELETE	Remove a resource.

List responses

Endpoints that return collections wrap the results in a paged envelope: an Items array plus TotalItemsCount for the full match count. Use Offset and Limit to page through large sets.

Response

{
  "Items": [ { ... }, { ... } ],
  "TotalItemsCount": 248
}

Field types

Every field in the reference shows its type. This is how each type is written:

string	Text value.
integer · number	Whole or decimal number.
boolean	True or false.
string · date-time	ISO 8601 timestamp, e.g. `2026-07-01T00:00:00Z`.
enum	One of a fixed set; the allowed values are listed with the field.
object	Nested object — its fields expand under it in the field table.
array of strings	List of primitive values.
array of objects	List of objects — item fields expand in the field table.
nullable	Appended to a type when the value may be `null`.