v1

latestOpenAPI 3.1.02026-07-2438302.6 MB

Get all Customers

get/customers

Query parameters

pageinteger

Page number

countinteger

Maximum allowed 1000

sort'DESC' | 'ASC'

sort_by'customer_first_name' | 'customer_last_name' | 'no_of_jobs' | 'created_at'

filter.keywordstring

Used for search

filter.citystring

Filter based on city

filter.zipcodestring

Filter based on Zipcode

filter.categorystring

Filter based on customer category

filter.customer_tagsstring

Filter based on customer tags

filter.from_datestring

Filter based on created date (greater than or equal to)

filter.to_datestring

Filter based on created date (lesser than or equal to)

filter.from_no_of_jobsstring

Filter based on number of jobs (greater than or equal to)

filter.to_no_of_jobsstring

Filter based on number of jobs (lesser than or equal to)

filter.is_activestring

Filter based on active status

filter.account_managerstring

Filter based on account manager

filter.created_bystring

Filter based on created user

filter.updated_atstring

Filter based on updated date

filter.updated_at_fromstring

Filter based on updated date (greater than or equal to)

filter.updated_at_tostring

Filter based on updated date (lesser than or equal to)

filter.custom_fieldstring

Filter based on custom fields

filter.ltv_fromstring

Filter based on ltv from

filter.ltv_tostring

Filter based on ltv to

filter.credit_fromstring

Filter based on credit from

filter.credit_tostring

Filter based on credit to

filter.receivable_fromstring

Filter based on receivable from

filter.receivable_tostring

Filter based on receivable to

filter.customer_uidstring

Filter based on customer uid

filter.customer_emailstring

Filter based on customer email

filter.customer_organizationstring

Filter based on customer organization

filter.has_orgstring

Filter based on, if or not customer has organization

filter.has_card_on_filestring

Filter based on, if or not customer has card on file

filter.is_deletedstring

Filter based to get the deleted customers

filter.is_portal_enabledstring

Filter based on customer portal

filter.do_not_serviceboolean

Request body

RAW_BODYstring

Response

200

typestring

total_recordsinteger

current_pageinteger

total_pagesinteger

Example response

{
  "type": "success",
  "data": [
    {
      "customer_uid": "e6b11af9-3c09-4459-9331-1384da339391",
      "customer_first_name": "Dev",
      "customer_last_name": "George",
      "customer_category": {
        "category_uid": "f73a3587-a8f2-4311-a825-2308cabcd132",
        "category_name": "Commercial"
      },
      "customer_organization": {
        "organization_uid": "c60f3cd2-c430-49dd-8c9c-7903cc38d3ca",
        "organization_name": "Prime Care Nursing Home",
        "organization_email": "support@primecare.com",
        "organization_address": {
          "city": "Chennai",
          "state": "Tamil Nadu",
          "street": "Prime Care Nursing Home, Sakthi Nagar Main Road, Bharathidasan Nagar, Balaji Nagar, Adambakkam",
          "country": "India",
          "zip_code": "600088",
          "geo_cordinates": [
            12.9799711
          ],
          "point_coordinates": {
            "type": "Point",
            "coordinates": [
              80.2044245
            ]
          }
        },
        "organization_billing_address": {
          "city": "Chennai",
          "state": "Tamil Nadu",
          "street": "Prime Care Nursing Home, Sakthi Nagar Main Road, Bharathidasan Nagar, Balaji Nagar, Adambakkam",
          "country": "India",
          "zip_code": "600088",
          "geo_cordinates": [
            12.9799711
          ],
          "point_coordinates": {
            "type": "Point",
            "coordinates": [
              80.2044245
            ]
          }
        },
        "is_active": true
      },
      "customer_email": "dev.george@primecare.com",
      "no_of_jobs": 1,
      "customer_contact_no": {
        "home": "+91 9600086457"
      },
      "customer_address": {
        "city": "Chennai",
        "state": "Tamil Nadu",
        "street": "Ramaniyam Pushkar Phase 1 Apartment, Kalaignar Karunanidhi Salai, Sholinganallur",
        "country": "India",
        "zip_code": "600119",
        "geo_cordinates": [
          12.9007222
        ],
        "point_coordinates": {
          "type": "Point",
          "coordinates": [
            80.2344109
          ]
        }
      },
      "customer_billing_address": {
        "city": "Chennai",
        "state": "Tamil Nadu",
        "street": "Ramaniyam Pushkar Phase 1 Apartment, Kalaignar Karunanidhi Salai, Sholinganallur",
        "country": "India",
        "zip_code": "600119",
        "geo_cordinates": [
          12.9007222
        ],
        "point_coordinates": {
          "type": "Point",
          "coordinates": [
            80.2344109
          ]
        }
      },
      "accounts": {
        "receivables": 440
      },
      "is_active": true,
      "created_at": "2024-08-28T11:59:31.317Z",
      "id": "undefined"
    }
  ],
  "total_records": 2,
  "current_page": 1,
  "total_pages": 1
}