INTRODUCTION
Feature Summary: The CourtReserve API provides a secure and flexible way to integrate CourtReserve with external systems. Organizations can enable API access at the organization level for localized control or use the Enterprise API for centralized, multi-location management by contacting Customer Success. To learn more about API functionality at a high level, refer to the linked article here.
The Create API Key feature enables organizations to generate and manage multiple API keys at the organization or location level, with access controlled by role and permission. This ensures integrations receive only the access they need while enhancing security, visibility, and overall control.
Use Cases
Integrate CourtReserve with third-party systems such as CRMs, analytics tools, access control systems, or reporting platforms
Create separate API keys for different vendors or integrations
Restrict API keys to read-only access for reporting or data synchronization
Grant read/write access for trusted systems that need to create or update data
Limit access to specific areas of the platform (such as events, memberships, or calendars)
Improve security by isolating integrations and rotating or revoking keys as needed
Track API key creation, edits, and deletions through the audit log for accountability and oversight
This approach gives organizations control over how external systems interact with their CourtReserve data while supporting a wide range of integration needs.
PREREQUISITE
API access is available only to organizations on the Scale or Enterprise subscription plans. Organizations on the Start or Grow plans, or those using legacy pricing, are not eligible. To request access, organizations can contact the CourtReserve Customer Success team to discuss upgrading their plan.
Pricing
Scale: Included
Enterprise: Included
OVERVIEW
Enabling API Access
To enable API access, navigate to Settings in the sidebar and scroll to the Additional Features row at the bottom. Click the Additional Features icon.
Under the Integrations section, locate API Access. Enable the checkbox and click Setup.
Click the Create API Key button to add a new key.
Create API Key Screen Overview
The Create API Key screen allows organizations to generate and manage multiple API keys for their organization or specific location, with the ability to control and restrict what each API key can access.
Organization Name: Displays the organization the API key will be associated with. This field is read-only.
Key Name: A required, internal name used to identify the API key. This is especially useful when managing multiple API keys for different integrations, vendors, or environments (for example, reporting, read-only access, or testing).
Access Type: Defines the level of access granted to the API key:
Full Access: Grants the API key unrestricted access. Once selected, no additional configuration is required—click Save to continue.
Restricted Access: Allows granular control over which areas of the system an API key can access. See the next section for an overview of roles and permission options available with Restricted Access.
Roles and Permissions (Restricted Access Only)
When Restricted Access is selected, a list of roles appears. These roles align with the endpoints defined in CourtReserve’s technical API documentation (see details below).
For each role name in the grid, select Has Access to enable access. If Has Access is not selected, that role is disabled and the API key has no access to that data.
Once Has Access is enabled, choose the appropriate permission level:
Read allows the API key to view and retrieve data.
Write allows the API key to create, update, or delete data.
This ensures the API key only has access to the data and actions explicitly granted.
In the example below, this API key has read-only access to member, family, and membership data, meaning the data can be retrieved and viewed but not created, updated, or deleted.
API Key Management
After saving a key:
Use the available actions to edit or delete the API key as needed.
Select View to display the Username and Password associated with the key.
View Credentials
Selecting View opens the credentials panel for the selected API key.
This screen displays the Username and Password associated with the API key, which are used to authenticate integrations connecting to CourtReserve.
The Username is shown in plain text and includes a Copy icon, allowing you to quickly copy the value to your clipboard for use in an external system.
The Password is hidden by default for security. Use the View (eye) icon to temporarily reveal the password, or select the Copy icon to copy it directly without displaying it on screen.
These credentials are typically pasted into the authentication settings of the system or application connecting to CourtReserve—for example, when configuring an API connection in a custom integration or middleware tool.
To generate a new password for the API key, select Regenerate Password.
Audit Log
All API key creation, edits, role assignments, and deletions are recorded in the audit log, providing visibility into changes made at the organization level. To view this activity, click Audit Log in the upper-right corner of the API screen.
API Documentation
From the top of the API page, system users can access CourtReserve’s technical API documentation. This documentation is also linked here and outlines the available endpoints that correspond to the roles enabled when Restricted Access is selected.
To access an endpoint, the system user must authenticate using the username and password associated with an API key that has permission for the selected role / endpoint.
What is an endpoint? In an API context, endpoints are defined access points that allow applications to retrieve or modify data. The Organization API provides a comprehensive set of endpoints that enable administrators to manage memberships, members, families, events, reservations, and transactions.
For example, an endpoint may allow an integration to retrieve a list of members or create a new reservation at a specific location, providing flexibility and control over data and operations.