All, or almost all, APIs share the same structure.

List responses

Responses that return lists follow the same concept, they all return the same structure.

{
	"count": 5,
	"items": [/* data */],
	"lastKey": "string", // returned ONLY when there are more results
	"scrollId": "string" // returned ONLY on custom tables search result pagination
}

Response formatting

Some API endpoints allow for response transformation, or formatting.

So if you think our API responses are too verbose, complex or just plain ugly, feel free to make it better!

Just pass a JSONata expression in a vl-response-transformation header with your request to enable.

<aside> 💡 JSONata is used extensively within Vince Live, please read more in the section Understanding JSONata

</aside>

Use cases

This gives the caller the freedom to determine the output format, which can be very handy in cases such as

• coding or transforming on the client side might limited or impossible,
• when you want to limit which fields or rename properties that should be returned,
• filtering irrelevant records (see note below),