Magidoc

API Authentication

Obtaining an API key

#

To use the API, you need to authorize the request. Each request is authenticated using an API key. You can generate a new API key from the Taskworld App.

Navigate to your Taskworld's workspace settings and click on the "API" tab. You will see a list of existing API keys. You can also create a new API key from here by clicking on the "Create new API key" button.

Notes: currently only workspace admins can create API keys.

Using an API key

#

To authenticate a request to the GraphQL server, you need to pass the API key in the Authorization header. The header value should be in the following format:

    
  

Revoking an API key

#

Navigate to your Taskworld's workspace settings and click on the "API" tab. You will see a list of existing API keys. Click on the "Revoke" button to revoke an API key.