Introduction
The reference is your key to a comprehensive understanding of the LyteCMS API.
Conventions
The base URL to send all API requests is https://www.lytecms.com/api/v1.
The LyteCMS API follows RESTful conventions when possible, with most operations performed via GET, POST, PUT, and DELETE requests on page and database resources. Request and response bodies are encoded as JSON.
Pagination
Endpoints that return lists of objects support cursor-based pagination requests. By default, LyteCMS returns 20 items per API call. If the number of items in a response from a support endpoint exceeds the default, then an integration can use pagination to request a specific set of the results and/or to limit the number of returned items.
Supported endpoints
| HTTP method | Endpoint Description |
|---|---|
| GET | List all Projects |
| GET | List all Tables |
| GET | List all Records |
| POST | Query Records |
Common parameters for paginated requests
Pagination parameters location varies by endpoint
GET requests accept parameters in the query string.
POST requests receive parameters in the request body.
| Parameter | Type | Description |
|---|---|---|
| page_size | number | The number of items per page. |
| page | number | The page number. |
Common responses for paginated requests
If an endpoint supports pagination, then the response object contains the below fields.
| Field | Type | Description |
|---|---|---|
| page | number | Page number. |
| page_size | number | Number of items per page. |
| total_pages | number | Total number of pages. |
| total_items | number | Total number of items. |