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": [
- {
- "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",
- "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": {
- "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",
- "updated_at": "string",
- "version": 0
}, - "error": "string"
}
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": [
- {
- "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,
- "service_id": 0,
- "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
Creates a booking
Authorizations:
ApiKeyAuth
query Parameters
service_id required | integer Service ID |
Request Body schema: application/jsonrequired
Create Booking Payload
customer_email | string |
customer_name | string |
customer_phone | string |
date required | 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",
- "time_slot_id": 0
}
Response samples
- 201
- 400
- 404
- 500
Content type
application/json
{- "data": {
- "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,
- "service_id": 0,
- "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": {
- "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,
- "service_id": 0,
- "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 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"
}