API Examples
Welcome to the API examples section. Here, you’ll find practical demonstrations of how to interact with our API endpoints using cURL commands. Each example is designed to help you quickly understand h
Last updated
Welcome to the API examples section. Here, you’ll find practical demonstrations of how to interact with our API endpoints using cURL commands. Each example is designed to help you quickly understand h
cURL-based examples: Every example shows the exact cURL command you can copy and run directly in your terminal.
Endpoint-specific demonstrations: We walk through different API endpoints one by one, highlighting the required parameters and common use cases.
Request & Response clarity: Each section contains both the request (what you send) and the response (what you get back) to illustrate expected behavior.
Before running any of the examples, make sure you have:
Backend ID
The Backend ID can be obtained from your groundcover Admin panel.
To locate it:
Navigate to Settings → Access
Open the API Keys tab
The Backend ID appears in the section header
When to Use
The Backend ID is required when your account is associated with multiple backends.
In such cases, include it in your API requests using the appropriate request header to ensure the request is routed to the correct backend.
Last updated
X-Backend-Id: <YOUR_BACKEND_ID>