ReserveKit API (1.0.0)

API Support: support@reservekit.io URL: https://www.reservekit.io/support Terms of Service

Booking API for developers

Services

Services management endpoints

Get services

Get services by provider ID

Authorizations:

ApiKeyAuth

query Parameters

page required	integer Page
page_size required	integer Page Size

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": {"pagination": {"page": 0,
"page_size": 0,
"total_items": 0,
"total_pages": 0
},
"services": [{"bookings_count": 0,
"created_at": "string",
"description": "string",
"id": 0,
"name": "string",
"provider": {"avatar": "string",
"created_at": "string",
"email": "string",
"id": "string",
"is_verified": true,
"name": "string",
"package": {"bookings_per_month": 0,
"created_at": "string",
"id": 0,
"name": "string",
"overage_price_amount": 0,
"overages_enabled": true,
"price_amount": 0,
"price_currency": "string",
"price_interval": "string",
"rate_limit_per_second": 0,
"requests_per_month": 0,
"services_limit": 0,
"stripe_overage_price_id": "string",
"stripe_price_id": "string",
"updated_at": "string"
},
"package_id": 0,
"phone": "string",
"role": {"description": "string",
"id": 0,
"level": 0,
"name": "string"
},
"role_id": 0,
"stripe_customer_id": "string",
"subscription_status": "string",
"updated_at": "string"
},
"provider_id": "string",
"timezone": "string",
"updated_at": "string",
"version": 0
}
]
},
"error": "string"
}

Create a service

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Create Service Payload

description	string <= 255 characters
name required	string <= 72 characters
	Array of objects (main.CreateTimeSlotPayload)
timezone required	string

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"name": "string",
"time_slots": [{"day_of_week": 6,
"end_time": "string",
"max_bookings": 1,
"start_time": "string"
}
],
"timezone": "string"
}

Response samples

201
400
404
500

Content type

application/json

{"data": {"bookings_count": 0,
"created_at": "string",
"description": "string",
"id": 0,
"name": "string",
"provider": {"avatar": "string",
"created_at": "string",
"email": "string",
"id": "string",
"is_verified": true,
"name": "string",
"package": {"bookings_per_month": 0,
"created_at": "string",
"id": 0,
"name": "string",
"overage_price_amount": 0,
"overages_enabled": true,
"price_amount": 0,
"price_currency": "string",
"price_interval": "string",
"rate_limit_per_second": 0,
"requests_per_month": 0,
"services_limit": 0,
"stripe_overage_price_id": "string",
"stripe_price_id": "string",
"updated_at": "string"
},
"package_id": 0,
"phone": "string",
"role": {"description": "string",
"id": 0,
"level": 0,
"name": "string"
},
"role_id": 0,
"stripe_customer_id": "string",
"subscription_status": "string",
"updated_at": "string"
},
"provider_id": "string",
"timezone": "string",
"updated_at": "string",
"version": 0
},
"error": "string"
}

Get a service

Get a service by ID

Authorizations:

ApiKeyAuth

path Parameters

id

required

integer

Service ID

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": {"bookings_count": 0,
"created_at": "string",
"description": "string",
"id": 0,
"name": "string",
"provider": {"avatar": "string",
"created_at": "string",
"email": "string",
"id": "string",
"is_verified": true,
"name": "string",
"package": {"bookings_per_month": 0,
"created_at": "string",
"id": 0,
"name": "string",
"overage_price_amount": 0,
"overages_enabled": true,
"price_amount": 0,
"price_currency": "string",
"price_interval": "string",
"rate_limit_per_second": 0,
"requests_per_month": 0,
"services_limit": 0,
"stripe_overage_price_id": "string",
"stripe_price_id": "string",
"updated_at": "string"
},
"package_id": 0,
"phone": "string",
"role": {"description": "string",
"id": 0,
"level": 0,
"name": "string"
},
"role_id": 0,
"stripe_customer_id": "string",
"subscription_status": "string",
"updated_at": "string"
},
"provider_id": "string",
"timezone": "string",
"updated_at": "string",
"version": 0
},
"error": "string"
}

Delete a service

Delete a service by ID

Authorizations:

ApiKeyAuth

path Parameters

id

required

integer

Service ID

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": "string",
"error": "string"
}

Update a service

Update a service by ID

Authorizations:

ApiKeyAuth

path Parameters

id

required

integer

Service ID

Request Body schema: application/json
required

Update Service Payload

description	string <= 255 characters
name	string <= 72 characters

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"name": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"data": {"bookings_count": 0,
"created_at": "string",
"description": "string",
"id": 0,
"name": "string",
"provider": {"avatar": "string",
"created_at": "string",
"email": "string",
"id": "string",
"is_verified": true,
"name": "string",
"package": {"bookings_per_month": 0,
"created_at": "string",
"id": 0,
"name": "string",
"overage_price_amount": 0,
"overages_enabled": true,
"price_amount": 0,
"price_currency": "string",
"price_interval": "string",
"rate_limit_per_second": 0,
"requests_per_month": 0,
"services_limit": 0,
"stripe_overage_price_id": "string",
"stripe_price_id": "string",
"updated_at": "string"
},
"package_id": 0,
"phone": "string",
"role": {"description": "string",
"id": 0,
"level": 0,
"name": "string"
},
"role_id": 0,
"stripe_customer_id": "string",
"subscription_status": "string",
"updated_at": "string"
},
"provider_id": "string",
"timezone": "string",
"updated_at": "string",
"version": 0
},
"error": "string"
}

Get time slots

Get time slots by service ID

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

Service ID

query Parameters

page required	integer Page
page_size required	integer Page Size
no_pagination	boolean No Pagination

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": {"pagination": {"page": 0,
"page_size": 0,
"total_items": 0,
"total_pages": 0
},
"time_slots": [{"created_at": "string",
"day_of_week": 0,
"end_time": "string",
"id": 0,
"max_bookings": 0,
"service_id": 0,
"start_time": "string",
"updated_at": "string"
}
]
},
"error": "string"
}

Bookings

Booking management endpoints

Get all bookings for a service

Get all booking for a service by ID

Authorizations:

ApiKeyAuth

query Parameters

service_id required	integer Service ID
page required	integer Page
page_size required	integer Page Size

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": {"bookings": [{"cancel_reason": "string",
"created_at": "string",
"customer": {"created_at": "string",
"email": "string",
"id": 0,
"name": "string",
"phone": "string",
"updated_at": "string"
},
"customer_id": 0,
"date": "string",
"id": 0,
"message": "string",
"service_id": 0,
"status": "string",
"time_slot": {"created_at": "string",
"day_of_week": 0,
"end_time": "string",
"id": 0,
"max_bookings": 0,
"service_id": 0,
"start_time": "string",
"updated_at": "string"
},
"time_slot_id": 0,
"updated_at": "string",
"user_id": "string",
"version": 0
}
],
"pagination": {"page": 0,
"page_size": 0,
"total_items": 0,
"total_pages": 0
}
},
"error": "string"
}

Creates a booking

Authorizations:

ApiKeyAuth

query Parameters

service_id

required

integer

Service ID

Request Body schema: application/json
required

Create Booking Payload

customer_email	string
customer_name	string
customer_phone	string
date required	string
message	string
time_slot_id required	integer

Responses

Request samples

Payload

Content type

application/json

{"customer_email": "string",
"customer_name": "string",
"customer_phone": "string",
"date": "string",
"message": "string",
"time_slot_id": 0
}

Response samples

201
400
404
500

Content type

application/json

{"data": {"cancel_reason": "string",
"created_at": "string",
"customer": {"created_at": "string",
"email": "string",
"id": 0,
"name": "string",
"phone": "string",
"updated_at": "string"
},
"customer_id": 0,
"date": "string",
"id": 0,
"message": "string",
"service_id": 0,
"status": "string",
"time_slot": {"created_at": "string",
"day_of_week": 0,
"end_time": "string",
"id": 0,
"max_bookings": 0,
"service_id": 0,
"start_time": "string",
"updated_at": "string"
},
"time_slot_id": 0,
"updated_at": "string",
"user_id": "string",
"version": 0
},
"error": "string"
}

Get a booking

Get a booking by ID

Authorizations:

ApiKeyAuth

path Parameters

id

required

integer

Booking ID

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": {"cancel_reason": "string",
"created_at": "string",
"customer": {"created_at": "string",
"email": "string",
"id": 0,
"name": "string",
"phone": "string",
"updated_at": "string"
},
"customer_id": 0,
"date": "string",
"id": 0,
"message": "string",
"service_id": 0,
"status": "string",
"time_slot": {"created_at": "string",
"day_of_week": 0,
"end_time": "string",
"id": 0,
"max_bookings": 0,
"service_id": 0,
"start_time": "string",
"updated_at": "string"
},
"time_slot_id": 0,
"updated_at": "string",
"user_id": "string",
"version": 0
},
"error": "string"
}

Delete a booking

Delete a booking by ID

Authorizations:

ApiKeyAuth

path Parameters

id

required

integer

Booking ID

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": { },
"error": "string"
}

Update a booking

Update a booking by ID

Authorizations:

ApiKeyAuth

path Parameters

id

required

integer

Booking ID

Request Body schema: application/json
required

Update Booking Payload

cancel_reason	string
date	string
message	string
status	string Enum: "pending" "confirmed" "cancelled"

Responses

Request samples

Payload

Content type

application/json

{"cancel_reason": "string",
"date": "string",
"message": "string",
"status": "pending"
}

Response samples

200
400
404
500

Content type

application/json

{"data": {"cancel_reason": "string",
"created_at": "string",
"customer": {"created_at": "string",
"email": "string",
"id": 0,
"name": "string",
"phone": "string",
"updated_at": "string"
},
"customer_id": 0,
"date": "string",
"id": 0,
"message": "string",
"service_id": 0,
"status": "string",
"time_slot": {"created_at": "string",
"day_of_week": 0,
"end_time": "string",
"id": 0,
"max_bookings": 0,
"service_id": 0,
"start_time": "string",
"updated_at": "string"
},
"time_slot_id": 0,
"updated_at": "string",
"user_id": "string",
"version": 0
},
"error": "string"
}

Get a booking customer

Get a booking customer by ID

Authorizations:

ApiKeyAuth

path Parameters

id

required

integer

Booking ID

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": {"created_at": "string",
"email": "string",
"id": 0,
"name": "string",
"phone": "string",
"updated_at": "string"
},
"error": "string"
}

Update a booking customer

Update a booking customer by ID

Authorizations:

ApiKeyAuth

path Parameters

id

required

integer

Booking ID

Request Body schema: application/json
required

Update Booking Customer Payload

email	string
name	string
phone	string

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"name": "string",
"phone": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"data": {"created_at": "string",
"email": "string",
"id": 0,
"name": "string",
"phone": "string",
"updated_at": "string"
},
"error": "string"
}

Time Slots

Time slot management endpoints

Get time slots

Get time slots by service ID

Authorizations:

ApiKeyAuth

query Parameters

service_id required	string Service ID
page required	integer Page
page_size required	integer Page Size
no_pagination	boolean No Pagination

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": {"pagination": {"page": 0,
"page_size": 0,
"total_items": 0,
"total_pages": 0
},
"time_slots": [{"created_at": "string",
"day_of_week": 0,
"end_time": "string",
"id": 0,
"max_bookings": 0,
"service_id": 0,
"start_time": "string",
"updated_at": "string"
}
]
},
"error": "string"
}

Delete time slot

Delete time slot by ID

Authorizations:

ApiKeyAuth

path Parameters

timeSlotID

required

string

Time Slot ID

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": "string",
"error": "string"
}

ReserveKit API (1.0.0)

Services

Get services

Authorizations:

query Parameters

Responses

Response samples

Create a service

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get a service

Authorizations:

path Parameters

Responses

Response samples

Delete a service

Authorizations:

path Parameters

Responses

Response samples

Update a service

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get time slots

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Bookings

Get all bookings for a service

Authorizations:

query Parameters

Responses

Response samples

Creates a booking

Authorizations:

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get a booking

Authorizations:

path Parameters

Responses

Response samples

Delete a booking

Authorizations:

path Parameters

Responses

Response samples

Update a booking

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get a booking customer

Authorizations:

path Parameters

Responses

Response samples

Update a booking customer

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Time Slots

Get time slots

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required