​
Konstantly API Documentation

Attention: This is a beta version of API documentation that may contain inaccuracies. Report errors to support@konstantly.com

​
Overview

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

​
Base URL

All API requests should be made to:

https://YOURSITE.konstant.ly/openapi/v1

​
Authentication

The Konstantly API uses API keys to authenticate requests. You can get your API key from:

  1. Go to your Konstantly site

  2. Navigate to Settings > API

  3. Copy your API key

All API requests must include your API key in the X-API-KEY header:

X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv

Keep your API keys secure and never share them in publicly accessible areas such as GitHub, client-side code, etc.

​
Request Format

The API accepts JSON-encoded request bodies and returns JSON-encoded responses. All requests should include the following headers:

Content-Type: application/json
Accept: application/json

​
Pagination

Many endpoints return paginated results. By default, endpoints return 20 items per page. You can specify which page of results to return using the offset parameter:

​
offset
integer

The number of items to skip. Use this for pagination.

​
limit
integer
default:"20"

The number of items to return per page (where supported).

​
Rate Limiting

Rate limiting information is provided in the response headers:

X-RateLimit-Limit: 100      # Requests per minute allowed
X-RateLimit-Remaining: 95   # Requests remaining in current time window
X-RateLimit-Reset: 1538152444  # Time when rate limit resets

​
Support

If you have any questions or need help with API integration, please contact our support team at support@konstantly.com.