Skip to main content
GET
/
customers
List Customers
curl --request GET \
  --url https://crm.homele.com/api/v2/crm/customers \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": 42,
      "sequential_number": 1025,
      "name": "Ahmed Ali",
      "first_name": "Ahmed",
      "last_name": "Ali",
      "phone1": "+9647501234567",
      "phone2": "<string>",
      "phone3": "<string>",
      "email1": "ahmed@example.com",
      "address": "Erbil, 60m Street",
      "budget": "150000.00",
      "budget_currency": "USD",
      "expected_sale_date": "2026-06-15",
      "lead_status": {
        "id": 1,
        "name": "New"
      },
      "lead_source": {
        "id": 1,
        "name": "New"
      },
      "owner": {
        "id": 1,
        "name": "New"
      },
      "priority": {
        "id": 1,
        "name": "New"
      },
      "country": {
        "id": 1,
        "name": "New"
      },
      "city": {
        "id": 1,
        "name": "New"
      },
      "created_at": "2025-11-20T14:30:00+00:00",
      "updated_at": "2026-02-15T09:45:00+00:00",
      "last_activity_at": "2026-02-14T16:20:00+00:00"
    }
  ],
  "meta": {
    "per_page": 25,
    "next_cursor": "eyJsYXN0X2FjdGl2aXR5X2F0IjoiMjAyNi0wMi0yMCIsImlkIjo0NDB9",
    "prev_cursor": null,
    "has_more": true
  }
}

Authorizations

Authorization
string
header
required

API token generated from Settings > API Integration. Format: Bearer

Query Parameters

cursor
string

Cursor for the next or previous page, taken from meta.next_cursor or meta.prev_cursor

per_page
integer
default:25

Results per page (max 100)

Required range: x <= 100
filter[query]
string

Search by customer name

filter[lead_status.id][]
integer

Filter by lead status ID

filter[owner.id][]
integer

Filter by owner ID

filter[lead_source.id][]
integer

Filter by lead source ID

filter[priority.id]
integer

Filter by priority ID

filter[date_from]
string<date>

Created after date (YYYY-MM-DD)

filter[date_to]
string<date>

Created before date (YYYY-MM-DD)

Response

Paginated list of customers

success
boolean
Example:

true

data
object[]
meta
object