About this integration
Online booking and scheduling platform for managing services, resources, timeslots, and customer appointments. Connect it to any workflow without writing code.
You can choose from 17 triggers, 52 search modules and 80 actions. The connection type is basic or oauth authentication.
How to connect
The credential form asks for anny - Environment, anny - API Key, anny - Environment, and Client ID.
Prefer the interactive builder form? Open it on the app page.
Sign in and approve access — your password is never shared with WEXTL®, and you can revoke access from the provider at any time.
Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
Connecting Anny Admin API to WEXTL®
| Field | Type | Help |
|---|---|---|
anny - Environment | select | Select the environment. |
anny - API KeyRequired | password | Log into anny, go to Organization Settings → API, Create a new access token and select the scopes you need and copy the token and use it in your API requests |
| Field | Type | Help |
|---|---|---|
anny - Environment | select | Select the environment. |
Client IDRequired | text | A custom OAuth2 Client ID is a special case. Contact |
Client SecretRequired | password | A custom OAuth2 Client ID is a special case. Contact |
Use it in workflow automation
Start with Watch Bookings, then add Cancel an Invoice.
The canvas below runs Watch Bookings into Cancel an Invoice — watch the video, then drop a node onto the canvas.
Select the Watch Timeslot Resource Allocations trigger and the workflow fires automatically when the event occurs — no polling required.
Then add Create a Recurring Timeslots as the next node. Branch, filter, or hand off to other integrations from there.
The integration includes 97 ready-made modules for scheduling work — each run logs its inputs and outputs for debugging.
Anny Admin API workflow on the canvas: Watch Timeslot Resource Allocations then Create a Recurring Timeslots
Triggers, searches and actions
Explore the fields available for each Anny Admin API trigger, search, and action — 17 triggers, 52 searchs, and 80 actions.
Triggers
Whenever something changes in the app, one of 17 available triggers can start a run immediately.
- Watch Bookings
- Watch Broadcast Campaigns
- Watch Businesses
- Watch Calendars
- Watch Community Invites
Searches
52 search modules let you query the app mid-run and feed the results to the next step.
- Get a Booking
- Get a Booking Model Identifier
- Get a Broadcast Campaign
- Get a Business
- Get a Community
Actions
Use 80 action modules to write data back into the app from anywhere in a run.
- Cancel an Invoice
- Cancel an Order
- Change Invoice Recipient
- Check In Booking
- Check Out Booking
Explore the fields available for each Anny Admin API trigger, search, and action.
Triggers
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Number | text |
Status | text |
Is blocker | boolean |
Start date | date |
End date | date |
Blocker start date | date |
Blocker end date | date |
Description | text |
Charged duration | number |
Weight | number |
Links | object |
Self | text |
Meta | array |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Scheduled at | text |
Status | text |
Total count | number |
Failed count | number |
Sent count | number |
Recurring | boolean |
Cron | text |
Created at | date |
Links | object |
Self | text |
Relationships | object |
Template | object |
Audience | object |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Brand name | text |
Domain | text |
Billing email | |
Vat ID | text |
Notes | text |
Custom entry map | object |
Created at | date |
Updated at | date |
Meta | object |
Has business account | boolean |
Links | object |
Self | text |
Relationships | object |
Billing address | object |
Logo image | object |
Customers | object |
Custom entries | object |
Customer balances | object |
Payment setup | object |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Show description | boolean |
Show customer | boolean |
Show add ons | boolean |
Show sub bookings | boolean |
Show external events | boolean |
Blocker style | text |
Days before | number |
Days after | number |
Locale | text |
Links | object |
Self | text |
Relationships | object |
Resources | object |
Meta | object |
Calendar URL | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Email | text |
Role | text |
Body | text |
Silent | boolean |
Expiry | date |
Accepted at | date |
Start date | date |
End date | date |
Created at | date |
Links | object |
Self | text |
Relationships | object |
Community | object |
Organization | object |
User | object |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Total | number |
Currency | text |
Label | text |
Status | text |
Start date | date |
End date | date |
Issue at | date |
Issued at | date |
Created at | date |
Updated at | date |
Links | object |
Self | text |
Relationships | object |
Balanceable | object |
Customer account | object |
Invoices | object |
Master invoice | object |
Payment setup | object |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
UUID | text |
Number | text |
Locale | text |
Title | text |
Given name | text |
Family name | text |
Full name | text |
Sex | text |
Birth date | date |
Email | |
Links | object |
Self | text |
Relationships | object |
Address | object |
Delivery address | object |
Business | object |
Custom entries | object |
Orders | object |
Model identifiers | object |
Subscriptions | object |
Communities | object |
Community invites | object |
Document acceptances | object |
Meta | object |
Has account | boolean |
External ID | text |
Idp user ID | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Number | text |
Formatted number | text |
Currency | text |
Is cancellation | boolean |
Is credit | boolean |
Has payment | boolean |
Show transfer note | boolean |
Vat number | text |
Notes | text |
Recipient | text |
Links | object |
Self | text |
Relationships | object |
Order | object |
Items | object |
Payments | object |
Organization | object |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Number | text |
Currency | text |
Total | number |
Modification total | number |
Net amount | number |
Tax amount | number |
Discount amount | number |
System fee | number |
Status | text |
Access token | text |
Links | object |
Self | text |
Relationships | object |
Bookings | object |
Customer | object |
Organization | object |
Invoice | object |
Invoice history | object |
Tmp invoice | object |
Last payment | object |
Payments | object |
Voucher | object |
Sub orders | object |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Slug | text |
Name | text |
Description | text |
Plain description | text |
Availability mode | text |
Continuous | boolean |
Color | text |
Auto accept bookings | boolean |
Timezone | text |
Quantity | number |
Links | object |
Self | text |
Meta | object |
Is available | text |
Booking count | text |
Number available | text |
Minimal service | object |
Service list | text |
Services count | number |
Settings | object |
Meta settings | object |
Zoom | boolean |
Client URL | url |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Title | text |
Available from | text |
Available to | text |
Timezone | text |
Preview label | text |
Default | boolean |
Created at | date |
Updated at | date |
Links | object |
Self | text |
Relationships | object |
Schedules | object |
Resources | object |
Resource schedule groups | object |
Meta | object |
Resources count | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Slug | text |
Description | text |
Hidden | boolean |
Is rental option | boolean |
Has flexible duration | boolean |
Auto duration | boolean |
Allow cross schedule | boolean |
Requires booking description | boolean |
Requires address | boolean |
Links | object |
Self | text |
Meta | object |
Resource list | text |
Min duration total | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Result options | array |
Auto result | text |
Auto result delay | number |
Certificate body | text |
Certificate footer | text |
Issuing authority | text |
Doctor name | text |
Valid period | number |
Test type options | array |
Links | object |
Self | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Status | text |
Capacity multiplier | number |
Order index | number |
Imputed costs | text |
Is externally blocked | boolean |
Is required | boolean |
Provisioned at | text |
Provisioned by booking ID | text |
Visible to customer | boolean |
Created at | date |
Links | object |
Self | text |
Relationships | object |
Resource | object |
Timeslot | object |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Title | text |
Title i 18n | object |
Description | text |
Descriptaion i 18n | object |
Start date | date |
End date | date |
Timezone | text |
Quota | text |
Resource info | array |
Created at | date |
Links | object |
Self | text |
Relationships | object |
Resource | object |
Service | object |
Series | object |
Cover image | object |
Resource allocations | object |
Model syncs | object |
Meta | object |
Provisioned quota | number |
Active booking count | number |
Pending booking count | number |
Total booking count | number |
Available provisioned slots | number |
Pending capacity | number |
Protected | array |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Start date | date |
End date | date |
Created at | date |
Updated at | date |
Links | object |
Self | text |
Relationships | object |
Resource | object |
Timeslots | object |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Code | text |
Absolute discount | text |
Currency | text |
Relative discount | text |
Number available | number |
Expires at | date |
Include add ons | boolean |
Description | text |
Created at | date |
Links | object |
Self | text |
Relationships | object |
Resources | object |
Orders | object |
Searches
| Field | Type |
|---|---|
IDRequired | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Number | text |
Status | text |
Is blocker | boolean |
Start date | date |
End date | date |
Blocker start date | date |
Blocker end date | date |
Description | text |
Charged duration | number |
Weight | number |
Links | object |
Self | text |
Meta | array |
| Field | Type |
|---|---|
IDRequired | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Number | text |
Status | text |
Is blocker | boolean |
Start date | date |
End date | date |
Blocker start date | date |
Blocker end date | date |
Description | text |
Charged duration | number |
Weight | number |
Links | object |
Self | text |
Meta | array |
| Field | Type |
|---|---|
Broadcast Campaign IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Scheduled at | text |
Status | text |
Total count | number |
Failed count | number |
Sent count | number |
Recurring | boolean |
Cron | text |
Created at | date |
Links | object |
Self | text |
Relationships | object |
Template | object |
Audience | object |
| Field | Type |
|---|---|
Business IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Brand name | text |
Domain | text |
Billing email | |
Vat ID | text |
Notes | text |
Custom entry map | object |
Created at | date |
Updated at | date |
Meta | object |
Has business account | boolean |
Links | object |
Self | text |
Relationships | object |
Billing address | object |
Logo image | object |
Customers | object |
Custom entries | object |
Customer balances | object |
Payment setup | object |
| Field | Type |
|---|---|
IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Slug | text |
Name | text |
Color | text |
Icon | text |
Welcome text | text |
Is private | boolean |
Allow customer requests | boolean |
Allow organization requests | boolean |
Auto join enabled | boolean |
Auto join settings | text |
Links | object |
Self | text |
Relationships | object |
Domains | object |
Logo image | object |
Resources | object |
Resource groups | object |
Services | object |
Organizations | object |
Owner organization | object |
Community accounts | object |
Unpersonalized invite | object |
Booking quotas | object |
Meta | object |
Members count | number |
| Field | Type |
|---|---|
Customer IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
UUID | text |
Number | text |
Locale | text |
Title | text |
Given name | text |
Family name | text |
Full name | text |
Sex | text |
Birth date | date |
Email | |
Links | object |
Self | text |
Relationships | object |
Address | object |
Delivery address | object |
Business | object |
Custom entries | object |
Orders | object |
Model identifiers | object |
Subscriptions | object |
Communities | object |
Community invites | object |
Document acceptances | object |
Meta | object |
Has account | boolean |
External ID | text |
Idp user ID | text |
| Field | Type |
|---|---|
Customer Balance UUIDRequired | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Slug | text |
Description | text |
Hidden | text |
Is rental option | boolean |
Has flexible duration | boolean |
Auto duration | text |
Allow cross schedule | text |
Requires booking description | boolean |
Requires address | boolean |
Links | object |
Self | text |
Meta | object |
Resource list | text |
Min duration total | number |
| Field | Type |
|---|---|
Add-on IDRequired | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Description | text |
Plain description | text |
Customer notice | text |
Lead time | number |
Is third party | boolean |
Is net price | boolean |
Currency | text |
Tax rate | number |
Price | number |
Links | object |
Self | url |
| Field | Type |
|---|---|
Add-on Group IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Local name i 18n | object |
Created at | date |
Links | object |
Self | text |
Relationships | object |
Add ons | object |
| Field | Type |
|---|---|
ISC Calendar IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Show description | boolean |
Show customer | boolean |
Show add ons | boolean |
Show sub bookings | boolean |
Show external events | boolean |
Blocker style | text |
Days before | number |
Days after | number |
Locale | text |
Links | object |
Self | text |
Relationships | object |
Resources | object |
Meta | object |
Calendar URL | text |
| Field | Type |
|---|---|
Invoice IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Number | text |
Formatted number | text |
Currency | text |
Is cancellation | boolean |
Is credit | boolean |
Has payment | boolean |
Show transfer note | boolean |
Vat number | text |
Notes | text |
Recipient | text |
Links | object |
Self | text |
Relationships | object |
Order | object |
Items | object |
Payments | object |
Organization | object |
| Field | Type |
|---|---|
Order IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Number | text |
Currency | text |
Total | number |
Modification total | number |
Net amount | number |
Tax amount | number |
Discount amount | number |
System fee | number |
Status | text |
Access token | text |
Links | object |
Self | text |
Relationships | object |
Bookings | object |
Customer | object |
Organization | object |
Invoice | object |
Invoice history | object |
Tmp invoice | object |
Last payment | object |
Payments | object |
Voucher | object |
Sub orders | object |
| Field | Type |
|---|---|
Property IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Label | text |
Icon | text |
Value type | text |
Filterable | boolean |
Private | boolean |
Links | object |
Self | text |
Relationships | object |
Resource properties | object |
Meta | object |
Options | array |
| Field | Type |
|---|---|
Resource IDRequired | choice |
Include | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Slug | text |
Name | text |
Description | text |
Plain description | text |
Availability mode | text |
Continuous | boolean |
Color | text |
Auto accept bookings | boolean |
Timezone | text |
Quantity | number |
Links | object |
Self | text |
Meta | object |
Is available | text |
Booking count | text |
Number available | text |
Minimal service | object |
Service list | text |
Services count | number |
Settings | object |
Meta settings | object |
Zoom | boolean |
Client URL | url |
| Field | Type |
|---|---|
Resource Group IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Local name | text |
Links | object |
Self | text |
Meta | object |
Resources count | number |
| Field | Type |
|---|---|
Schedule IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Title | text |
Start time | text |
Local start time | text |
End time | text |
Local end time | text |
Timezone | text |
Weekday | number |
Quota | number |
Links | object |
Self | url |
| Field | Type |
|---|---|
Schedule Group IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Title | text |
Available from | text |
Available to | text |
Timezone | text |
Preview label | text |
Default | boolean |
Created at | date |
Updated at | date |
Links | object |
Self | text |
Relationships | object |
Schedules | object |
Resources | object |
Resource schedule groups | object |
Meta | object |
Resources count | number |
| Field | Type |
|---|---|
Service IDRequired | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Slug | text |
Description | text |
Hidden | text |
Is rental option | boolean |
Has flexible duration | boolean |
Auto duration | text |
Allow cross schedule | text |
Requires booking description | boolean |
Requires address | boolean |
Links | object |
Self | text |
Meta | object |
Resource list | text |
Min duration total | number |
| Field | Type |
|---|---|
Test IDRequired | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Result options | array |
Auto result | text |
Auto result delay | number |
Certificate body | text |
Certificate footer | text |
Issuing authority | text |
Doctor name | text |
Valid period | number |
Test type options | array |
Links | object |
Self | text |
| Field | Type |
|---|---|
Timslot IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Title | text |
Title i 18n | object |
Description | text |
Description i 18n | object |
Start date | date |
End date | date |
Timezone | text |
Quota | text |
Resource info | array |
Created at | date |
Links | object |
Self | text |
Relationships | object |
Resource | object |
Service | object |
Series | object |
Cover image | object |
Resource allocations | object |
Model syncs | object |
Meta | object |
Provisioned quota | number |
Active booking count | number |
Pending booking count | number |
Total booking count | number |
Available provisioned slots | number |
Pending capacity | number |
Protected | array |
| Field | Type |
|---|---|
Timeslot Resource Allocation IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Status | text |
Capacity multiplier | number |
Order index | number |
Imputed costs | text |
Is externally blocked | boolean |
Is required | boolean |
Provisioned at | text |
Provisioned by booking ID | text |
Visible to customer | boolean |
Created at | date |
Links | object |
Self | text |
Relationships | object |
Resource | object |
Timeslot | object |
| Field | Type |
|---|---|
IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Start date | date |
End date | date |
Created at | date |
Updated at | date |
Links | object |
Self | text |
Relationships | object |
Resource | object |
Timeslots | object |
| Field | Type |
|---|---|
Voucher IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Code | text |
Absolute discount | text |
Currency | text |
Relative discount | text |
Number available | number |
Expires at | date |
Include add ons | boolean |
Description | text |
Created at | date |
Links | object |
Self | text |
Relationships | object |
Resources | object |
Orders | object |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Slug | text |
Name | text |
Official name | text |
Description | text |
Plain description | text |
Support email | text |
Phone | text |
Currency | text |
Timezone | text |
Country code | text |
Links | object |
Self | text |
Relationships | object |
Industry | object |
Addresses | object |
Resources | object |
Cover image | object |
Logo image | object |
Negative logo image | object |
Organization users | object |
Legal documents | object |
Bank accounts | object |
Resource groups | object |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Slug | text |
Name | text |
Official name | text |
Description | text |
Plain description | text |
Support email | text |
Phone | text |
Currency | text |
Timezone | text |
Country code | text |
Links | object |
Self | text |
Relationships | object |
Industry | object |
Addresses | object |
Resources | object |
Cover image | object |
Logo image | object |
Negative logo image | object |
Organization users | object |
Legal documents | object |
Bank accounts | object |
Resource groups | object |
| Field | Type |
|---|---|
Include | choice |
Filter Search | text |
Filter IDs | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Local name i 18n | object |
Created at | date |
Links | object |
Self | text |
Relationships | object |
Add ons | object |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Description | text |
Plain description | text |
Customer notice | text |
Lead time | number |
Is third party | boolean |
Is net price | boolean |
Currency | text |
Tax rate | number |
Price | number |
Links | object |
Self | url |
| Field | Type |
|---|---|
Booking IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Description | text |
Field type | text |
Required | boolean |
Display in checkout | boolean |
Options | array |
Default value | text |
Order index | number |
Custom validation | text |
Links | object |
Self | text |
| Field | Type |
|---|---|
Organization ID | choice |
Filter Start Date Range | choice |
Filter End Date Range | date |
Filter Period Range | date |
Filter Resources | choice |
Filter Resource Groups | choice |
Filter Services | choice |
Filter Status | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Number | text |
Status | text |
Is blocker | boolean |
Start date | date |
End date | date |
Blocker start date | date |
Blocker end date | date |
Description | text |
Charged duration | number |
Weight | number |
Links | object |
Self | text |
Meta | array |
| Field | Type |
|---|---|
IDRequired | choice |
IncludeRequired | choice |
Sort | text |
Fields Users | text |
Fields Customers | text |
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Scan type | text |
Status | text |
Device identifier | text |
Quantity | text |
Meta | array |
Created at | date |
Links | object |
Self | text |
| Field | Type |
|---|---|
IDRequired | choice |
Include Relationships | choice |
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Result | text |
Batch number | text |
Test type | text |
Conducted at | date |
Created at | date |
Updated at | date |
Links | object |
Self | text |
Meta | object |
Certificate URL | url |
Has secret | boolean |
| Field | Type |
|---|---|
Filter Search | text |
Sort | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Scheduled at | text |
Status | text |
Total count | number |
Failed count | number |
Sent count | number |
Recurring | boolean |
Cron | text |
Created at | date |
Links | object |
Self | text |
Relationships | object |
Template | object |
Audience | object |
| Field | Type |
|---|---|
Sort | choice |
Filter by UUIDs | choice |
Exclude UUIDs | choice |
Filter by Name | text |
Full-text Search | text |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Brand name | text |
Domain | text |
Billing email | |
Vat ID | text |
Notes | text |
Custom entry map | object |
Created at | date |
Updated at | date |
Meta | object |
Has business account | boolean |
Links | object |
Self | text |
Relationships | object |
Billing address | object |
Logo image | object |
Customers | object |
Custom entries | object |
Customer balances | object |
Payment setup | object |
| Field | Type |
|---|---|
Filter by Name | text |
Filter by Is Private | text |
Filter by Search | text |
Filter by IDs | choice |
Sort | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Slug | text |
Name | text |
Color | text |
Icon | text |
Welcome text | text |
Is private | boolean |
Allow customer requests | boolean |
Allow organization requests | boolean |
Auto join enabled | boolean |
Auto join settings | text |
Links | object |
Self | text |
Relationships | object |
Domains | object |
Logo image | object |
Resources | object |
Resource groups | object |
Services | object |
Organizations | object |
Owner organization | object |
Community accounts | object |
Unpersonalized invite | object |
Booking quotas | object |
Meta | object |
Members count | number |
| Field | Type |
|---|---|
Filter by Email | text |
Filter by Accepted At | date |
Filter by Expiry | date |
Filter by Open | text |
Sort | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Email | text |
Role | text |
Body | text |
Silent | boolean |
Expiry | date |
Accepted at | date |
Start date | date |
End date | date |
Created at | date |
Links | object |
Self | text |
Relationships | object |
Community | object |
Organization | object |
User | object |
| Field | Type |
|---|---|
Sort | choice |
Filter Status | choice |
Filter Balanceable Type | choice |
Filter Balanceable ID | choice |
Filter Currency | text |
Filter Start Date From | date |
Filter Start Date To | date |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Total | number |
Currency | text |
Label | text |
Status | text |
Start date | date |
End date | date |
Issue at | date |
Issued at | date |
Created at | date |
Updated at | date |
Links | object |
Self | text |
Relationships | object |
Balanceable | object |
Customer account | object |
Invoices | object |
Master invoice | object |
Payment setup | object |
| Field | Type |
|---|---|
Customer ID | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Number | text |
Currency | text |
Total | number |
Modification total | number |
Net amount | number |
Tax amount | number |
Discount amount | number |
System fee | number |
Status | text |
Access token | text |
Links | object |
Self | url |
Relationships | object |
Bookings | object |
Customer | object |
Organization | object |
Invoice | object |
Invoice history | object |
Tmp invoice | object |
Last payment | object |
Payments | object |
Voucher | object |
Sub orders | object |
| Field | Type |
|---|---|
Customer IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Number | text |
Currency | text |
Total | number |
Modification total | number |
Net amount | number |
Tax amount | number |
Discount amount | number |
System fee | number |
Status | text |
Access token | text |
Links | object |
Self | text |
Relationships | object |
Bookings | object |
Customer | object |
Organization | object |
Invoice | object |
Invoice history | object |
Tmp invoice | object |
Last payment | object |
Payments | object |
Voucher | object |
Sub orders | object |
| Field | Type |
|---|---|
Sort | choice |
Filter Search | text |
Filter Email | |
Filter Mobile | text |
Filter Community | choice |
Filter Custom Fields | object |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
UUID | text |
Number | text |
Locale | text |
Title | text |
Given name | text |
Family name | text |
Full name | text |
Sex | text |
Birth date | date |
Email | |
Links | object |
Self | text |
Relationships | object |
Address | object |
Delivery address | object |
Business | object |
Custom entries | object |
Orders | object |
Model identifiers | object |
Subscriptions | object |
Communities | object |
Community invites | object |
Document acceptances | object |
Meta | object |
Has account | boolean |
External ID | text |
Idp user ID | text |
| Field | Type |
|---|---|
Filter | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Show description | boolean |
Show customer | boolean |
Show add ons | boolean |
Show sub bookings | boolean |
Show external events | boolean |
Blocker style | text |
Days before | number |
Days after | number |
Locale | text |
Links | object |
Self | text |
Relationships | object |
Resources | object |
Meta | object |
Calendar URL | text |
| Field | Type |
|---|---|
Sort | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Number | text |
Formatted number | text |
Currency | text |
Is cancellation | boolean |
Is credit | boolean |
Has payment | boolean |
Show transfer note | boolean |
Vat number | text |
Notes | text |
Recipient | text |
Links | object |
Self | text |
Relationships | object |
Order | object |
Items | object |
Payments | object |
Organization | object |
| Field | Type |
|---|---|
Sort | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Number | text |
Currency | text |
Total | number |
Modification total | number |
Net amount | number |
Tax amount | number |
Discount amount | number |
System fee | number |
Status | text |
Access token | text |
Links | object |
Self | text |
Relationships | object |
Bookings | object |
Customer | object |
Organization | object |
Invoice | object |
Invoice history | object |
Tmp invoice | object |
Last payment | object |
Payments | object |
Voucher | object |
Sub orders | object |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Label | text |
Icon | text |
Value type | text |
Filterable | boolean |
Private | boolean |
Links | object |
Self | text |
Relationships | object |
Resource properties | object |
Meta | object |
Options | array |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Local name | text |
Links | object |
Self | text |
Meta | object |
Resources count | number |
| Field | Type |
|---|---|
Filter Groups | choice |
Filter Categories | choice |
Sort | text |
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Slug | text |
Name | text |
Description | text |
Plain description | text |
Availability mode | text |
Continuous | boolean |
Color | text |
Auto accept bookings | boolean |
Timezone | text |
Quantity | number |
Links | object |
Self | text |
Meta | object |
Is available | text |
Booking count | text |
Number available | text |
Minimal service | object |
Service list | text |
Services count | number |
Settings | object |
Meta settings | object |
Zoom | boolean |
Client URL | url |
| Field | Type |
|---|---|
Filter with Resource Count | text |
Filter Search | text |
Sort | text |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Title | text |
Available from | text |
Available to | text |
Timezone | text |
Preview label | text |
Default | boolean |
Created at | date |
Updated at | date |
Links | object |
Self | text |
Relationships | object |
Schedules | object |
Resources | object |
Resource schedule groups | object |
Meta | object |
Resources count | number |
| Field | Type |
|---|---|
Filter Is Rental Option | boolean |
Sort | text |
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Slug | text |
Description | text |
Hidden | boolean |
Is rental option | boolean |
Has flexible duration | boolean |
Auto duration | boolean |
Allow cross schedule | boolean |
Requires booking description | boolean |
Requires address | boolean |
Links | object |
Self | text |
Meta | object |
Resource list | text |
Min duration total | number |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Result options | array |
Auto result | text |
Auto result delay | number |
Certificate body | text |
Certificate footer | text |
Issuing authority | text |
Doctor name | text |
Valid period | number |
Test type options | array |
Links | object |
Self | text |
| Field | Type |
|---|---|
Filter by Status | text |
Filter by External Block Status | text |
Filter by Requirement Status | text |
Sort | choice |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Status | text |
Capacity multiplier | number |
Order index | number |
Imputed costs | text |
Is externally blocked | boolean |
Is required | boolean |
Provisioned at | text |
Provisioned by booking ID | text |
Visible to customer | boolean |
Created at | date |
Links | object |
Self | text |
Relationships | object |
Resource | object |
Timeslot | object |
| Field | Type |
|---|---|
Sort | choice |
Filter Start Date | date |
Filter End Date | date |
Filter Upcoming Only | boolean |
Filter Past Only | boolean |
Filter Resources | text |
Filter Resources (Alias) | text |
Filter Resource Groups | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Title | text |
Title i 18n | object |
Description | text |
Descriptaion i 18n | object |
Start date | date |
End date | date |
Timezone | text |
Quota | text |
Resource info | array |
Created at | date |
Links | object |
Self | text |
Relationships | object |
Resource | object |
Service | object |
Series | object |
Cover image | object |
Resource allocations | object |
Model syncs | object |
Meta | object |
Provisioned quota | number |
Active booking count | number |
Pending booking count | number |
Total booking count | number |
Available provisioned slots | number |
Pending capacity | number |
Protected | array |
| Field | Type |
|---|---|
Sort | choice |
Filter Search | text |
Filter Resource | text |
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Start date | date |
End date | date |
Created at | date |
Updated at | date |
Links | object |
Self | text |
Relationships | object |
Resource | object |
Timeslots | object |
| Field | Type |
|---|---|
Limit | number |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Code | text |
Absolute discount | text |
Currency | text |
Relative discount | text |
Number available | number |
Expires at | date |
Include add ons | boolean |
Description | text |
Created at | date |
Links | object |
Self | text |
Relationships | object |
Resources | object |
Orders | object |
Actions
| Field | Type |
|---|---|
Invoice IDRequired | choice |
| Field | Type |
|---|---|
Order IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Number | text |
Currency | text |
Total | number |
Modification total | number |
Net amount | number |
Tax amount | number |
Discount amount | number |
System fee | number |
Status | text |
Access token | text |
Links | object |
Self | text |
Relationships | object |
Bookings | object |
Customer | object |
Organization | object |
Invoice | object |
Invoice history | object |
Tmp invoice | object |
Last payment | object |
Payments | object |
Voucher | object |
Sub orders | object |
| Field | Type |
|---|---|
Invoice IDRequired | choice |
RecipientRequired | text |
| Field | Type |
|---|---|
IDRequired | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Number | text |
Status | text |
Is blocker | boolean |
Start date | date |
End date | date |
Blocker start date | date |
Blocker end date | date |
Description | text |
Charged duration | number |
Weight | number |
Links | object |
Self | text |
Meta | array |
| Field | Type |
|---|---|
IDRequired | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Number | text |
Status | text |
Is blocker | boolean |
Start date | date |
End date | date |
Blocker start date | date |
Blocker end date | date |
Description | text |
Charged duration | number |
Weight | number |
Links | object |
Self | text |
Meta | array |
| Field | Type |
|---|---|
TypeRequired | choice |
AttributesRequired | object |
NameRequired | text |
Billing Email | |
Brand Name | text |
Domain | text |
Notes | text |
VAT ID | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Brand name | text |
Domain | text |
Billing email | |
Vat ID | text |
Notes | text |
Custom entry map | object |
Created at | date |
Updated at | date |
Meta | object |
Has business account | boolean |
Links | object |
Self | text |
Relationships | object |
Billing address | object |
Logo image | object |
Customers | object |
Custom entries | object |
Customer balances | object |
Payment setup | object |
| Field | Type |
|---|---|
Attributes | object |
Locale | text |
Title | text |
Sex | number |
Birth Date | date |
Given Name | text |
Family Name | text |
Email | |
Mobile | text |
Company | text |
Custom Entry Map | object |
Relationships | object |
Meta | array |
Type | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
UUID | text |
Number | text |
Locale | text |
Title | text |
Given name | text |
Family name | text |
Full name | text |
Sex | text |
Birth date | date |
Email | |
Links | object |
Self | text |
Relationships | object |
Address | object |
Delivery address | object |
Business | object |
Custom entries | object |
Orders | object |
Model identifiers | object |
Subscriptions | object |
Communities | object |
Community invites | object |
Document acceptances | object |
Meta | object |
Has account | boolean |
External ID | text |
Idp user ID | text |
| Field | Type |
|---|---|
Attributes | object |
Currency | text |
Customer Notice | text |
Description | text |
Is Net Price | boolean |
Is Third Party | boolean |
Lead Time | number |
Name | text |
Plain Description | text |
Price | number |
Tax Rate | number |
Relationships | text |
Organization ID | choice |
Meta | array |
Type | text |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Description | text |
Plain description | text |
Customer notice | text |
Lead time | number |
Is third party | boolean |
Is net price | boolean |
Currency | text |
Tax rate | number |
Price | number |
Links | object |
Self | url |
| Field | Type |
|---|---|
Attributes | object |
Access Token | text |
Created At | text |
Currency | text |
Due Date | date |
Formatted Number | text |
Has Payment | boolean |
Invoicing Party | text |
Is Cancellation | boolean |
Is Credit | boolean |
Is Processing | boolean |
Organization ID | choice |
Add to BalanceRequired | choice |
Links | object |
Self | url |
Relationships | object |
Items | object |
Order | object |
Organization | object |
Payments | object |
Type | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Number | text |
Formatted number | text |
Currency | text |
Is cancellation | boolean |
Is credit | boolean |
Has payment | boolean |
Show transfer note | boolean |
Vat number | text |
Notes | text |
Recipient | text |
Links | object |
Self | text |
Relationships | object |
Order | object |
Items | object |
Payments | object |
Organization | object |
| Field | Type |
|---|---|
Attributes | object |
CurrencyRequired | text |
StatusRequired | text |
Relationships | object |
Customer | object |
Bookings | object |
Meta | array |
Type | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Number | text |
Currency | text |
Total | number |
Modification total | number |
Net amount | number |
Tax amount | number |
Discount amount | number |
System fee | number |
Status | text |
Access token | text |
Links | object |
Self | text |
Relationships | object |
Bookings | object |
Customer | object |
Organization | object |
Invoice | object |
Invoice history | object |
Tmp invoice | object |
Last payment | object |
Payments | object |
Voucher | object |
Sub orders | object |
| Field | Type |
|---|---|
Attributes | object |
Filterable | text |
Icon | text |
Label | text |
Private | text |
Value Type | text |
Meta | array |
Relationships | object |
Category | object |
Type | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Label | text |
Icon | text |
Value type | text |
Filterable | boolean |
Private | boolean |
Links | object |
Self | text |
Relationships | object |
Resource properties | object |
Meta | object |
Options | array |
| Field | Type |
|---|---|
Timslot IDRequired | choice |
Count | number |
Days | array |
Day | number |
Frequency | choice |
Interval | number |
Month Day | number |
Until | date |
Week Start | text |
| Field | Type |
|---|---|
Attributes | object |
Auto Accept Booking | text |
Available From | text |
Available To | text |
Description | text |
Has Children | text |
Max Booking Quantity | text |
Name | text |
Quantity | text |
Staggered Quantity | text |
Relationships | object |
Category | object |
Group | object |
Type | text |
Meta | array |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Slug | text |
Name | text |
Description | text |
Plain description | text |
Availability mode | text |
Continuous | boolean |
Color | text |
Auto accept bookings | boolean |
Timezone | text |
Quantity | number |
Links | object |
Self | text |
Meta | object |
Is available | text |
Booking count | text |
Number available | text |
Minimal service | object |
Service list | text |
Services count | number |
Settings | object |
Meta settings | object |
Zoom | boolean |
Client URL | url |
| Field | Type |
|---|---|
Type | text |
Attributes | object |
Name | text |
Settings | object |
Relationships | object |
Meta | array |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Local name | text |
Links | object |
Self | text |
Meta | object |
Resources count | number |
| Field | Type |
|---|---|
Attributes | object |
Local End Time | time |
Local Start Time | time |
Quota | text |
Weekday | number |
Meta | array |
Relationships | object |
Organization ID | choice |
Types | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Title | text |
Start time | text |
Local start time | text |
End time | text |
Local end time | text |
Timezone | text |
Weekday | number |
Quota | number |
Links | object |
Self | url |
| Field | Type |
|---|---|
Attributes | object |
Access Code | text |
Advance Booking Period | text |
Allow Customer Notes | text |
Allow More Bookings | text |
Booking Interval | text |
Calculation Interval | text |
Currency | text |
Default Weight | text |
Description | text |
Has Flexible Duration | text |
Type | text |
Meta | array |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Slug | text |
Description | text |
Hidden | text |
Is rental option | boolean |
Has flexible duration | boolean |
Auto duration | text |
Allow cross schedule | text |
Requires booking description | boolean |
Requires address | boolean |
Links | object |
Self | text |
Meta | object |
Resource list | text |
Min duration total | number |
| Field | Type |
|---|---|
Attributes | object |
Name | text |
Display Tester | boolean |
Validate Download | boolean |
Auto Result | text |
Auto Result Delay | number |
Certificate Body | text |
Certificate Footer | text |
Default Test Type | text |
Doctor Name | text |
Issuing Authority | text |
Meta | object |
Relationships | object |
Custom Fields | object |
Organization ID | choice |
Meta | array |
Type | text |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Result options | array |
Auto result | text |
Auto result delay | number |
Certificate body | text |
Certificate footer | text |
Issuing authority | text |
Doctor name | text |
Valid period | number |
Test type options | array |
Links | object |
Self | text |
| Field | Type |
|---|---|
Organization ID | choice |
Attributes | object |
Base Quota | number |
Cancellation Offset Type | text |
Cancellation Offset Value | number |
Description | text |
Description I18N | object |
Dynamic Capacity | boolean |
End Date | date |
Max Dynamic Quota | number |
Min Bookings Count | number |
Quota | number |
Meta | array |
Relationships | object |
Resource | object |
Type | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Title | text |
Title i 18n | object |
Description | text |
Description i 18n | object |
Start date | date |
End date | date |
Timezone | text |
Quota | text |
Resource info | array |
Created at | date |
Links | object |
Self | text |
Relationships | object |
Resource | object |
Service | object |
Series | object |
Cover image | object |
Resource allocations | object |
Model syncs | object |
Meta | object |
Provisioned quota | number |
Active booking count | number |
Pending booking count | number |
Total booking count | number |
Available provisioned slots | number |
Pending capacity | number |
Protected | array |
| Field | Type |
|---|---|
AttributesRequired | object |
NameRequired | text |
Local Name i18n | object |
Relationships | object |
Resource | object |
Meta | array |
Type | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Start date | date |
End date | date |
Created at | date |
Updated at | date |
Links | object |
Self | text |
Relationships | object |
Resource | object |
Timeslots | object |
| Field | Type |
|---|---|
Type | text |
Attributes | object |
Absolute Discount | number |
Code | text |
Currency | text |
Expires At | date |
Include Add Ons | boolean |
Relative Discount | number |
Meta | array |
Relationships | object |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Code | text |
Absolute discount | text |
Currency | text |
Relative discount | text |
Number available | number |
Expires at | date |
Include add ons | boolean |
Description | text |
Created at | date |
Links | object |
Self | text |
Relationships | object |
Resources | object |
Orders | object |
| Field | Type |
|---|---|
Attributes | object |
Quantity | text |
Total | text |
Meta | array |
Relationships | object |
Add On | object |
Booking | object |
Type | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Quantity | number |
Total | number |
Is net total | boolean |
Single total | number |
Charged single total | number |
Charged total | number |
Links | object |
Self | text |
Relationships | object |
Add on | object |
Booking | object |
| Field | Type |
|---|---|
Attributes | object |
Blocker End Date | date |
Blocker Start Date | date |
Currency | text |
Custom Entry Map | object |
Description | text |
End Date | date |
Is Blocker | boolean |
Is Net Total | boolean |
Is Sub Booking | boolean |
Manually Created | boolean |
Meta | object |
Relationships | object |
Order | object |
Resource | object |
Service | object |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Number | text |
Status | text |
Is blocker | boolean |
Start date | date |
End date | date |
Blocker start date | date |
Blocker end date | date |
Description | text |
Charged duration | number |
Weight | number |
Links | object |
Self | text |
Meta | array |
| Field | Type |
|---|---|
Attributes | object |
Blocker Style | text |
Days After | text |
Days Before | text |
Locale | text |
Name | text |
Show Add Ons | text |
Show Customer | text |
Show Description | text |
Show External Events | text |
Show Sub Bookings | text |
Meta | array |
Relationships | object |
Resources | object |
Type | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Show description | boolean |
Show customer | boolean |
Show add ons | boolean |
Show sub bookings | boolean |
Show external events | boolean |
Blocker style | text |
Days before | number |
Days after | number |
Locale | text |
Links | object |
Self | text |
Relationships | object |
Resources | object |
Meta | object |
Calendar URL | text |
| Field | Type |
|---|---|
Attributes | object |
Capacity Multiplier | number |
Imputed Costs | number |
Is Required | boolean |
Order Index | number |
Status | choice |
Visible To Customer | boolean |
Relationships | object |
Resource | object |
Timeslot | object |
Meta | array |
Type | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Status | text |
Capacity multiplier | number |
Order index | number |
Imputed costs | text |
Is externally blocked | boolean |
Is required | boolean |
Provisioned at | text |
Provisioned by booking ID | text |
Visible to customer | boolean |
Created at | date |
Links | object |
Self | text |
Relationships | object |
Resource | object |
Timeslot | object |
| Field | Type |
|---|---|
IDRequired | choice |
Organization ID | choice |
| Field | Type |
|---|---|
Broadcast Campaign IDRequired | choice |
| Field | Type |
|---|---|
Business IDRequired | choice |
| Field | Type |
|---|---|
IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Slug | text |
Name | text |
Color | text |
Icon | text |
Welcome text | text |
Is private | boolean |
Allow customer requests | boolean |
Allow organization requests | boolean |
Auto join enabled | boolean |
Auto join settings | text |
Links | object |
Self | text |
Relationships | object |
Domains | object |
Logo image | object |
Resources | object |
Resource groups | object |
Services | object |
Organizations | object |
Owner organization | object |
Community accounts | object |
Unpersonalized invite | object |
Booking quotas | object |
Meta | object |
Members count | number |
| Field | Type |
|---|---|
Customer IDRequired | choice |
| Field | Type |
|---|---|
Customer Balance UUIDRequired | choice |
| Field | Type |
|---|---|
Add-on IDRequired | choice |
| Field | Type |
|---|---|
Add-on Group IDRequired | choice |
| Field | Type |
|---|---|
ISC Calendar IDRequired | choice |
| Field | Type |
|---|---|
Image IDRequired | choice |
| Field | Type |
|---|---|
Invoice IDRequired | choice |
| Field | Type |
|---|---|
Order IDRequired | choice |
| Field | Type |
|---|---|
Property IDRequired | choice |
| Field | Type |
|---|---|
Resource IDRequired | choice |
| Field | Type |
|---|---|
Resource Group IDRequired | choice |
| Field | Type |
|---|---|
Schedule IDRequired | choice |
| Field | Type |
|---|---|
Service IDRequired | choice |
| Field | Type |
|---|---|
Test IDRequired | choice |
| Field | Type |
|---|---|
Timslot IDRequired | choice |
| Field | Type |
|---|---|
Timeslot Resource Allocation IDRequired | choice |
| Field | Type |
|---|---|
IDRequired | choice |
| Field | Type |
|---|---|
Voucher IDRequired | choice |
| Field | Type |
|---|---|
IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Slug | text |
Name | text |
Color | text |
Icon | text |
Welcome text | text |
Is private | boolean |
Allow customer requests | boolean |
Allow organization requests | boolean |
Auto join enabled | boolean |
Auto join settings | text |
Links | object |
Self | text |
Relationships | object |
Domains | object |
Logo image | object |
Resources | object |
Resource groups | object |
Services | object |
Organizations | object |
Owner organization | object |
Community accounts | object |
Unpersonalized invite | object |
Booking quotas | object |
Meta | object |
Members count | number |
| Field | Type |
|---|---|
Service IDRequired | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Slug | text |
Description | text |
Hidden | text |
Is rental option | boolean |
Has flexible duration | boolean |
Auto duration | text |
Allow cross schedule | text |
Requires booking description | boolean |
Requires address | boolean |
Links | object |
Self | text |
Meta | object |
Resource list | text |
Min duration total | number |
| Field | Type |
|---|---|
MethodRequired | choice |
Headers | array |
Header | object |
Query String | array |
Parameter | object |
Body | text |
| Field | Type |
|---|---|
Body | text |
Headers | object |
Status code | number |
| Field | Type |
|---|---|
Send Notification | boolean |
| Field | Type |
|---|---|
Source Customer UUIDRequired | choice |
Target Customer UUIDRequired | choice |
| Field | Type |
|---|---|
Invoice IDRequired | choice |
Balanceable IDRequired | choice |
Balanceable TypeRequired | choice |
Issued At | date |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Number | text |
Formatted number | text |
Currency | text |
Is cancellation | boolean |
Is credit | boolean |
Has payment | boolean |
Show transfer note | boolean |
Vat number | text |
Notes | text |
Recipient | text |
Links | object |
Self | text |
Relationships | object |
Order | object |
Items | object |
Payments | object |
Organization | object |
| Field | Type |
|---|---|
End DateRequired | date |
Start DateRequired | date |
TimezoneRequired | time |
Count | number |
Days | array |
Day | number |
Frequency | choice |
Interval | number |
Month Day | number |
| Field | Type |
|---|---|
Start date | date |
End date | date |
| Field | Type |
|---|---|
IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Slug | text |
Name | text |
Color | text |
Icon | text |
Welcome text | text |
Is private | boolean |
Allow customer requests | boolean |
Allow organization requests | boolean |
Auto join enabled | boolean |
Auto join settings | text |
Links | object |
Self | text |
Relationships | object |
Domains | object |
Logo image | object |
Resources | object |
Resource groups | object |
Services | object |
Organizations | object |
Owner organization | object |
Community accounts | object |
Unpersonalized invite | object |
Booking quotas | object |
Meta | object |
Members count | number |
| Field | Type |
|---|---|
Order IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Number | text |
Currency | text |
Total | number |
Modification total | number |
Net amount | number |
Tax amount | number |
Discount amount | number |
System fee | number |
Status | text |
Access token | text |
Links | object |
Self | text |
Relationships | object |
Bookings | object |
Customer | object |
Organization | object |
Invoice | object |
Invoice history | object |
Tmp invoice | object |
Last payment | object |
Payments | object |
Voucher | object |
Sub orders | object |
| Field | Type |
|---|---|
Invoice IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Number | text |
Formatted number | text |
Currency | text |
Is cancellation | boolean |
Is credit | boolean |
Has payment | boolean |
Show transfer note | boolean |
Vat number | text |
Notes | text |
Recipient | text |
Links | object |
Self | text |
Relationships | object |
Order | object |
Items | object |
Payments | object |
Organization | object |
| Field | Type |
|---|---|
Broadcast Campaign IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Scheduled at | text |
Status | text |
Total count | number |
Failed count | number |
Sent count | number |
Recurring | boolean |
Cron | text |
Created at | date |
Links | object |
Self | text |
Relationships | object |
Template | object |
Audience | object |
| Field | Type |
|---|---|
Broadcast Campaign IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Scheduled at | text |
Status | text |
Total count | number |
Failed count | number |
Sent count | number |
Recurring | boolean |
Cron | text |
Created at | date |
Links | object |
Self | text |
Relationships | object |
Template | object |
Audience | object |
| Field | Type |
|---|---|
IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Slug | text |
Name | text |
Color | text |
Icon | text |
Welcome text | text |
Is private | boolean |
Allow customer requests | boolean |
Allow organization requests | boolean |
Auto join enabled | boolean |
Auto join settings | text |
Links | object |
Self | text |
Relationships | object |
Domains | object |
Logo image | object |
Resources | object |
Resource groups | object |
Services | object |
Organizations | object |
Owner organization | object |
Community accounts | object |
Unpersonalized invite | object |
Booking quotas | object |
Meta | object |
Members count | number |
| Field | Type |
|---|---|
IDRequired | choice |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Slug | text |
Name | text |
Color | text |
Icon | text |
Welcome text | text |
Is private | boolean |
Allow customer requests | boolean |
Allow organization requests | boolean |
Auto join enabled | boolean |
Auto join settings | text |
Links | object |
Self | text |
Relationships | object |
Domains | object |
Logo image | object |
Resources | object |
Resource groups | object |
Services | object |
Organizations | object |
Owner organization | object |
Community accounts | object |
Unpersonalized invite | object |
Booking quotas | object |
Meta | object |
Members count | number |
| Field | Type |
|---|---|
IDRequired | choice |
Attributes | object |
Blocker End Date | date |
Blocker Start Date | date |
Can Edit | boolean |
Canceled At | date |
Charged Duration | number |
Charged Subtotal | number |
Charged Total | number |
Check In Date | date |
Check Out Date | date |
Code | text |
Links | object |
Self | url |
Relationships | object |
Access Control Grants | object |
Activities | object |
Attendees | object |
Booking Add Ons | array |
Booking Participants | array |
Booking Series | object |
Cancellation Policy | object |
Custom Entries | array |
Customer | object |
Delegated By | object |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Number | text |
Status | text |
Is blocker | boolean |
Start date | date |
End date | date |
Blocker start date | date |
Blocker end date | date |
Description | text |
Charged duration | number |
Weight | number |
Links | object |
Self | text |
Meta | array |
| Field | Type |
|---|---|
Business IDRequired | choice |
TypeRequired | choice |
AttributesRequired | object |
NameRequired | text |
Billing Email | |
Brand Name | text |
Domain | text |
Notes | text |
VAT ID | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Brand name | text |
Domain | text |
Billing email | |
Vat ID | text |
Notes | text |
Custom entry map | object |
Created at | date |
Updated at | date |
Meta | object |
Has business account | boolean |
Links | object |
Self | text |
Relationships | object |
Billing address | object |
Logo image | object |
Customers | object |
Custom entries | object |
Customer balances | object |
Payment setup | object |
| Field | Type |
|---|---|
Customer IDRequired | choice |
Attributes | object |
Locale | text |
Title | text |
Sex | number |
Birth Date | date |
Given Name | text |
Family Name | text |
Email | |
Mobile | text |
Company | text |
Custom Entry Map | object |
Relationships | object |
Meta | array |
Type | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
UUID | text |
Number | text |
Locale | text |
Title | text |
Given name | text |
Family name | text |
Full name | text |
Sex | text |
Birth date | date |
Email | |
Links | object |
Self | text |
Relationships | object |
Address | object |
Delivery address | object |
Business | object |
Custom entries | object |
Orders | object |
Model identifiers | object |
Subscriptions | object |
Communities | object |
Community invites | object |
Document acceptances | object |
Meta | object |
Has account | boolean |
External ID | text |
Idp user ID | text |
| Field | Type |
|---|---|
Customer Balance UUIDRequired | choice |
TypeRequired | choice |
Attributes | object |
Status | choice |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Slug | text |
Description | text |
Hidden | text |
Is rental option | boolean |
Has flexible duration | boolean |
Auto duration | text |
Allow cross schedule | text |
Requires booking description | boolean |
Requires address | boolean |
Links | object |
Self | text |
Meta | object |
Resource list | text |
Min duration total | number |
| Field | Type |
|---|---|
Add-on IDRequired | choice |
Attributes | object |
Currency | text |
Customer Notice | text |
Description | text |
Is Net Price | boolean |
Is Third Party | boolean |
Lead Time | number |
Name | text |
Plain Description | text |
Price | number |
Tax Rate | number |
Relationships | text |
Meta | array |
Type | text |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Description | text |
Plain description | text |
Customer notice | text |
Lead time | number |
Is third party | boolean |
Is net price | boolean |
Currency | text |
Tax rate | number |
Price | number |
Links | object |
Self | url |
| Field | Type |
|---|---|
Image IDRequired | choice |
FileRequired | text |
File NameRequired | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
URL | text |
Copyright | text |
Width | number |
Height | number |
Order index | number |
Small path | text |
Medium path | text |
Large path | text |
Thumbnail URL | text |
Mime type | text |
Links | object |
Self | text |
| Field | Type |
|---|---|
Invoice IDRequired | choice |
Attributes | object |
Access Token | text |
Created At | text |
Currency | text |
Due Date | date |
Formatted Number | text |
Has Payment | boolean |
Invoicing Party | text |
Is Cancellation | boolean |
Is Credit | boolean |
Is Processing | boolean |
Links | object |
Self | url |
Relationships | object |
Items | object |
Order | object |
Organization | object |
Payments | object |
Type | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Number | text |
Formatted number | text |
Currency | text |
Is cancellation | boolean |
Is credit | boolean |
Has payment | boolean |
Show transfer note | boolean |
Vat number | text |
Notes | text |
Recipient | text |
Links | object |
Self | text |
Relationships | object |
Order | object |
Items | object |
Payments | object |
Organization | object |
| Field | Type |
|---|---|
Order IDRequired | choice |
Attributes | object |
Currency | text |
Status | text |
Relationships | object |
Customer | object |
Bookings | object |
Meta | array |
Type | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Number | text |
Currency | text |
Total | number |
Modification total | number |
Net amount | number |
Tax amount | number |
Discount amount | number |
System fee | number |
Status | text |
Access token | text |
Links | object |
Self | text |
Relationships | object |
Bookings | object |
Customer | object |
Organization | object |
Invoice | object |
Invoice history | object |
Tmp invoice | object |
Last payment | object |
Payments | object |
Voucher | object |
Sub orders | object |
| Field | Type |
|---|---|
Property IDRequired | choice |
Attributes | object |
Filterable | text |
Icon | text |
Label | text |
Private | text |
Value Type | text |
Meta | array |
Relationships | object |
Category | object |
Type | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Label | text |
Icon | text |
Value type | text |
Filterable | boolean |
Private | boolean |
Links | object |
Self | text |
Relationships | object |
Resource properties | object |
Meta | object |
Options | array |
| Field | Type |
|---|---|
Resource IDRequired | choice |
Attributes | object |
Archived | boolean |
Availability Mode | text |
Bookings Enabled | boolean |
Color | text |
Color Map | object |
Created At | text |
Description | text |
Display Public Description | boolean |
Email | |
Email Info | text |
Links | object |
Self | url |
Meta | object |
Minimal Service | object |
Relationships | object |
Category | object |
Children | object |
Communities | object |
Cover Image | object |
External Calendars | object |
Featured Properties | object |
Files | object |
Gallery Images | object |
Location | object |
Logo Image | object |
Type | text |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Slug | text |
Name | text |
Description | text |
Plain description | text |
Availability mode | text |
Continuous | boolean |
Color | text |
Auto accept bookings | boolean |
Timezone | text |
Quantity | number |
Links | object |
Self | text |
Meta | object |
Is available | text |
Booking count | text |
Number available | text |
Minimal service | object |
Service list | text |
Services count | number |
Settings | object |
Meta settings | object |
Zoom | boolean |
Client URL | url |
| Field | Type |
|---|---|
Resource Group IDRequired | choice |
Type | text |
Attributes | object |
Name | text |
Settings | object |
Relationships | object |
Meta | array |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Local name | text |
Links | object |
Self | text |
Meta | object |
Resources count | number |
| Field | Type |
|---|---|
Schedule IDRequired | text |
Attributes | object |
Local End Time | time |
Local Start Time | time |
Quota | text |
Weekday | number |
Meta | array |
Relationships | object |
Types | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Title | text |
Start time | text |
Local start time | text |
End time | text |
Local end time | text |
Timezone | text |
Weekday | number |
Quota | number |
Links | object |
Self | url |
| Field | Type |
|---|---|
Service IDRequired | choice |
Service IDRequired | choice |
Attributes | object |
Access Code | text |
Advance Booking Period | text |
Allow Customer Notes | text |
Allow More Bookings | text |
Booking Interval | text |
Calculation Interval | text |
Currency | text |
Default Weight | text |
Description | text |
Has Flexible Duration | text |
Type | text |
Meta | array |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Slug | text |
Description | text |
Hidden | text |
Is rental option | boolean |
Has flexible duration | boolean |
Auto duration | text |
Allow cross schedule | text |
Requires booking description | boolean |
Requires address | boolean |
Links | object |
Self | text |
Meta | object |
Resource list | text |
Min duration total | number |
| Field | Type |
|---|---|
Test IDRequired | choice |
Attributes | object |
Name | text |
Display Tester | boolean |
Validate Download | boolean |
Auto Result | text |
Auto Result Delay | number |
Certificate Body | text |
Certificate Footer | text |
Default Test Type | text |
Doctor Name | text |
Issuing Authority | text |
Meta | object |
Relationships | object |
Custom Fields | object |
Meta | array |
Type | text |
| Field | Type |
|---|---|
Type | text |
ID | text |
Attributes | object |
Name | text |
Result options | array |
Auto result | text |
Auto result delay | number |
Certificate body | text |
Certificate footer | text |
Issuing authority | text |
Doctor name | text |
Valid period | number |
Test type options | array |
Links | object |
Self | text |
| Field | Type |
|---|---|
Timslot IDRequired | choice |
Include | choice |
Sync Bookings | choice |
Status Reason | text |
Send Notification | choice |
Lock Invoice | choice |
Attributes | object |
Base Quota | number |
Cancellation Offset Type | text |
Cancellation Offset Value | number |
Description | text |
Description I18N | object |
Dynamic Capacity | boolean |
End Date | date |
Max Dynamic Quota | number |
Min Bookings Count | number |
Quota | number |
Meta | array |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Title | text |
Title i 18n | object |
Description | text |
Description i 18n | object |
Start date | date |
End date | date |
Timezone | text |
Quota | text |
Resource info | array |
Created at | date |
Links | object |
Self | text |
Relationships | object |
Resource | object |
Service | object |
Series | object |
Cover image | object |
Resource allocations | object |
Model syncs | object |
Meta | object |
Provisioned quota | number |
Active booking count | number |
Pending booking count | number |
Total booking count | number |
Available provisioned slots | number |
Pending capacity | number |
Protected | array |
| Field | Type |
|---|---|
Timeslot Resource Allocation IDRequired | choice |
Attributes | object |
Capacity Multiplier | number |
Imputed Costs | number |
Is Required | boolean |
Order Index | number |
Status | choice |
Visible To Customer | boolean |
Relationships | object |
Resource | object |
Timeslot | object |
Meta | array |
Type | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Status | text |
Capacity multiplier | number |
Order index | number |
Imputed costs | text |
Is externally blocked | boolean |
Is required | boolean |
Provisioned at | text |
Provisioned by booking ID | text |
Visible to customer | boolean |
Created at | date |
Links | object |
Self | text |
Relationships | object |
Resource | object |
Timeslot | object |
| Field | Type |
|---|---|
IDRequired | choice |
AttributesRequired | object |
NameRequired | text |
Local Name i18n | object |
Relationships | object |
Resource | object |
Meta | array |
Type | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Start date | date |
End date | date |
Created at | date |
Updated at | date |
Links | object |
Self | text |
Relationships | object |
Resource | object |
Timeslots | object |
| Field | Type |
|---|---|
Voucher IDRequired | choice |
Type | text |
Attributes | object |
Absolute Discount | number |
Code | text |
Currency | text |
Expires At | date |
Include Add Ons | boolean |
Relative Discount | number |
Meta | array |
Relationships | object |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Code | text |
Absolute discount | text |
Currency | text |
Relative discount | text |
Number available | number |
Expires at | date |
Include add ons | boolean |
Description | text |
Created at | date |
Links | object |
Self | text |
Relationships | object |
Resources | object |
Orders | object |
| Field | Type |
|---|---|
ISC Calendar IDRequired | choice |
Attributes | object |
Blocker Style | text |
Days After | text |
Days Before | text |
Locale | text |
Name | text |
Show Add Ons | text |
Show Customer | text |
Show Description | text |
Show External Events | text |
Show Sub Bookings | text |
Meta | array |
Relationships | object |
Resources | object |
Type | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
Name | text |
Show description | boolean |
Show customer | boolean |
Show add ons | boolean |
Show sub bookings | boolean |
Show external events | boolean |
Blocker style | text |
Days before | number |
Days after | number |
Locale | text |
Links | object |
Self | text |
Relationships | object |
Resources | object |
Meta | object |
Calendar URL | text |
| Field | Type |
|---|---|
FileRequired | text |
File NameRequired | text |
| Field | Type |
|---|---|
ID | text |
Type | text |
Attributes | object |
URL | text |
Copyright | text |
Width | number |
Height | number |
Order index | number |
Small path | text |
Medium path | text |
Large path | text |
Thumbnail URL | text |
Mime type | text |
Links | object |
Self | text |



