LookzUp Developer APIs

Get Auth Token

Exchanges your partner clientId + clientSecret for a short-lived Bearer token used on all subsequent calls.

curl --location --request POST '{base_url}/public/getAuthToken' \
--header 'clientId: {your_client_id}' \
--header 'clientSecret: {your_client_secret}'

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...(truncated)",
  "expires_in": 3600,
  "token_type": "Bearer"
}

The decoded token carries tenantId, clientId and a scope array (e.g. member.read, booking.write, customer.read, membership.write).

Create Business Customer

Creates a new customer (or guest) record in the LookzUp auth system and returns a UUID you should store against your local user record.

{
  "email": "newuser@testmail.com",
  "countryCode": "+91",
  "phoneNumber": "1234567890",
  "password": "newuser#123"
}

{
  "result": "success",
  "uuid": "bI7ksbIpIKftL0VWT9v5m6KO7t13"
}

Note: Persist this uuid against your local user record — it is required as an identifier on nearly every subsequent customer-scoped call.

Get Business Customer Data by UUID

Retrieves the customer's basic Firebase-style auth record.

{
  "result": "success",
  "user": {
    "uid": "lYf3B1oH3kYBzZwpiM6lGIKpRq32",
    "email": "abc@testmail.com",
    "emailVerified": false,
    "displayName": "Guest User",
    "phoneNumber": "+919830451234",
    "disabled": false,
    "tenantId": "Tulayraa-yjjzs",
    "providerData": [
      { "providerId": "phone", "phoneNumber": "+919830451234" },
      { "providerId": "password", "email": "abc@testmail.com" }
    ]
  }
}

Add / Edit Business Customer Data

Sets or updates the customer's profile. This call also transitions a newly created user into a state where they can book appointments and perform other customer actions.

{
  "uuid": "GHOg0L0zXhaZhKf17bwWei0snFt1",
  "email": "newuser@testmail.com",
  "countryCode": "+91",
  "phoneNumber": "1234567890",
  "displayName": "Celina Wright",
  "dob": "1981-11-10 00:00:00",
  "photoURL": "https://abc.com/pix/b.jpg",
  "gender": "Female",
  "shortBio": "A short bio.",
  "emailVerificationStatus": 1
}

[
  { "errorcode": "0", "message": "Profile data add/updated successfully." }
]

Get Business Customer Profile Data

Fetches the profile stored in LookzUp for a given customer.

[
  {
    "email": "abc@testmail.com",
    "country_code": "+91",
    "profileHashId": "e4026f487863339542e5d8323ce90637acde252f",
    "name": "Byomkesh Bakshi 2",
    "gender": null,
    "dateOfBirth": "1981-11-10T00:00:00.000Z",
    "phone": "9830451234",
    "profile_code": "26CD17A525",
    "userType": 7,
    "creation_time": "2026-06-23T07:36:54.000Z"
  }
]

Get Business Service Package List

Returns the services and membership packages offered by the business, paginated.

{
  "totalCount": 8,
  "businessHashId": "fa1a1ad7bb57b9c5f7ae84b1114a1d011624a0a8",
  "hash_id": "f87d3e4119e525eac0e342e71acc8ff224203552",
  "serviceName": "Beard Trim",
  "approxTime": 10,
  "description": "Shaping, grooming and styling of facial hair...",
  "shop_rate": 150,
  "home_rate": 200,
  "currency": "INR",
  "currency_symbol": "₹",
  "status": 1,
  "homeStatus": 1,
  "shopStatus": 1,
  "discountStatus": 0,
  "is_available_online": 0
}

Create Customer Booking

Creates an appointment for a customer against one or more selected services.

{
  "bookingInfo": {
    "bookingDate": "2026-07-22 21:31:48",
    "bookingStartTime": "22:00",
    "bookingEndTime": "23:00",
    "price": 200,
    "bookingType": "0",
    "bookingStatus": 1,
    "servicesInfo": [
      {
        "businessHashId": "dc9c361261775779d463ccd9889602b66b135f48",
        "hash_id": "f87d3e4119e525eac0e342e71acc8ff224203552",
        "serviceName": "Beard Trim",
        "rate": 200,
        "selected": true,
        "qty": 1
      }
    ],
    "booking_address": {
      "city": "Tinsukia",
      "state": "Assam",
      "country": "India",
      "zip": "786125",
      "lat": "27.488554",
      "lng": "95.355758",
      "address_line": "Tinsukia, Assam, India",
      "booking_type": "0",
      "country_code": "+91",
      "phone": "3333333333"
    },
    "time_zone": "Asia/Kolkata",
    "creation_time": "2026-07-22 21:31:51"
  }
}

{
  "message": "Booking created sucessfully.",
  "errorcode": 0,
  "appointmentNo": "3",
  "bookingHashId": "dd0b4848bb88c82c0e9bec96f983e924472dd905",
  "reward_points_earned": 25
}

Note: Persist bookingHashId — it is the primary reference for invoicing, payments and status lookups.

Get Booking Details

Get the details of an appointment for a customer based on the booking hash.

The response returns booking status, timing, serviceList (JSON string), customerInfo, entityInfo, booking_address, advance_payment_status and payments — all as embedded JSON strings that should be parsed client-side.

Common bookingStatus values seen in examples: 1 (created/pending), 7 (completed/other terminal state) — confirm the full enum with LookzUp support before relying on it in production logic.

Get Customer Booking List

Returns a paginated list of a customer's appointments across businesses.

The response is an array of booking summaries, each including total_count (for pagination), shopName, shopImage, bookingStatus, bookingStartTime/bookingEndTime and embedded entityInfo/e_info JSON strings describing the business.

Create Customer Invoice

Generates an invoice for a booking. Required when the business accepts advance payment.

{
  "hash_id": "c207b90f0c4a2dd3e81a691ffffc5ac4c43993ac",
  "entity_name": "Glamour Salon and Parlour",
  "booking_no": "2",
  "cust_name": "Byomkesh Bakshi",
  "total_price": 610.5,
  "payment_status": 0,
  "inv_no": "GLAINV202606230828153763",
  "total_tax": "55.50",
  "item_price": 555,
  "sgst_value": 55.5,
  "currency": "INR",
  "currency_symbol": "₹",
  "invoiceDetails": "[ ...line items with per-service tax breakdown... ]",
  "isOnlinePaymentEnabled": 1,
  "advance_payment_status": "{\"home_service\": 1, \"shop_service\": 0, \"virtual_service\": 0}",
  "advance_payment_required": 100
}

Record Customer Payment

Records a payment (cash, card, online, etc.) against one or more appointments.

{
  "appointments": [
    { "appointment_hash_id": "7d6926b1a640730c13cdd05ee70ebd94a251c051", "is_primary": 1 }
  ],
  "total_price": 400,
  "customer_payment": 100,
  "net_price": 400,
  "payment_status": 1,
  "currency": "USD",
  "currency_symbol": "$",
  "payment_mode": "Cash",
  "invoice_hash": "cf159163eb0fe33a04500f86d418d77fceab46e3",
  "is_paying_due": 1,
  "payment_time": "2026-06-29 21:04:56",
  "country_code": "+91",
  "phone": "3333333333",
  "payment_type": 1
}

{ "msg": "success", "errorcode": 0 }

Create Membership Request

Lets a customer request enrollment into a gym/salon membership package.

{
  "customer_name": "Celina Wright",
  "customer_country_code": "+91",
  "customer_phone": "1234567890",
  "customer_notes": "Come to my home to provide the service. Is that possible?",
  "services": [
    {
      "service_type_hash": "c56ab27edc1eb9d06e9b31e56fc8020668ba9014",
      "service_name": "Third session",
      "service_qty": 1,
      "service_rate": 500,
      "service_time": 45
    }
  ],
  "timings": [
    { "weekday": 4, "start_time": "18:00", "end_time": "19:00" }
  ],
  "interest_type": "1",
  "creation_date": "2026-07-17 11:00:00"
}

{ "errorcode": 0, "msg": "success", "data": { "reward_points_earned": 10 } }

Get Membership Request List

Lists a customer's membership applications across businesses.

Returns an array of request summaries including enrollment_request_status (e.g. 1 = pending, 3 = a terminal/other status — confirm full enum with LookzUp support), customer_notes and embedded entity_details.

Get Membership Request Details

Get the latest update of a membership request created by a user.

Adds request_services and request_timings (both JSON strings) plus coupon fields (coupon_code, discount_value, minimum_cart_value, max_discount) to the request summary.

Get Membership List

Lists a customer's current and past confirmed memberships.

Key response fields: membership_fee, discount, net_payable, total_due, membership_start_date, membership_status, service_mode, entity_services (JSON string listing the services covered).

Get Membership Details

This returns the detailed membership data of an exisiting member.

Returns full membership detail: coupon_code/coupon_discount_amount/coupon_discount_type, billing_period, services (JSON string of covered services with rates), timings (JSON string of recurring slots), assign_to (staff member), total_wallet and total_reward.

Create Service Enquiry

Submits a "Contact Us" style enquiry to a business.

{
          "name": "Celina Wright",
          "country_code": "+91",
          "phone": "1234567890",
          "email": "celina@example.com",
          "enquiry_type": 3,
          "message": "Is anyone there in the shop? I can see it's empty.",
          "creation_time": "2026-07-24 14:00:00",
          "service_mode": 2
        }

{ "errorcode": 0, "msg": "success" }

Get Customer Service Enquiries

Lists a customer's submitted enquiries.

Get Customer Enquiry Details

This returns the latest update and replies of a customer enquiry.

Returns full enquiry detail including message, reply/reply_date (populated once the business responds), status, service_mode and embedded entityInfo.

Test Your Integration in Development Environment

The Dev environment provides a safe sandbox where you can build, test, and validate your integration without affecting live business or customer data. To access the Development environment, simply insert /dev into the API base URL.

Authentication API Exception

The getAuthToken API is not environment-specific.

Continue using the same authentication endpoint for both Development and Production environments. No /dev prefix is required for the authentication API.

Setting Up Your Test Business

To begin testing, you must first create a test business in the LookzUp Development portal.

1. 01
   Sign in to your Development Business Dashboard.
2. 02
   Open Business Details.
3. 03
   Navigate to Business Setup.
4. 04
   From the options menu, select Domain Mapping.
5. 05
   Enter the required application and domain details.
6. 06
   Submit the request to initiate the generation of your Access Key and Secret.

Moving to Production

Once your integration has been successfully tested and validated in the Development environment, the LookzUp team will review your implementation.

After successful verification, you will receive your Production Access Key and Production Secret, allowing your application to securely communicate with the live LookzUp platform.

Replace the Development API URLs with the Production URLs by removing the /dev path from the endpoint.

Example

No application code changes should be necessary other than updating the API base URL and replacing the Development credentials with the Production credentials.

Best Practice: Keep Development and Production credentials separate. Never use Production credentials during testing and never expose your Access Key or Secret in client-side applications.