👥

contacts

Contact entry in an address book or CRM system with personal information, company details, job title, location, notes, and tags. Used for contact management, CRM systems, and address books.

🎯 Request Builder

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

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

Endpoints

GET/contacts

Get a collection of contacts

Alternative: /people/contacts
GET/contacts/:id

Get a single contact by ID

Alternative: /people/contacts/:id
GET/contacts/meta

Get resource metadata and schema

Alternative: /people/contacts/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/contacts?q=laptop

2. Search Specific Fields

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

Python

Fetch with Requests
import requests

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

cURL

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

Bypass Cache

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

Schema Properties

idinteger

Unique identifier for the contact

Gen:random_int
first_namestring

Contact's first name

Gen:first_name
last_namestring

Contact's last name

Gen:last_name
emailstring

Contact's email address

Gen:emailemail
phonestring

Contact's phone number

Gen:phone
companystring

Company or organization the contact works for

Gen:company
job_titlestring

Job title or position of the contact

Gen:job
addressstring

Street address of the contact

Gen:address
citystring

City where the contact is located

Gen:city
countrystring

Country where the contact is located

Gen:country
notesstring

Additional notes or information about the contact

Gen:sentence
tagsarray

Array of tags for categorization (e.g., client, friend, colleague)

Gen:tags
created_atstring

Timestamp when the contact was added

Gen:past_datedate-time

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