Authentication

To authenticate with the MarkUp.io API you use API keys. API Keys are for a single workspace and can be created by the owner or admin of a workspace. Currently an API key provides access to all resources within a workspace, however in the future we may introduce more granular permissions.

API Keys should be kept a secret, stored securely, and only used for server to server communication. Treat them like passwords!

To create a new API key, go to the API Keys (opens in a new tab) section of MarkUp.io.

Once you have created an API key, you can use it to authenticate with the MarkUp.io API. You can do this by passing the API key as a Bearer token in the Authorization header.

Curl - Example request with API key secret

curl https://api.markup.io/api/v2/webhook-registrations \
    -X GET \
    -H "Authorization: Bearer <API-KEY-SECRET>" \
    -H "Content-Type: application/json" \
    -H "Markup-API-Version: 2023-02-22"

Introduction Versioning