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

1. Go to the API Tokens page in the Lumos settings.
2. Click on "Add API Token"
3. Input a Name and a Description
4. 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 by using the command line, the capabilities on developers.lumos.com, or via an app such as Postman with our Postman Collection.

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:

Output Fields

The output fields of paginated responses are as follows: