| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://api.cheqroom.com/api/v2_5 | link | — | — | — |
Actions (34)
Users · 6
- Create userPOST /api/v2_5/users
Create a new user in Cheqroom.
documented - Delete userDELETE /api/v2_5/users/{user_id}
Remove a user from Cheqroom.
documented - Get userGET /api/v2_5/users/{user_id}
Retrieve a user by ID.
documented - Invite userPOST /api/v2_5/users/{user_id}/invite
Invite a user to Cheqroom.
documented - List usersGET /api/v2_5/users
Retrieve a list of users.
documented - Update userPUT /api/v2_5/users/{user_id}
Update user details.
documented
Check-outs · 5
- Create checkoutPOST /api/v2_5/orders
Create a new checkout (order) in Cheqroom.
documented - Delete checkoutDELETE /api/v2_5/orders/{order_id}
Delete a checkout.
documented - Get checkoutGET /api/v2_5/orders/{order_id}
Retrieve a specific checkout by its ID.
documented - List check-outsGET /api/v2_5/orders
Retrieve a list of check-outs (orders).
documented - Update checkoutPUT /api/v2_5/orders/{order_id}
Update an existing checkout.
documented
Contacts · 5
- Create customerPOST /api/v2_5/customers
Create a new customer/contact in Cheqroom.
documented - Delete customerDELETE /api/v2_5/customers/{customer_id}
Remove a customer from Cheqroom.
documented - Get customerGET /api/v2_5/customers/{customer_id}
Retrieve a customer by their ID.
documented - List customersGET /api/v2_5/customers
Retrieve a list of customers/contacts.
documented - Update customerPUT /api/v2_5/customers/{customer_id}
Update an existing customer.
documented
Items · 5
- Create itemPOST /api/v2_5/items
Create a new item in the Cheqroom inventory.
documented - Delete itemDELETE /api/v2_5/items/{item_id}
Remove an item from Cheqroom inventory.
documented - Get itemGET /api/v2_5/items/{item_id}
Retrieve the details of a specific item by its ID.
documented - Get item availabilityGET /api/v2_5/items/{item_id}/availability
Fetch availability information for a specific item.
documented - Update itemPUT /api/v2_5/items/{item_id}
Update the fields of an existing item.
documented
Webhooks · 5
- Create webhookPOST /api/v2_5/webhooks
Create a new webhook.
documented - Delete webhookDELETE /api/v2_5/webhooks/{webhook_id}
Delete a webhook.
documented - Get webhookGET /api/v2_5/webhooks/{webhook_id}
Retrieve a webhook by ID.
documented - List webhooksGET /api/v2_5/webhooks
List configured webhooks.
documented - Update webhookPUT /api/v2_5/webhooks/{webhook_id}
Update an existing webhook.
documented
Reservations · 4
- Cancel reservationDELETE /api/v2_5/reservations/{reservation_id}
Cancel an active reservation.
documented - Get reservationGET /api/v2_5/reservations/{reservation_id}
Retrieve a reservation by its ID.
documented - Reserve itemPOST /api/v2_5/reservations
Create a new reservation for an item.
documented - Update reservationPUT /api/v2_5/reservations/{reservation_id}
Modify details of an existing reservation.
documented