Get started by trying out one of our recipes!

https://api.lumos.com

Authentication

Lumos authenticates API requests using API keys. You will need to pass in a header to all requests to the Lumos API like this one.

curl 'https://api.lumos.com/appstore/apps' \
	--header 'Authorization: Bearer lsk_example_1234'

API Tokens inherit & retain the permissions of the user that created them.

Creating an API Token

Go to the API Tokens page in the Lumos settings.
Click on "Add API Token"
Input a Name and a Description
Click "Create API Token."

Store your API token carefully! We take security seriously so we can only show you the API Token at creation time. All Lumos API Tokens are prefixed with lsk_.

Testing the API

You can test the API using the command line or an app such as Postman.

To use Postman:

In Postman, go to Import (or File → Import) and enter this URL: https://api.lumos.com/openapi.json. Postman will create a collection from the spec.
Set Authorization to Bearer and use your API token as the value (in the collection or on individual requests).

Pagination

Many of our endpoints for listing data support paginated responses. These endpoints use page and size as query parameters to control pagination.

curl 'https://api.lumos.com/appstore/apps?page=1&size=50' \
	--header 'Authorization: Bearer lsk_example_1234'

Input Parameters

Input query parameters are as follows:

Parameter	Type	Description
`page`	Integer	The page number, starting at `1`
`size`	Integer	The size of the page. From `1` to `100`.

Output Fields

The output fields of paginated responses are as follows:

Field	Type	Description
`items`	Array of Objects	The data requested
`total`	Integer	The total number of items that can be returned
`page`	Integer	The page number of the page of data returned
`size`	Integer	The size of the page of data returned