💼

clients

Represents a business client or customer organization that engages with a company for services or products. Contains contact information, business details, and relationship status.

🎯 Request Builder

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

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

Endpoints

GET/clients

Get a collection of clients

Alternative: /business/clients
GET/clients/:id

Get a single client by ID

Alternative: /business/clients/:id
GET/clients/meta

Get resource metadata and schema

Alternative: /business/clients/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/clients?q=laptop

2. Search Specific Fields

Field-Specific Search
GET https://api.mockly.codes/clients?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 clients
fetch('https://api.mockly.codes/clients?count=10')
  .then(res => res.json())
  .then(data => console.log(data));

Python

Fetch with Requests
import requests

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

cURL

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

Bypass Cache

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

Schema Properties

idinteger

Unique identifier for the client record

Gen:random_int
namestring

Official company or organization name of the client

Gen:company
contact_personstring

Full name of the primary contact person representing the client

Gen:name
emailstring

Primary business email address for client communications

Gen:emailemail
phonestring

Primary business phone number including country and area codes

Gen:phone
addressstring

Street address and building number of the client's primary business location

Gen:address
citystring

City where the client's primary business is located

Gen:city
countrystring

Country where the client's business operates

Gen:country
industrystring

Primary industry sector or business category the client operates in (e.g., Technology, Healthcare, Finance)

Gen:industry
statusstring

Current relationship status with the client (e.g., active, inactive, prospect, terminated)

Gen:status
contract_valuenumber

Total monetary value of contracts or agreements with this client

Gen:price
sincestring

Date when the business relationship with this client was established

Gen:past_datedate

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