Skip to main content
Beebole’s GraphQL API lets you build custom integrations that connect Beebole to any tool or internal system your organization uses. When the built-in integrations don’t cover your needs, the API gives you full programmatic access to read and write your Beebole account data. This page is a starting point. For endpoints, authentication details, queries, and mutations, see the API introduction.

​
What you can build

Beebole’s GraphQL API supports both queries (reading data) and mutations (creating or updating data). Common custom integrations include:
Use caseWhat it does
HR system syncCreate and update people in Beebole when employees change in your HR platform.
Custom reportingPull time records, project data, and financial summaries into your own dashboard.
Automated time entriesCreate time entries programmatically from data in other systems.
Project provisioningCreate projects and subprojects in Beebole from your internal tools.
Payroll exportExtract approved time data in the format your payroll provider requires.

​
Getting your API key

1

Access the API documentation

Review the full API reference in the API documentation tab. It covers authentication, the schema explorer, available queries, and mutations.
2

Generate an API token

Go to Settings > API in your Beebole account to generate an API token. This token authenticates your requests.
Keep your API token secure. Do not share it in client-side code or public repositories.
3

Explore the schema

Use the schema explorer to browse all available types, queries, and mutations. This helps you understand the data model before writing your integration.
4

Build and test your integration

Start with simple queries to read data, then move to mutations when you are ready to create or update records. Test thoroughly in a development environment before deploying to production.
Every person in Beebole has a personal API Key that authenticates their API requests. The key is created automatically and does not expire.
1

Open your API key

Click the button with your initials at the bottom of the sidebar, then choose API Key.
2

Copy the key

Click Copy to copy your API Key to the clipboard.
3

Authenticate your requests

Include the key in your API requests as described in the API introduction.
Keep your API key secure. Don’t include it in client-side code or commit it to public repositories — store it in an environment variable or a secrets manager. If a key is compromised, click Reset to revoke it and generate a new one.

​
Best practices

Start with a read-only integration (queries only) to validate your data mapping before writing data back to Beebole.
  • Use clear names for projects and people created through the API so they are easy to recognize in Beebole.
  • Handle errors gracefully. The API returns descriptive error messages — log and handle them in your code.
  • Keep your key secure. Store it in an environment variable or a secrets manager, not in source code.

​
Related content

API introduction

Authenticate with the Beebole GraphQL API and send your first request.

Webhooks

Send real-time Beebole event notifications to your own services.

All integrations

Browse the built-in Beebole integrations.

​
Frequently asked questions

Click the button with your initials at the bottom of the sidebar, then choose API Key. Your key is shown there with Copy and Reset actions. Beebole creates one key per person automatically, and it does not expire.
Any language with an HTTP client. The Beebole API uses standard GraphQL over HTTPS, so Python, JavaScript, Ruby, Go, Java, and others all work.
Yes. The Beebole API supports mutations for creating and updating time entries, projects, people, and other records. See the API introduction for details.
Resetting revokes your current key and generates a new one. Any integration using the old key stops working until you update it with the new key, so reset only when you need to rotate a compromised key.