Gorelo allows you to integrate with any external product through the use of our API.

The Gorelo API uses API keys. Include your key in every request via the X-API-Key header.

Base URL: https://api.usw.gorelo.io/
API Reference: https://api.usw.gorelo.io/swagger

Generate API Key

1. Navigate to Settings → Integrations

2. Click the ⚙️cog icon to configure API

3. Click the ‘Generate New Key’ button

   • Enter a name

   • Select the permission scope

   • Enter a description (optional)

   • Click Generate

   • Copy the key

Revoke API Key

1. Navigate to Settings → Integrations

2. Click the ⚙️cog icon to configure API

3. Click ‘Revoke’ on an API Key

Using Swagger UI

1. Navigate to https://api.usw.gorelo.io/swagger

2. Click Authorize (top right).

3. In the apiKey dialog, paste the key value

4. Hit Authorize → Close. All “Try it out” calls will include your key automatically.

Scopes & permissions

API keys can be scoped. If a key lacks access for an endpoint, the API returns 403 Forbidden.

Error handling

• 401 Unauthorized – missing/invalid API key.

• 403 Forbidden – valid key, insufficient scope.

• 429 Too Many Requests – rate limit exceeded