Workspace
Calry Workspace
Introduction
A Workspace on Zepl is the container for all of the host accounts and integrations for a customer. All of the listing, availability, quote and reservation data is specifc to a workspace. It is assigned to the customer when they sign up for Zepl, along with an initial API key.
Schema
The workspace schema is as follows:
| Field | Type | Description |
|---|---|---|
| id | UUID | Unique Identifier of the Workspace |
| name | string | Name of the workspace |
| slug | string | Slug of the Workspace |
| defaultCurrency | ISO4217 Currency Code | The default currency, used when displaying prices across all endpoints |
| defaultDiscountPercentage | number | Workspace level default discount percentage, applied to all prices, when displaying or creating quote/reservations |
| createdAt | Date | Workspace creation timestamp |
| updatedAt | Date | Workspace updated timestamp |
Currency
The default currency is used when displaying prices across all endpoints. The currency is represented as an ISO4217 currency code. This is used on the listing, availability, quote and reservation endpoints.
In addition, if you wish to override the currency used for a specific API call, you can pass the displayCurrency query parameter, and it will use that currency for displaying prices. The conversion is done with the exchange rate at the time of the API call.