Using the API

The Lumify API allows "Multi-op" subscribers to integrate other systems or applications with Lumify regardless of the underlying mechanisms of storage of the other system or application.

Overview

This feature gives advanced users the ability to perform complicated operations on their data with ease. Only use the API if you have experience with integrations and software development. If you are not comfortable with API integrations, consider using our no-code options (i.e. Zapier actions). Note: Because this is advanced functionality, it will not be supported by Lumify Labs support.

"Acting As"

API tokens are associated with a user. All actions of the API token are attributed to the "acting as" user. This may be acceptable for some use cases, but you may consider creating a dedicated "system user" with the appropriate role and permissions.

Getting an API Token

Navigate to the "API Tokens" menu item (you must have the "Manage API Token" permission to generate an API token):

Then click "Create API Token":

Enter a descriptive name for the token (e.g. HubSpot integration token), choose the person the token will "act as", and choose an expiration date (if applicable):

Click "create" and your API token will be created:

This API token can now be used to make requests to the Lumify API.  It will not be displayed again. Save it somewhere safe from prying eyes.

Authenticating Requests

When you make requests to the Lumify API you should send the API token generated above in the "Authorization" header of your requests. Be sure to prefix your API token with "Bearer". For example, a valid request should include the following headers:

Authorization: Bearer 1|n9wHGPMYHXmzfrWtqTv0198Ba2FxW1ulc46rxg6m
Content-Type: application/json
Accept: application/json

Rate Limiting

Requests to the Lumify API are subject to rate limits to prevent abuse. Typically, API users are allowed to send up to 100 requests per minute. This limit is based on current request volume and subject to change.

API documentation

The Lumify API is documented on SwaggerHub.