1

Create an API Key

API keys are managed from your account settings

Open the account menu in the top navigation bar and select API Keys.

Navigation

Account › API Keys

On the API Keys page, select Create new key. You will be prompted to choose a key scope before the key is generated.

2

Choose a Key Scope

Keys are scoped to a single department or the entire organisation

Choose the narrowest scope that covers your use case.

Department Key

Access is restricted to one department's data — schedules, pairs, and events within that unit only. Recommended for integrations operated by a single team.

Organisation Key

Full read/write access across all departments in the organisation. Use for organisation-wide reporting tools or administrative integrations.

Important

Copy the generated key immediately — it is shown only once. Store it in an environment variable or a secrets manager, never in source code.

3

Explore the API with Swagger

Browse all endpoints and send test requests directly from your browser

Example Request
GET https://api.schedulegenius.net/v1/organisations/{'{id}'}/events

Key Management

Keys can be revoked at any time from the API Keys page.

Security

If you believe a key has been compromised, revoke it immediately and generate a replacement. Treat API keys like passwords — rotate them regularly and never share them.

Need help getting started?

Contact Support