Project API Access

The API tab displays your project's API credentials for programmatic access and provides visibility into API usage through rate limit statistics, usage charts, and recent request history. Use these credentials to integrate GitScrum with external tools, automation scripts, and custom applications.

Overview

The interface displays real-time API usage information organized into three main sections: rate limit statistics at the top, a usage chart showing requests over the past 7 days, and a table of recent API requests made to your project.

Rate Limits Section

The rate limits section displays three statistics cards showing your current API usage status:

Total Requests

Shows the total number of API requests allowed during the current billing period. If your plan includes unlimited requests, this displays "Unlimited" instead of a number.

Available

Displays how many requests remain available for the current period. A green number indicates healthy availability. When your plan is unlimited, this also shows "Unlimited".

Period

Shows the current billing period date range in "start → end" format (e.g., "Dec 1 → Dec 31"). This helps you understand when your request counter resets.

Usage Chart

A bar chart displays API request volume over the past 7 days. Each bar represents one day, with the height indicating the number of requests made that day. The chart uses a blue color scheme with:

X-axis showing dates in short format
Y-axis showing request counts
Hover effects highlighting individual bars
Empty state showing flat bars when no requests have been made

This visualization helps identify usage patterns and detect unusual spikes in API activity.

Recent Requests Table

When API requests have been made to your project, a table displays the most recent activity with the following columns:

Method

Shows the HTTP method used for each request with color-coded badges:

GET - Green badge for read operations
POST - Blue badge for create operations
PUT - Orange badge for update operations
DELETE - Red badge for delete operations

Endpoint

Displays the API endpoint path that was called. Long endpoints are truncated with ellipsis.

Time

Shows when the request was made using human-readable relative time (e.g., "2m ago", "1h ago", "Yesterday"). Hover over the time to see the exact timestamp.

API Credentials

Click the Get Credentials button in the header to open the credentials modal. This modal provides the authentication keys needed to access your project via the API.

API ID

A unique identifier for API access. This value is read-only and cannot be changed. Click the copy icon to copy it to your clipboard. A "Copied" confirmation appears briefly after copying.

Project Key

The project-specific key used for authentication. This is also read-only. Click the copy icon to copy it to your clipboard.

Regenerating Credentials

If your credentials are compromised or you need to rotate them for security:

Click the Regenerate button at the bottom of the modal
The system generates new API ID and Project Key values
Update any applications using the old credentials immediately
Old credentials stop working as soon as new ones are generated

Warning: Regenerating credentials invalidates all existing integrations using the old values. Plan your credential rotation carefully.

API Documentation

Click the View documentation link at the bottom of the credentials modal to open the full API documentation at gitscrum.com. The documentation provides:

Complete endpoint reference
Authentication details
Request and response examples
Error code explanations

Understanding Rate Limits

Rate limits protect the API from abuse and ensure fair usage across all users. Your plan determines your limits:

Limits are calculated per billing period
The Available counter decreases as you make requests
Counter resets at the start of each new period
Unlimited plans show "Unlimited" for both total and available

Monitoring API Health

Use the API tab regularly to:

Check remaining quota - Ensure you have enough requests available
Review usage patterns - The chart reveals daily usage trends
Audit recent activity - The request table shows what endpoints are being called
Detect anomalies - Unusual spikes may indicate integration issues or unauthorized access

Permissions

Access to API credentials and statistics requires project Admin or Manager permissions. Team members with lower permissions cannot view this tab.

Webhooks - Receive real-time notifications when events occur
Integrations - Connect with Slack, Discord, GitHub, and other services