Overview
The "list all bookings" API allows users to retrieve a list of all the bookings in an organization. The bookings can be filtered based on client email, host email or type of the booking.
Usage
Base URL
https://<organization>.neetocal.com/api/external/v1
Replace the <organization> with the desired organization's subdomain.
Endpoint
GET /bookings
Request header
This endpoint requires authentication. You must include a valid API key in the request header.
Header |
Type |
Required |
Description |
|---|---|---|---|
X-Api-Key |
String |
Yes |
Bearer token for API access. |
Query parameters
Parameter |
Type |
Required |
Description |
|---|---|---|---|
|
String |
No |
For showing bookings of only a particular host. |
|
String |
No |
For showing bookings of only a particular client. |
|
String |
No |
For showing bookings of only a particular type. The available types are |
Note: All the above query parameters can also be passed as a JSON body.
Example
For getting the all the upcoming bookings of host "Oliver" with email [email protected] of an organization "Spinkart" with subdomain spinkart using curl:
curl -X GET "https://spinkart.neetocal.com/api/external/v1/[email protected]&type=upcoming"
--header "X-Api-Key: YOUR_API_KEY"OR
curl -X GET "https://spinkart.neetocal.com/api/external/v1/bookings" \
--header "X-Api-Key: YOUR_API_KEY" \
--get --data "[email protected]" --data "type=upcoming"Response Codes
Code |
Description |
|---|---|
200 |
OK - Request succeeded |
400 |
Bad Request - Missing/Invalid parameters |
401 |
Unauthorized - Invalid API key |
500 |
Internal server error |