API Live Demos
Selected Example:
list-appointments
Request Information:
Method:
GET
URL:
/appointments
Query Parameters:
pageSize:
5
start_date:
2024-04-29
end_date:
2025-05-14
filter_by:
updated_at
Headers:
Authorization:
Bearer ***
Accept:
application/json
Content-Type:
application/json
API Response:
{
"data": [
{
"appointment_id": 405715,
"shop_id": "6062",
"customer_id": "2",
"vehicle_id": "3",
"repair_order_id": 0,
"employee_id": 0,
"first_name": "JOHN",
"last_name": "SMITH",
"vehicle": {
"year": "2014",
"make": "NISSAN",
"model": "PATHFINDER"
},
"reason": "BR TEST",
"phone": {
"home": "",
"work": "1112223333",
"cell": "",
"phone_type": ""
},
"hours": 1,
"contact": "",
"column": null,
"done": "no",
"send_reminder": "text",
"email": "",
"source": "shopboss",
"status": "",
"schedule": {
"flag": "incomplete",
"date": "2019-09-13",
"time": "11:30:00"
},
"timestamp": "2017-09-26T16:15:42.000000Z",
"updated_at": null,
"deleted": "no"
},
{
"appointment_id": 431484,
"shop_id": "6062",
"customer_id": "3",
"vehicle_id": "9251993",
"repair_order_id": 0,
"employee_id": 0,
"first_name": "JANE",
"last_name": "DOE",
"vehicle": {
"year": "2011",
"make": "NISSAN",
"model": "PATHFINDER SILVER EDITION 2WD SPORT UTILITY 4-DR"
},
"reason": "Check out why, when locking car via remote does not beep to letting you know it is locked. ",
"phone": {
"home": "2223334444",
"work": "",
"cell": "3334445555",
"phone_type": ""
},
"hours": 0,
"contact": "",
"column": null,
"done": "no",
"send_reminder": "No",
"email": "",
"source": "shopboss",
"status": "",
"schedule": {
"flag": "incomplete",
"date": "2017-10-30",
"time": "07:45:00"
},
"timestamp": "2017-10-28T17:37:07.000000Z",
"updated_at": null,
"deleted": "no"
},
{
"appointment_id": 431487,
"shop_id": "6062",
"customer_id": "4",
"vehicle_id": "9251992",
"repair_order_id": 0,
"employee_id": 0,
"first_name": "ROBERT",
"last_name": "JOHNSON",
"vehicle": {
"year": "1991",
"make": "TOYOTA",
"model": "PICKUP"
},
"reason": "Oil change",
"phone": {
"home": "4445556666",
"work": "",
"cell": "",
"phone_type": ""
},
"hours": 0,
"contact": "",
"column": null,
"done": "no",
"send_reminder": "No",
"email": "",
"source": "shopboss",
"status": "",
"schedule": {
"flag": "incomplete",
"date": "2017-10-30",
"time": "09:00:00"
},
"timestamp": "2017-10-28T17:38:47.000000Z",
"updated_at": null,
"deleted": "no"
},
{
"appointment_id": 431490,
"shop_id": "6062",
"customer_id": "1",
"vehicle_id": "9251987",
"repair_order_id": 0,
"employee_id": 0,
"first_name": "MICHAEL",
"last_name": "WILLIAMS",
"vehicle": {
"year": "2012",
"make": "NISSAN",
"model": "PATHFINDER SILVER EDITION 2WD SPORT UTILITY 4-DR"
},
"reason": "Why is my car trashed?",
"phone": {
"home": "",
"work": "",
"cell": "",
"phone_type": ""
},
"hours": 0,
"contact": "",
"column": null,
"done": "no",
"send_reminder": "No",
"email": "",
"source": "shopboss",
"status": "",
"schedule": {
"flag": "incomplete",
"date": "2017-10-28",
"time": "09:15:00"
},
"timestamp": "2017-10-28T17:40:23.000000Z",
"updated_at": null,
"deleted": "no"
},
{
"appointment_id": 431961,
"shop_id": "6062",
"customer_id": "5",
"vehicle_id": "9251994",
"repair_order_id": 0,
"employee_id": 0,
"first_name": "DAVID",
"last_name": "JONES",
"vehicle": {
"year": "2012",
"make": "NISSAN",
"model": "PATHFINDER LE 2WD SPORT UTILITY 4-DR"
},
"reason": "Test For Mr. Sample",
"phone": {
"home": "",
"work": "",
"cell": "",
"phone_type": ""
},
"hours": 0,
"contact": "",
"column": null,
"done": "no",
"send_reminder": "No",
"email": "",
"source": "shopboss",
"status": "",
"schedule": {
"flag": "incomplete",
"date": "2017-10-30",
"time": "09:15:00"
},
"timestamp": "2017-10-30T14:20:46.000000Z",
"updated_at": null,
"deleted": "no"
}
],
"links": {
"first": "https://dev.shopboss.io/api/v1/appointments?end_date=2025-05-14&filter_by=updated_at&pageSize=5&start_date=2024-04-29&page=1",
"last": "https://dev.shopboss.io/api/v1/appointments?end_date=2025-05-14&filter_by=updated_at&pageSize=5&start_date=2024-04-29&page=93",
"prev": null,
"next": "https://dev.shopboss.io/api/v1/appointments?end_date=2025-05-14&filter_by=updated_at&pageSize=5&start_date=2024-04-29&page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 93,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://dev.shopboss.io/api/v1/appointments?end_date=2025-05-14&filter_by=updated_at&pageSize=5&start_date=2024-04-29&page=1",
"label": "1",
"active": true
},
{
"url": "https://dev.shopboss.io/api/v1/appointments?end_date=2025-05-14&filter_by=updated_at&pageSize=5&start_date=2024-04-29&page=2",
"label": "2",
"active": false
},
{
"url": "https://dev.shopboss.io/api/v1/appointments?end_date=2025-05-14&filter_by=updated_at&pageSize=5&start_date=2024-04-29&page=3",
"label": "3",
"active": false
},
{
"url": "https://dev.shopboss.io/api/v1/appointments?end_date=2025-05-14&filter_by=updated_at&pageSize=5&start_date=2024-04-29&page=4",
"label": "4",
"active": false
},
{
"url": "https://dev.shopboss.io/api/v1/appointments?end_date=2025-05-14&filter_by=updated_at&pageSize=5&start_date=2024-04-29&page=5",
"label": "5",
"active": false
},
{
"url": "https://dev.shopboss.io/api/v1/appointments?end_date=2025-05-14&filter_by=updated_at&pageSize=5&start_date=2024-04-29&page=6",
"label": "6",
"active": false
},
{
"url": "https://dev.shopboss.io/api/v1/appointments?end_date=2025-05-14&filter_by=updated_at&pageSize=5&start_date=2024-04-29&page=7",
"label": "7",
"active": false
},
{
"url": "https://dev.shopboss.io/api/v1/appointments?end_date=2025-05-14&filter_by=updated_at&pageSize=5&start_date=2024-04-29&page=8",
"label": "8",
"active": false
},
{
"url": "https://dev.shopboss.io/api/v1/appointments?end_date=2025-05-14&filter_by=updated_at&pageSize=5&start_date=2024-04-29&page=9",
"label": "9",
"active": false
},
{
"url": "https://dev.shopboss.io/api/v1/appointments?end_date=2025-05-14&filter_by=updated_at&pageSize=5&start_date=2024-04-29&page=10",
"label": "10",
"active": false
},
{
"url": null,
"label": "...",
"active": false
},
{
"url": "https://dev.shopboss.io/api/v1/appointments?end_date=2025-05-14&filter_by=updated_at&pageSize=5&start_date=2024-04-29&page=92",
"label": "92",
"active": false
},
{
"url": "https://dev.shopboss.io/api/v1/appointments?end_date=2025-05-14&filter_by=updated_at&pageSize=5&start_date=2024-04-29&page=93",
"label": "93",
"active": false
},
{
"url": "https://dev.shopboss.io/api/v1/appointments?end_date=2025-05-14&filter_by=updated_at&pageSize=5&start_date=2024-04-29&page=2",
"label": "Next »",
"active": false
}
],
"path": "https://dev.shopboss.io/api/v1/appointments",
"per_page": 5,
"to": 5,
"total": 463
}
}