Skip to main content

API Reference

The Showwcase API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.


The Showwcase API utilizes Cache-First approach. In this approach, when a user requests data from the server, the server first checks if the requested data is available in the cache. If the data is available in the cache, the server returns it immediately to the user without making any additional requests to the database.

Supported Methods

GETRetrieve information about the REST API resource
POSTCreate a REST API resource
PUTUpdate a REST API resource
DELETEDelete a REST API resource or related component


Most of the lists/item collections are paginated. The parameters that control the pagination are skip and limit, indicating the desired offset and the items per page values.

The maximum limit value is 100.

Response format

"payload": [
"id": 1,
"id": 2
"details": {
"total": 1000,
"size:": 100,
"offset": 100,
"hasMore": true
Single Object
"payload": {
"id": 1
"_self": ""
"error": "You cannot request more than 100 items.",
"code": "RESULT_LIMIT",
"payload": null

HTTP status codes

Here's a list of the status codes used in Showwcase API:

Status CodeNameDescription

Request fulfilled


New resource created

400Bad Request

Request not understood


Invalid API token


Request not allowed

404Not Found

Resource unavailable

405Method not allowed

Incorrect request method


Old resource permanently unavailable

415Unsupported Media Type

Feature is not enabled

429Too Many Requests

Rate limit has been exceeded

500Internal Server Error

Generic server error

Best Practices

We can’t wait to see what you build! And we’d like to encourage you to build it using these recommended best practices.

Avoid unnecessary fetching

If you are frequently fetching the same data from Showwcase API, we recommend moving the data to your own servers.

Know your limits

All of our products have rate limits to ensure that all customers experience a high level of performance when using our platform.

Did we miss something?

Do you have a favorite best practice you’d like to see added to our list? Please let us know!