Search
K
Fundamentals Layer API (Production)

ApiV1RateLimit

object
* Additional properties are NOT allowed.
limitinteger(int32)
remaininginteger(int32)
resetstring(date-time)
Example

ApiV1Response

object
* Additional properties are NOT allowed.
successboolean
apiVersionstring
timestampstring(date-time)
requestIdstring
data
metaobject
* Additional properties are NOT allowed.
Show Child Parameters
rateLimitobject
* Additional properties are NOT allowed.
Show Child Parameters
Example

ApiV1Response2

object

Standardized successful API response wrapper for v1.0.0 endpoints.

* Additional properties are NOT allowed.
successboolean

Always true for successful responses.

apiVersionstring

Semantic API version (e.g., “1.0.0”).

timestampstring(date-time)

UTC timestamp when the response was generated.

requestIdstring

Unique request identifier for tracing.

data

The response payload.

metaobject

Pagination and metadata information for collection responses.

* Additional properties are NOT allowed.
Show Child Parameters
rateLimitobject

Rate limit information returned with each response.

* Additional properties are NOT allowed.
Show Child Parameters
Example

ApiV1RateLimit2

object

Rate limit information returned with each response.

* Additional properties are NOT allowed.
limitinteger(int32)

Total request quota for the current window.

remaininginteger(int32)

Remaining requests in the current window.

resetstring(date-time)

UTC timestamp when the rate limit window resets.

Example

ApiV1Meta2

object

Pagination and metadata information for collection responses.

* Additional properties are NOT allowed.
pageinteger(int32)

Current page number (1-based).

pageSizeinteger(int32)

Number of items per page.

totalRecordsinteger(int32)

Total number of records available across all pages.

totalPagesinteger(int32)read-only

Total number of pages.

hasNextPagebooleanread-only

Whether there is a next page available.

hasPreviousPagebooleanread-only

Whether there is a previous page available.

Example