API Reference · Endpoints

Contacts

Search the customer records of your workspace store by name, phone or email.

The contacts endpoint returns the customer records held by your workspace's store: the people who placed orders or were synced from a connected e-commerce platform. To read chat threads instead, use Conversations.

List contacts

GET/api/v1/contactsPaginated customers, newest first

Permission: read.

ParameterTypeRequiredDescription
searchstringoptionalPartial match on name, email or phone.
pagenumberoptionalPage number. Default 1.
limitnumberoptionalResults per page. Default 50, max 100.
curl "https://inboxi.app/api/v1/contacts?search=ahmed&limit=10" \
  -H "X-API-Key: inx_live_your_api_key"

Response

json
{
  "success": true,
  "data": [
    {
      "id": 512,
      "name": "Ahmed Ali",
      "email": "ahmed@example.com",
      "phone": "+201012345678",
      "createdAt": "2026-02-11T14:03:00.000Z"
    }
  ],
  "pagination": { "page": 1, "limit": 10, "total": 1, "totalPages": 1 }
}
FieldTypeRequiredDescription
idnumberoptionalCustomer id.
namestringoptionalCustomer name.
emailstringoptionalEmail, if known.
phonestringoptionalPhone as stored by the store.
createdAtstringoptionalWhen the record was created.

Empty results

If your workspace has no store yet, the endpoint returns an empty list with total: 0 rather than an error.

  • Attach your own data (grades, subscriptions, invoices) to a phone number with External data.
  • Get order count and total spend per phone with LTV stats.
  • Managing contacts in the dashboard is covered in Contacts.