API Overview

Artemis provides a comprehensive REST API to create, update, and query different aspects of your Artemis work. Presently, this API is best suited for low-frequency usage (fewer than 10 requests per minute), but batch API endpoints are provided to create, query, and update multiple items in a single request.

​

API Keys

All requests to the Artemis API must include your secret API key which is located in the Artemis Settings page under the “Secrets” tab. This key is unique to each user for logging and permission purposes.

​

Permissions

The permissions granted to each API key is identical to the permissions granted to the user to whom the key belongs. For example, if a user has the “Admin” role, then the API key created by that user will also have the “Admin” role.

​

API Endpoints

A comprehensive list of API endpoints is detailed underneath the “API Endpoints” dropdown underneath this page’s tab. Each endpoint is described in detail, including the required parameters, the response, and any errors that may be returned.

​

Error Handling

If an error occurs during an API request, the response will contain a JSON object with the following fields:

{
  "message": "error message",
  "status": 400
}