API Live Demos
Selected Example:
list-customers
Request Information:
Method:
GET
URL:
/customers
Query Parameters:
pageSize:
5
Headers:
Authorization:
Bearer ***
Accept:
application/json
Content-Type:
application/json
API Response:
{
"data": [
{
"customer_id": 4,
"shop_id": "6062",
"first_name": "JOHN",
"last_name": "SMITH",
"email": "john.smith@example.com",
"address": "123 SAMPLE ST",
"city": "ANYTOWN",
"state": "CALIFORNIA",
"zip": "",
"phone": {
"home": "1112223333",
"work": "",
"cell": ""
},
"service_reminder": "",
"discount_percentage": "",
"contact": "",
"tax_exempt": "no",
"follow": "yes",
"credit_limit": 0,
"extension": "",
"customer_pay_type": "CASH",
"on_hold": "no",
"preferred_contact_method": "TEXT",
"comments": null,
"alerts": null,
"timestamp": "2017-10-26T22:50:33.000000Z",
"updated_at": "2017-10-26T22:50:33.000000Z"
},
{
"customer_id": 6,
"shop_id": "6062",
"first_name": "JANE",
"last_name": "DOE",
"email": "jane.doe@example.com",
"address": "456 TEST AVE",
"city": "SAMPLEVILLE",
"state": "CA",
"zip": "92025",
"phone": {
"home": "",
"work": "",
"cell": ""
},
"service_reminder": "",
"discount_percentage": "",
"contact": "",
"tax_exempt": "no",
"follow": "yes",
"credit_limit": 0,
"extension": "",
"customer_pay_type": "cash",
"on_hold": "no",
"preferred_contact_method": "text",
"comments": null,
"alerts": null,
"timestamp": "2017-11-08T17:51:50.000000Z",
"updated_at": "2017-11-08T17:51:50.000000Z"
},
{
"customer_id": 9,
"shop_id": "6062",
"first_name": "ROBERT",
"last_name": "JOHNSON",
"email": "",
"address": "",
"city": "",
"state": "",
"zip": "",
"phone": {
"home": "",
"work": "",
"cell": ""
},
"service_reminder": "",
"discount_percentage": "",
"contact": "",
"tax_exempt": "no",
"follow": "yes",
"credit_limit": 0,
"extension": "",
"customer_pay_type": "cash",
"on_hold": "no",
"preferred_contact_method": "text",
"comments": null,
"alerts": null,
"timestamp": "2017-11-30T19:37:33.000000Z",
"updated_at": "2017-11-30T19:37:33.000000Z"
},
{
"customer_id": 14,
"shop_id": "6062",
"first_name": "MICHAEL",
"last_name": "BROWN",
"email": "michael.brown@example.com",
"address": "789 DEMO RD",
"city": "TESTTOWN",
"state": "WA",
"zip": "98520",
"phone": {
"home": "5556667777",
"work": "8889990000",
"cell": ""
},
"service_reminder": "",
"discount_percentage": "15",
"contact": "",
"tax_exempt": "yes",
"follow": "yes",
"credit_limit": 0,
"extension": "1234",
"customer_pay_type": "cash",
"on_hold": "no",
"preferred_contact_method": "text",
"comments": null,
"alerts": null,
"timestamp": "2017-12-20T23:20:18.000000Z",
"updated_at": "2025-06-18T20:04:40.000000Z"
},
{
"customer_id": 15,
"shop_id": "6062",
"first_name": "SARAH",
"last_name": "WILSON",
"email": "sarah.wilson@example.com",
"address": "321 PLACEHOLDER BLVD",
"city": "DEMOVILLE",
"state": "WA",
"zip": "98520",
"phone": {
"home": "9998887777",
"work": "6665554444",
"cell": "3332221111"
},
"service_reminder": "",
"discount_percentage": "",
"contact": "",
"tax_exempt": "no",
"follow": "yes",
"credit_limit": 0,
"extension": "1234",
"customer_pay_type": "cash",
"on_hold": "no",
"preferred_contact_method": "text",
"comments": "HELLO",
"alerts": null,
"timestamp": "2017-12-20T23:49:41.000000Z",
"updated_at": "2017-12-20T23:49:41.000000Z"
}
],
"links": {
"first": "https://dev.shopboss.io/api/v1/customers?pageSize=5&page=1",
"last": "https://dev.shopboss.io/api/v1/customers?pageSize=5&page=34",
"prev": null,
"next": "https://dev.shopboss.io/api/v1/customers?pageSize=5&page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 34,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://dev.shopboss.io/api/v1/customers?pageSize=5&page=1",
"label": "1",
"active": true
},
{
"url": "https://dev.shopboss.io/api/v1/customers?pageSize=5&page=2",
"label": "2",
"active": false
},
{
"url": "https://dev.shopboss.io/api/v1/customers?pageSize=5&page=3",
"label": "3",
"active": false
},
{
"url": "https://dev.shopboss.io/api/v1/customers?pageSize=5&page=4",
"label": "4",
"active": false
},
{
"url": "https://dev.shopboss.io/api/v1/customers?pageSize=5&page=5",
"label": "5",
"active": false
},
{
"url": "https://dev.shopboss.io/api/v1/customers?pageSize=5&page=6",
"label": "6",
"active": false
},
{
"url": "https://dev.shopboss.io/api/v1/customers?pageSize=5&page=7",
"label": "7",
"active": false
},
{
"url": "https://dev.shopboss.io/api/v1/customers?pageSize=5&page=8",
"label": "8",
"active": false
},
{
"url": "https://dev.shopboss.io/api/v1/customers?pageSize=5&page=9",
"label": "9",
"active": false
},
{
"url": "https://dev.shopboss.io/api/v1/customers?pageSize=5&page=10",
"label": "10",
"active": false
},
{
"url": null,
"label": "...",
"active": false
},
{
"url": "https://dev.shopboss.io/api/v1/customers?pageSize=5&page=33",
"label": "33",
"active": false
},
{
"url": "https://dev.shopboss.io/api/v1/customers?pageSize=5&page=34",
"label": "34",
"active": false
},
{
"url": "https://dev.shopboss.io/api/v1/customers?pageSize=5&page=2",
"label": "Next »",
"active": false
}
],
"path": "https://dev.shopboss.io/api/v1/customers",
"per_page": 5,
"to": 5,
"total": 168
}
}