Contacts

Search contacts

GET /api/v1/contacts

Query parameters

Param	Description
`search`	Search by name or phone number
`tag`	Filter by tag name
`status`	Filter by status (`hot`, `warm`, `active`, `cold`, `new`)
`limit`	Max results (default 20)
`offset`	Pagination offset

Example

curl "https://app.salesbyte.in/api/v1/contacts?search=rahul&tag=Hot+Lead" \
  -H "Authorization: Bearer YOUR_API_KEY"

Create or update a contact

POST /api/v1/contacts

Upserts by phone number — if a contact with that phone already exists, it's updated.

Request body

{
  "name": "Rahul Sharma",
  "phone": "+919876543210",
  "email": "rahul@example.com",
  "company": "Sharma Traders",
  "status": "hot",
  "tags": ["Interested", "Mumbai"]
}

All fields

Field	Type	Description
`phone`	string	✅ Required. With country code.
`name`	string	Full name
`email`	string	Email address
`company`	string	Company name
`status`	string	`hot` / `warm` / `active` / `cold` / `new`
`lifecycle_stage`	string	`lead` / `prospect` / `negotiation` / `customer` / `churned`
`tags`	string[]	Tag names — created if they don't exist
`address_as`	string	How to greet them (e.g. "Rahul Ji")

Get a contact

GET /api/v1/contacts/:id

Returns the full contact record including tags.

Update a contact

PUT /api/v1/contacts/:id

Partial update — only send fields you want to change.

{
  "status": "warm",
  "company": "New Company Name"
}

Archive a contact

DELETE /api/v1/contacts/:id

Soft-deletes the contact (sets is_archived: true). The contact is hidden from the main list but not permanently deleted.

On this page