REST Principles

The QuicklySign API follows standard REST conventions. Most resources support the following HTTP methods:

Verb	Description
GET	Retrieve an entity or list of entities
POST	Create a new entity
PUT	Update an existing entity (partial updates supported)
DELETE	Remove an entity

All requests and responses use JSON.

Response Structure

All API responses follow a consistent envelope pattern:

{
  "status": {
    "status_code": 200,
    "warnings": [{"code": "warning_code", "message": "warning message"}],
    "information": [{"message": "optional info"}]
  },
  "data": { ... },
  "pagination": { "next": "..." }
}

Error Handling Example

{
  "status": {
    "status_code": 400,
    "errors": [{"code": "invalid_field", "message": "Field X is required"}]
  }
}

HTTP codes (200, 400, 401, 500) are also reflected in headers.

Tip: If your client cannot parse non-200 responses, append ?always_use_http_status_code_200=true to the request URL.

Pagination

Paginated responses include a pagination object with a next URL to fetch subsequent pages.