Skip to main content
GET
This endpoint returns the GitHub account connected to your BLACKBOX API key. Use it to check which GitHub user is linked before creating tasks that work with repositories.
This endpoint requires a Pro subscription.

Authentication

To use this API, you need a BLACKBOX API Key. Follow these steps to get your API key:
  1. Go to app.blackbox.ai/agent-api and click Get an API Key (requires a Pro subscription)
  2. Once provisioning completes, you will be redirected to your Dashboard
  3. From the Dashboard, create an API key to use with all Agent API requests
Your API key will be in the format: sk-xxxxxxxxxxxxxxxxxxxxxx

Headers

string
required
API Key of the form Bearer <api_key>.Example: Bearer sk_b41b647ffbfed27f616560

Response Fields

boolean
true if a valid GitHub token is stored, false otherwise.
string
GitHub username. Present when connected: true.
string | null
Display name of the GitHub user.
string | null
Primary email of the GitHub user.
string
GitHub avatar URL.
string
OAuth scopes granted by the token (e.g. "repo,user").
string | null
ISO 8601 timestamp when the token was stored. null if not recorded.

Error Codes