👥

customers

Customer record with personal information, company association, join date, lifetime value, and customer segment. Used for CRM systems, customer management, and business analytics.

🎯 Request Builder

https://api.mockly.codes/customers?page=1&limit=10&count=10
📡

Configure your request and click Send Request to see the response here.

Endpoints

GET/customers

Get a collection of customers

Alternative: /people/customers
GET/customers/:id

Get a single customer by ID

Alternative: /people/customers/:id
GET/customers/meta

Get resource metadata and schema

Alternative: /people/customers/meta
🔍

How to Use Search

The search feature allows you to filter results by searching for text across all or specific fields. Choose between ?q= or ?search= parameter names.

1. Basic Search

Search across all text fields:

Basic Search
GET https://api.mockly.codes/customers?q=laptop

2. Search Specific Fields

Field-Specific Search
GET https://api.mockly.codes/customers?q=laptop&search_fields=name,description

💡 Pro Tips

  • •Search is case-insensitive and performs partial matching
  • •Without search_fields, all text fields are searched
  • •Combine with pagination to handle large result sets efficiently

Code Examples

JavaScript

Fetch Collection
// Get 10 customers
fetch('https://api.mockly.codes/customers?count=10')
  .then(res => res.json())
  .then(data => console.log(data));

Python

Fetch with Requests
import requests

response = requests.get(
    'https://api.mockly.codes/customers?count=10'
)
data = response.json()

cURL

Command Line
curl "https://api.mockly.codes/customers?count=10"

Bypass Cache

Get Fresh Data
fetch('https://api.mockly.codes/customers?nocache=true')

Schema Properties

idinteger

Unique identifier for the customer

Gen:random_int
first_namestring

Customer's first name

Gen:first_name
last_namestring

Customer's last name

Gen:last_name
emailstring

Customer's email address

Gen:emailemail
phonestring

Customer's phone number

Gen:phone
addressstring

Customer's street address

Gen:address
citystring

City where the customer is located

Gen:city
countrystring

Country where the customer is located

Gen:country
companystring

Company or organization the customer represents

Gen:company
joined_datestring

Date when the customer first registered or made their first purchase

Gen:past_datedate-time
lifetime_valuenumber

Total revenue generated from this customer over their lifetime

Gen:price
segmentstring

Customer segment or category (e.g., premium, standard, enterprise)

Gen:word

Query Parameters

countinteger

Number of items to return (default: 10, max: 100)

seedinteger

Seed for reproducible data generation

nocacheboolean

Bypass cache and generate fresh data on every request