TidyCal
App · 19 actions
Work with your TidyCal scheduling: find free times and book them, list and cancel bookings, create booking types, add contacts, see Store sales, and manage teams.
Actions
| Action | What it does |
|---|---|
| Add contact | Add a contact to TidyCal. |
| Book a time | Book someone into a free time of a booking type, as if they had booked it themselves. |
| Cancel booking | Cancel a booking, optionally saying why. |
| Create booking type | Create a booking type: a kind of meeting with its own booking page, length, notice and price. |
| Create team booking type | Create a booking type for a team, with its own booking page, length, notice and price. |
| Find available times | Find the times still free to book for a booking type, over the next week or between two times you choose. |
| Get account | Get the TidyCal account the connection acts as: name, email, booking page address and language. |
| Get booking | Get one booking: its time, meeting link, who booked, their answers and any payment. |
| Get team | Get one team's name and when it was created. |
| Invite team member | Invite someone to a team. |
| List booking types | List your booking types, the kinds of meeting people can book, with each one's length, price and booking page address. |
| List bookings | List your bookings, booked or canceled, optionally between two dates, with who booked and their answers. |
| List contacts | List your contacts: everyone who has booked with you or was added. |
| List Store orders | List sales from your TidyCal Store, and products bought along with a booking, newest paid first. |
| List team booking types | List a team's booking types. |
| List team bookings | List a team's bookings, optionally between two dates or for one person's email address. |
| List team members | List the people in a team. |
| List teams | List the TidyCal teams you are in. |
| Remove team member | Take someone out of a team. |
Add contact
Add a contact to TidyCal. Needs a TidyCal lifetime plan.
Inputs
- Name
nametextRequired - The contact's full name.
- Email
emailtextRequired - The contact's email address.
- Time zone
time_zonetext - The contact's time zone.
Outputs
contactobject- The new contact
Example output
{
"contact": {
"created_at": "2022-01-01T00:00:00.000000Z",
"email": "john@doe.com",
"id": 1,
"ip_address": "127.0.0.1",
"name": "John Doe",
"phone_number": "+1234567890",
"timezone": "America/New_York",
"updated_at": "2022-01-01T00:00:00.000000Z"
}
}Book a time
Book someone into a free time of a booking type, as if they had booked it themselves. TidyCal emails them the confirmation.
Inputs
- Booking type
booking_type_idtextRequired - The booking type. Pick one, or give its id from an earlier step.
- Start
starts_atdate and timeRequired - When the meeting starts. It must be one of the free times 'Find available times' returns.
- Name
nametextRequired - The full name of the person booking.
- Email
emailtextRequired - The email address of the person booking.
- Time zone
time_zonetextRequired - The person's time zone, used in the times TidyCal emails them.
Outputs
bookingobject- The booking
Example output
{
"booking": {
"add_ons": [],
"booking_type_id": 1,
"cancelled_at": null,
"contact": {
"created_at": "2022-01-01T00:00:00.000000Z",
"email": "john@doe.com",
"id": 1,
"ip_address": "127.0.0.1",
"name": "John Doe",
"phone_number": "+1234567890",
"timezone": "America/New_York",
"updated_at": "2022-01-01T00:00:00.000000Z"
},
"contact_id": 1,
"created_at": "2021-12-20T00:00:00.000000Z",
"ends_at": "2022-01-01T00:15:00.000000Z",
"id": 1,
"meeting_id": "fw44lkj48fks",
"meeting_url": "https://zoom.us/j/949494949494",
"payment": {
"amount": 1,
"booking_id": 1,
"created_at": "2024-01-01T00:00:00.000000Z",
"currency": "USD",
"id": 1,
"payment_id": "pi_1234567890",
"updated_at": "2024-01-01T00:00:00.000000Z"
},
"questions": [
{
"answer": "Blue",
"booking_id": 1,
"created_at": "2024-01-01T00:00:00.000000Z",
"id": 1,
"question": "What is your favorite color?",
"updated_at": "2024-01-01T00:00:00.000000Z"
}
],
"starts_at": "2022-01-01T00:00:00.000000Z",
"timezone": "America/Los_Angeles",
"updated_at": "2021-12-20T00:00:00.000000Z"
}
}Cancel booking
Cancel a booking, optionally saying why.
Inputs
- Booking ID
booking_idtextRequired - The booking's id, from 'List bookings', 'Book a time' or a trigger.
- Reason
reasontext - Why the booking is canceled.
Outputs
bookingobject- The booking
Example output
{
"booking": {
"add_ons": [],
"booking_type_id": 1,
"cancelled_at": "2021-12-21T00:00:00.000000Z",
"contact": {
"created_at": "2022-01-01T00:00:00.000000Z",
"email": "john@doe.com",
"id": 1,
"ip_address": "127.0.0.1",
"name": "John Doe",
"phone_number": "+1234567890",
"timezone": "America/New_York",
"updated_at": "2022-01-01T00:00:00.000000Z"
},
"contact_id": 1,
"created_at": "2021-12-20T00:00:00.000000Z",
"ends_at": "2022-01-01T00:15:00.000000Z",
"id": 1,
"meeting_id": "fw44lkj48fks",
"meeting_url": "https://zoom.us/j/949494949494",
"payment": {
"amount": 1,
"booking_id": 1,
"created_at": "2024-01-01T00:00:00.000000Z",
"currency": "USD",
"id": 1,
"payment_id": "pi_1234567890",
"updated_at": "2024-01-01T00:00:00.000000Z"
},
"questions": [
{
"answer": "Blue",
"booking_id": 1,
"created_at": "2024-01-01T00:00:00.000000Z",
"id": 1,
"question": "What is your favorite color?",
"updated_at": "2024-01-01T00:00:00.000000Z"
}
],
"starts_at": "2022-01-01T00:00:00.000000Z",
"timezone": "America/Los_Angeles",
"updated_at": "2021-12-21T00:00:00.000000Z"
}
}Create booking type
Create a booking type: a kind of meeting with its own booking page, length, notice and price. It uses your usual availability.
Inputs
- Title
titletextRequired - The name people see when booking, such as 30 Minute Meeting.
- Description
descriptiontextRequired - What the meeting is about, shown on the booking page.
- Length (minutes)
duration_minutesnumberRequired - How long each meeting lasts, in minutes.From 1 to 1440.
- Link ending
url_slugtext - The end of the booking page's address, such as 30-minute-meeting. Leave empty to make it from the title.
- Break between meetings (minutes)
padding_minutesnumber - Free time kept after each meeting. TidyCal's default is none.From 0 to 1440.
- Minimum notice (minutes)
booking_threshold_minutesnumber - How soon before a meeting it can still be booked. TidyCal's default is 120 (2 hours); 0 allows last-minute bookings.From 0 to 15000.
- Bookable days ahead
latest_availability_daysnumber - How many days ahead people can book. TidyCal's default is 60.From 0 to 36500.
- People per time
max_bookingsnumber - How many people can book the same time, for group sessions. TidyCal's default is 1.From 1 to 1000.
- Private
privatetrue/false - Hide it from your public booking page, so only people with the link can book.
- Needs approval
approval_requiredtrue/false - You approve each booking before it is confirmed.
- List in TidyCal's directory
list_in_directorytrue/false - Whether it may appear in TidyCal's public directory. TidyCal lists new booking types unless this is turned off.
- Price
pricenumber - What a booking costs, such as 25 or 25.50. Leave empty for free.At least 0.
- Paid through
payment_platformtext - How people pay, when there is a price. It must be connected in TidyCal's Integrations.One of:
stripe,paypal,tidycal(TidyCal Payments). - Currency
currency_codetext - A 3-letter currency code such as USD. Defaults to your account's.
- After booking, go to
redirect_urltext - A web address to send people to once they have booked.
Outputs
booking_typeobject- The booking type
Example output
{
"booking_type": {
"booking_threshold_minutes": 120,
"created_at": "2022-02-01T00:00:00.000000Z",
"currency_code": "USD",
"description": "Book a meeting with me for 15 minutes!",
"disabled_at": null,
"duration_minutes": 15,
"id": 1,
"latest_availability_days": 60,
"max_bookings": 1,
"padding_minutes": 10,
"payment_platform": null,
"payment_platform_id": null,
"price": 0,
"private": false,
"redirect_url": "https://mywebsite.com",
"title": "15 Minute Meeting",
"updated_at": "2022-02-01T00:00:00.000000Z",
"url": "http://tidycal.com/johndoe/15-minute-meeting",
"url_slug": "15-minute-meeting",
"user_id": 1
}
}Create team booking type
Create a booking type for a team, with its own booking page, length, notice and price.
Inputs
- Team
tidycal_team_idtextRequired - The team. Pick one, or give its id from an earlier step.
- Title
titletextRequired - The name people see when booking, such as 30 Minute Meeting.
- Description
descriptiontextRequired - What the meeting is about, shown on the booking page.
- Length (minutes)
duration_minutesnumberRequired - How long each meeting lasts, in minutes.From 1 to 1440.
- Link ending
url_slugtext - The end of the booking page's address, such as 30-minute-meeting. Leave empty to make it from the title.
- Break between meetings (minutes)
padding_minutesnumber - Free time kept after each meeting. TidyCal's default is none.From 0 to 1440.
- Minimum notice (minutes)
booking_threshold_minutesnumber - How soon before a meeting it can still be booked. TidyCal's default is 120 (2 hours); 0 allows last-minute bookings.From 0 to 15000.
- Bookable days ahead
latest_availability_daysnumber - How many days ahead people can book. TidyCal's default is 60.From 0 to 36500.
- People per time
max_bookingsnumber - How many people can book the same time, for group sessions. TidyCal's default is 1.From 1 to 1000.
- Private
privatetrue/false - Hide it from your public booking page, so only people with the link can book.
- Needs approval
approval_requiredtrue/false - You approve each booking before it is confirmed.
- List in TidyCal's directory
list_in_directorytrue/false - Whether it may appear in TidyCal's public directory. TidyCal lists new booking types unless this is turned off.
- Price
pricenumber - What a booking costs, such as 25 or 25.50. Leave empty for free.At least 0.
- Paid through
payment_platformtext - How people pay, when there is a price. It must be connected in TidyCal's Integrations.One of:
stripe,paypal,tidycal(TidyCal Payments). - Currency
currency_codetext - A 3-letter currency code such as USD. Defaults to your account's.
- After booking, go to
redirect_urltext - A web address to send people to once they have booked.
Outputs
booking_typeobject- The booking type
Example output
{
"booking_type": {
"booking_threshold_minutes": 120,
"created_at": "2022-02-01T00:00:00.000000Z",
"currency_code": "USD",
"description": "Book a meeting with me for 15 minutes!",
"disabled_at": null,
"duration_minutes": 15,
"id": 1,
"latest_availability_days": 60,
"max_bookings": 1,
"padding_minutes": 10,
"payment_platform": null,
"payment_platform_id": null,
"price": 0,
"private": false,
"redirect_url": "https://mywebsite.com",
"title": "15 Minute Meeting",
"updated_at": "2022-02-01T00:00:00.000000Z",
"url": "http://tidycal.com/johndoe/15-minute-meeting",
"url_slug": "15-minute-meeting",
"user_id": 1
}
}Find available times
Find the times still free to book for a booking type, over the next week or between two times you choose.
Inputs
- Booking type
booking_type_idtextRequired - The booking type. Pick one, or give its id from an earlier step.
- From
from_timedate and time - Start of the search. Defaults to now.
- Until
until_timedate and time - End of the search. Defaults to a week after its start.
Outputs
countnumber- How many free times
first_starttext- The start of the earliest free time, empty if none
timeslotslist- The free times, start and end in UTC
Example output
{
"count": 1,
"first_start": "2024-03-20T10:00:00.000000Z",
"timeslots": [
{
"available_bookings": 1,
"ends_at": "2024-03-20T10:30:00.000000Z",
"starts_at": "2024-03-20T10:00:00.000000Z"
}
]
}Get account
Get the TidyCal account the connection acts as: name, email, booking page address and language.
Inputs
None.
Outputs
accountobject- The connected account
Example output
{
"account": {
"currency_symbol": "$",
"email": "john@doe.com",
"language": "en",
"lifetime_pro_at": "2022-01-01T00:00:00.000000Z",
"name": "John Doe",
"profile_picture_url": "https://www.gravatar.com/avatar/202446b468bec26847368d8a214b80c9?d=blank&s=200",
"vanity_path": "johndoe"
}
}Get booking
Get one booking: its time, meeting link, who booked, their answers and any payment.
Inputs
- Booking ID
booking_idtextRequired - The booking's id, from 'List bookings', 'Book a time' or a trigger.
Outputs
bookingobject- The booking
Example output
{
"booking": {
"add_ons": [],
"booking_type_id": 1,
"cancelled_at": null,
"contact": {
"created_at": "2022-01-01T00:00:00.000000Z",
"email": "john@doe.com",
"id": 1,
"ip_address": "127.0.0.1",
"name": "John Doe",
"phone_number": "+1234567890",
"timezone": "America/New_York",
"updated_at": "2022-01-01T00:00:00.000000Z"
},
"contact_id": 1,
"created_at": "2021-12-20T00:00:00.000000Z",
"ends_at": "2022-01-01T00:15:00.000000Z",
"id": 1,
"meeting_id": "fw44lkj48fks",
"meeting_url": "https://zoom.us/j/949494949494",
"payment": {
"amount": 1,
"booking_id": 1,
"created_at": "2024-01-01T00:00:00.000000Z",
"currency": "USD",
"id": 1,
"payment_id": "pi_1234567890",
"updated_at": "2024-01-01T00:00:00.000000Z"
},
"questions": [
{
"answer": "Blue",
"booking_id": 1,
"created_at": "2024-01-01T00:00:00.000000Z",
"id": 1,
"question": "What is your favorite color?",
"updated_at": "2024-01-01T00:00:00.000000Z"
}
],
"starts_at": "2022-01-01T00:00:00.000000Z",
"timezone": "America/Los_Angeles",
"updated_at": "2021-12-20T00:00:00.000000Z"
}
}Get team
Get one team's name and when it was created.
Inputs
- Team
tidycal_team_idtextRequired - The team. Pick one, or give its id from an earlier step.
Outputs
teamobject- The team
Example output
{
"team": {
"created_at": "2024-01-01T00:00:00.000000Z",
"id": 1,
"name": "Sales Team",
"updated_at": "2024-01-01T00:00:00.000000Z"
}
}Invite team member
Invite someone to a team. TidyCal emails them the invitation.
Inputs
- Team
tidycal_team_idtextRequired - The team. Pick one, or give its id from an earlier step.
- Email
emailtextRequired - The email address to send the invitation to.
- Role
roletext - What they can do in the team. Defaults to member.One of:
user(Member (default)),admin.
Outputs
emailtext- Who was invited
messagetext- TidyCal's confirmation
team_user_idnumber- The new member's id, for 'Remove team member'
Example output
{
"email": "jo@example.com",
"message": "Invitation sent successfully",
"team_user_id": 123
}List booking types
List your booking types, the kinds of meeting people can book, with each one's length, price and booking page address.
Inputs
None.
Outputs
booking_typeslist- Your booking types
countnumber- How many were returned
has_moretrue/false- True when the list was too long to read in one step; narrow the dates to see the rest
Example output
{
"booking_types": [
{
"booking_threshold_minutes": 120,
"created_at": "2022-02-01T00:00:00.000000Z",
"currency_code": "USD",
"description": "Book a meeting with me for 15 minutes!",
"disabled_at": null,
"duration_minutes": 15,
"id": 1,
"latest_availability_days": 60,
"max_bookings": 1,
"padding_minutes": 10,
"payment_platform": null,
"payment_platform_id": null,
"price": 0,
"private": false,
"redirect_url": "https://mywebsite.com",
"title": "15 Minute Meeting",
"updated_at": "2022-02-01T00:00:00.000000Z",
"url": "http://tidycal.com/johndoe/15-minute-meeting",
"url_slug": "15-minute-meeting",
"user_id": 1
}
],
"count": 1,
"has_more": false
}List bookings
List your bookings, booked or canceled, optionally between two dates, with who booked and their answers.
Inputs
- Show
statustext - Booked meetings, or canceled ones.One of:
booked(Booked (default)),canceled. - From
from_datedate - Only bookings starting on or after this date.
- To
to_datedate - Only bookings ending before this date.
- Include team bookings
include_teamstrue/false - Also list bookings of the teams you are in.
Outputs
bookingslist- The bookings
countnumber- How many were returned
has_moretrue/false- True when the list was too long to read in one step; narrow the dates to see the rest
Example output
{
"bookings": [
{
"add_ons": [],
"booking_type_id": 1,
"cancelled_at": null,
"contact": {
"created_at": "2022-01-01T00:00:00.000000Z",
"email": "john@doe.com",
"id": 1,
"ip_address": "127.0.0.1",
"name": "John Doe",
"phone_number": "+1234567890",
"timezone": "America/New_York",
"updated_at": "2022-01-01T00:00:00.000000Z"
},
"contact_id": 1,
"created_at": "2021-12-20T00:00:00.000000Z",
"ends_at": "2022-01-01T00:15:00.000000Z",
"id": 1,
"meeting_id": "fw44lkj48fks",
"meeting_url": "https://zoom.us/j/949494949494",
"payment": {
"amount": 1,
"booking_id": 1,
"created_at": "2024-01-01T00:00:00.000000Z",
"currency": "USD",
"id": 1,
"payment_id": "pi_1234567890",
"updated_at": "2024-01-01T00:00:00.000000Z"
},
"questions": [
{
"answer": "Blue",
"booking_id": 1,
"created_at": "2024-01-01T00:00:00.000000Z",
"id": 1,
"question": "What is your favorite color?",
"updated_at": "2024-01-01T00:00:00.000000Z"
}
],
"starts_at": "2022-01-01T00:00:00.000000Z",
"timezone": "America/Los_Angeles",
"updated_at": "2021-12-20T00:00:00.000000Z"
}
],
"count": 1,
"has_more": false
}List contacts
List your contacts: everyone who has booked with you or was added.
Inputs
None.
Outputs
contactslist- Your contacts
countnumber- How many were returned
has_moretrue/false- True when the list was too long to read in one step; narrow the dates to see the rest
Example output
{
"contacts": [
{
"created_at": "2022-01-01T00:00:00.000000Z",
"email": "john@doe.com",
"id": 1,
"ip_address": "127.0.0.1",
"name": "John Doe",
"phone_number": "+1234567890",
"timezone": "America/New_York",
"updated_at": "2022-01-01T00:00:00.000000Z"
}
],
"count": 1,
"has_more": false
}List Store orders
List sales from your TidyCal Store, and products bought along with a booking, newest paid first.
Inputs
- Show
statustext - Only orders in this state. Defaults to all.One of:
all(All (default)),completed(Paid),pending,refunded,failed.
Outputs
countnumber- How many were returned
has_moretrue/false- True when the list was too long to read in one step; narrow the dates to see the rest
orderslist- The orders
Example output
{
"count": 1,
"has_more": false,
"orders": [
{
"amount": 25,
"booking_id": null,
"buyer_email": "jane@example.com",
"buyer_name": "Jane Doe",
"completed_at": "2024-01-01T00:00:00.000000Z",
"created_at": "2024-01-01T00:00:00.000000Z",
"currency": "USD",
"download_count": 0,
"formatted_amount": "$25.00",
"id": 1,
"payment_id": "pi_1234567890",
"product": {
"id": 1,
"slug": "workbook-pdf",
"title": "Workbook PDF"
},
"product_id": 1,
"refunded_at": null,
"status": "completed"
}
]
}List team booking types
List a team's booking types.
Inputs
- Team
tidycal_team_idtextRequired - The team. Pick one, or give its id from an earlier step.
Outputs
booking_typeslist- The team's booking types
countnumber- How many were returned
has_moretrue/false- True when the list was too long to read in one step; narrow the dates to see the rest
Example output
{
"booking_types": [
{
"booking_threshold_minutes": 120,
"created_at": "2022-02-01T00:00:00.000000Z",
"currency_code": "USD",
"description": "Book a meeting with me for 15 minutes!",
"disabled_at": null,
"duration_minutes": 15,
"id": 1,
"latest_availability_days": 60,
"max_bookings": 1,
"padding_minutes": 10,
"payment_platform": null,
"payment_platform_id": null,
"price": 0,
"private": false,
"redirect_url": "https://mywebsite.com",
"title": "15 Minute Meeting",
"updated_at": "2022-02-01T00:00:00.000000Z",
"url": "http://tidycal.com/johndoe/15-minute-meeting",
"url_slug": "15-minute-meeting",
"user_id": 1
}
],
"count": 1,
"has_more": false
}List team bookings
List a team's bookings, optionally between two dates or for one person's email address.
Inputs
- Team
tidycal_team_idtextRequired - The team. Pick one, or give its id from an earlier step.
- Show
statustext - Booked meetings, canceled ones, or both.One of:
booked(Booked (default)),canceled,all. - From
from_datedate - Only bookings starting on or after this date.
- To
to_datedate - Only bookings ending before this date.
- Booked by
emailtext - Only bookings made with this email address.
Outputs
bookingslist- The team's bookings
countnumber- How many were returned
has_moretrue/false- True when the list was too long to read in one step; narrow the dates to see the rest
Example output
{
"bookings": [
{
"add_ons": [],
"booking_type_id": 1,
"cancelled_at": null,
"contact": {
"created_at": "2022-01-01T00:00:00.000000Z",
"email": "john@doe.com",
"id": 1,
"ip_address": "127.0.0.1",
"name": "John Doe",
"phone_number": "+1234567890",
"timezone": "America/New_York",
"updated_at": "2022-01-01T00:00:00.000000Z"
},
"contact_id": 1,
"created_at": "2021-12-20T00:00:00.000000Z",
"ends_at": "2022-01-01T00:15:00.000000Z",
"id": 1,
"meeting_id": "fw44lkj48fks",
"meeting_url": "https://zoom.us/j/949494949494",
"payment": {
"amount": 1,
"booking_id": 1,
"created_at": "2024-01-01T00:00:00.000000Z",
"currency": "USD",
"id": 1,
"payment_id": "pi_1234567890",
"updated_at": "2024-01-01T00:00:00.000000Z"
},
"questions": [
{
"answer": "Blue",
"booking_id": 1,
"created_at": "2024-01-01T00:00:00.000000Z",
"id": 1,
"question": "What is your favorite color?",
"updated_at": "2024-01-01T00:00:00.000000Z"
}
],
"starts_at": "2022-01-01T00:00:00.000000Z",
"timezone": "America/Los_Angeles",
"updated_at": "2021-12-20T00:00:00.000000Z"
}
],
"count": 1,
"has_more": false
}List team members
List the people in a team.
Inputs
- Team
tidycal_team_idtextRequired - The team. Pick one, or give its id from an earlier step.
Outputs
countnumber- How many were returned
has_moretrue/false- True when the list was too long to read in one step; narrow the dates to see the rest
memberslist- The team's members
Example output
{
"count": 1,
"has_more": false,
"members": [
{
"created_at": "2024-01-01T00:00:00.000000Z",
"email": "john@doe.com",
"id": 1,
"name": "John Doe",
"updated_at": "2024-01-01T00:00:00.000000Z"
}
]
}List teams
List the TidyCal teams you are in.
Inputs
None.
Outputs
countnumber- How many were returned
has_moretrue/false- True when the list was too long to read in one step; narrow the dates to see the rest
teamslist- Your teams
Example output
{
"count": 1,
"has_more": false,
"teams": [
{
"created_at": "2024-01-01T00:00:00.000000Z",
"id": 1,
"name": "Sales Team",
"updated_at": "2024-01-01T00:00:00.000000Z"
}
]
}Remove team member
Take someone out of a team.
Inputs
- Team
tidycal_team_idtextRequired - The team. Pick one, or give its id from an earlier step.
- Member
team_user_idtextRequired - The person to remove. Pick one, or give the id 'Invite team member' or 'List team members' returned.
Outputs
messagetext- TidyCal's confirmation
removedtrue/false- Always true once removed
team_user_idnumber- Who was removed
Example output
{
"message": "User removed from team",
"removed": true,
"team_user_id": 123
}