- common
- host
- customers
- customer-account-defaults
- default-customer
- frequent-customers
- store
- customers
- default-customer
- frequent-customers
Search Customers
Developing
GET
/customers
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Query Params
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://mock.apidog.com/m1/365924-0-default/customers?limit=&offset=&searchTerm=&searchType=&searchTag=&franchiseIds'Responses
🟢200OK
application/json
Body
Example
{
"data": [
{
"id": 1,
"franchiseId": 1,
"name": "string",
"address": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"phone": "string",
"email": "string",
"billToAccount": {
"id": 0,
"status": "ACTIVE",
"billToAddress": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"balance": 0,
"creditLimit": 0,
"cashOverLimit": false,
"cashOverDays": false,
"ageInDays": 0,
"defaultPayType": "CASH",
"payTypes": [
"CASH"
],
"priceCode": 0,
"taxCode": "string",
"maxDays": 0,
"signatureRequired": false,
"version": 0
},
"shipTo": {
"name": "string",
"address": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"phone": "string",
"email": "string"
},
"version": 0
},
{
"id": 1,
"franchiseId": 1,
"name": "string",
"address": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"phone": "string",
"email": "string",
"billToAccount": {
"id": 0,
"status": "ACTIVE",
"billToAddress": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"balance": 0,
"creditLimit": 0,
"cashOverLimit": false,
"cashOverDays": false,
"ageInDays": 0,
"defaultPayType": "CASH",
"payTypes": [
"CASH"
],
"priceCode": 0,
"taxCode": "string",
"maxDays": 0,
"signatureRequired": false,
"version": 0
},
"shipTo": {
"name": "string",
"address": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"phone": "string",
"email": "string"
},
"version": 0
},
{
"id": 1,
"franchiseId": 1,
"name": "string",
"address": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"phone": "string",
"email": "string",
"billToAccount": {
"id": 0,
"status": "ACTIVE",
"billToAddress": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"balance": 0,
"creditLimit": 0,
"cashOverLimit": false,
"cashOverDays": false,
"ageInDays": 0,
"defaultPayType": "CASH",
"payTypes": [
"CASH"
],
"priceCode": 0,
"taxCode": "string",
"maxDays": 0,
"signatureRequired": false,
"version": 0
},
"shipTo": {
"name": "string",
"address": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"phone": "string",
"email": "string"
},
"version": 0
},
{
"id": 1,
"franchiseId": 1,
"name": "string",
"address": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"phone": "string",
"email": "string",
"billToAccount": {
"id": 0,
"status": "ACTIVE",
"billToAddress": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"balance": 0,
"creditLimit": 0,
"cashOverLimit": false,
"cashOverDays": false,
"ageInDays": 0,
"defaultPayType": "CASH",
"payTypes": [
"CASH"
],
"priceCode": 0,
"taxCode": "string",
"maxDays": 0,
"signatureRequired": false,
"version": 0
},
"shipTo": {
"name": "string",
"address": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"phone": "string",
"email": "string"
},
"version": 0
},
{
"id": 1,
"franchiseId": 1,
"name": "string",
"address": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"phone": "string",
"email": "string",
"billToAccount": {
"id": 0,
"status": "ACTIVE",
"billToAddress": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"balance": 0,
"creditLimit": 0,
"cashOverLimit": false,
"cashOverDays": false,
"ageInDays": 0,
"defaultPayType": "CASH",
"payTypes": [
"CASH"
],
"priceCode": 0,
"taxCode": "string",
"maxDays": 0,
"signatureRequired": false,
"version": 0
},
"shipTo": {
"name": "string",
"address": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"phone": "string",
"email": "string"
},
"version": 0
},
{
"id": 1,
"franchiseId": 1,
"name": "string",
"address": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"phone": "string",
"email": "string",
"billToAccount": {
"id": 0,
"status": "ACTIVE",
"billToAddress": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"balance": 0,
"creditLimit": 0,
"cashOverLimit": false,
"cashOverDays": false,
"ageInDays": 0,
"defaultPayType": "CASH",
"payTypes": [
"CASH"
],
"priceCode": 0,
"taxCode": "string",
"maxDays": 0,
"signatureRequired": false,
"version": 0
},
"shipTo": {
"name": "string",
"address": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"phone": "string",
"email": "string"
},
"version": 0
},
{
"id": 1,
"franchiseId": 1,
"name": "string",
"address": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"phone": "string",
"email": "string",
"billToAccount": {
"id": 0,
"status": "ACTIVE",
"billToAddress": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"balance": 0,
"creditLimit": 0,
"cashOverLimit": false,
"cashOverDays": false,
"ageInDays": 0,
"defaultPayType": "CASH",
"payTypes": [
"CASH"
],
"priceCode": 0,
"taxCode": "string",
"maxDays": 0,
"signatureRequired": false,
"version": 0
},
"shipTo": {
"name": "string",
"address": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"phone": "string",
"email": "string"
},
"version": 0
},
{
"id": 1,
"franchiseId": 1,
"name": "string",
"address": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"phone": "string",
"email": "string",
"billToAccount": {
"id": 0,
"status": "ACTIVE",
"billToAddress": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"balance": 0,
"creditLimit": 0,
"cashOverLimit": false,
"cashOverDays": false,
"ageInDays": 0,
"defaultPayType": "CASH",
"payTypes": [
"CASH"
],
"priceCode": 0,
"taxCode": "string",
"maxDays": 0,
"signatureRequired": false,
"version": 0
},
"shipTo": {
"name": "string",
"address": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"phone": "string",
"email": "string"
},
"version": 0
},
{
"id": 1,
"franchiseId": 1,
"name": "string",
"address": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"phone": "string",
"email": "string",
"billToAccount": {
"id": 0,
"status": "ACTIVE",
"billToAddress": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"balance": 0,
"creditLimit": 0,
"cashOverLimit": false,
"cashOverDays": false,
"ageInDays": 0,
"defaultPayType": "CASH",
"payTypes": [
"CASH"
],
"priceCode": 0,
"taxCode": "string",
"maxDays": 0,
"signatureRequired": false,
"version": 0
},
"shipTo": {
"name": "string",
"address": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"phone": "string",
"email": "string"
},
"version": 0
},
{
"id": 1,
"franchiseId": 1,
"name": "string",
"address": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"phone": "string",
"email": "string",
"billToAccount": {
"id": 0,
"status": "ACTIVE",
"billToAddress": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"balance": 0,
"creditLimit": 0,
"cashOverLimit": false,
"cashOverDays": false,
"ageInDays": 0,
"defaultPayType": "CASH",
"payTypes": [
"CASH"
],
"priceCode": 0,
"taxCode": "string",
"maxDays": 0,
"signatureRequired": false,
"version": 0
},
"shipTo": {
"name": "string",
"address": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"zipCode": "/regex/"
},
"phone": "string",
"email": "string"
},
"version": 0
}
],
"metadata": {
"offset": 0,
"totalCount": 0
}
}🟠400Bad Request
🟠403Forbidden
Modified at 2025-05-08 16:26:07