Overview

Zerynth has a powerful API that enables you to retrieve, create, update, and delete nearly all of your information. You can use it to pull information into your app, update entities programmatically, and more.

The API is available for all users and organizations. All private endpoints require authentication, and all requests must be made over HTTPS.

note

The API is currently in beta and is subject to change.

Authentication

API keys are used to authenticate requests. You can create multiple keys, and each key can be disabled at any time. Each API key is tied to a specific workspace and has access to all the resources within that workspace.

Creating an API key

1. Go to the Workspace Settings section, in the General tab.

2. Click on the + button in the API Keys section.

3. Give your key a name - this is just for your reference - and click Create.

4. Copy the key and store it in a safe place. You won't be able to see it again.

warning

Keep your API key secure. Anyone with access to your key can access your workspace.

Authenticating requests

To authenticate requests, there are two options:

1. Use the Authorization header and Bearer authentication:

   const headers = {
       Authorization: `Bearer ${API_KEY}`
   };

2. Use the X-API-KEY header (deprecated):

   const headers = {
       'X-API-KEY': API_KEY
   };

These options are evaluated in the order they are presented. If both are present, the Authorization header will be used.