Pixalink Documentation

Introduction

Base URL: https://explore.pixalink.io

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

To use our API, please contact our support team to request API access. Once approved, you can generate your access token through your admin panel by visiting Personal Access Tokens page.

Credits

List Credits

GET

https://explore.pixalink.io.test

/api/credits

requires authentication

Get a paginated list of credits for the organisation.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

filter[customer_id]

integer

Filter by customer ID.

Example:

filter[type]

string

Filter by credit type.

Example:

Top Up

filter[space_id]

integer

Filter by space ID.

Example:

filter[amount]

string

Filter by amount with operators.

Example:

>100

sort

string

Sort field (created_at, amount).

Example:

-created_at

include

string

Include relationships (customer, space, reward).

Example:

customer

per_page

integer

Number of records per page.

Example:

Response Fields

integer

The credit ID.

customer_id

integer

The customer who owns this credit entry.

space_id

integer|null

The space where this credit was issued.

amount

string

decimal The credit amount in dollars (positive or negative).

operation

string

Operation direction: + for credit, - for debit.

type

string

Credit type: Top Up, Deduct, Bonus, Refund, Referral, Revert.

remarks

string|null

Optional remarks for this credit entry.

created_at

string

datetime When the credit was created.

updated_at

string

datetime When the credit was last updated.

quantity

integer

The quantity multiplier for this credit entry.

custom_properties

object|null

Custom metadata attached to this credit entry.

valid_amount

decimal The remaining redeemable amount (after partial use).

expired_at

datetime|null When this credit entry expires, or null if it does not expire.

reward_id

integer|null

The reward associated with this credit entry, if any.

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/credits?filter%5Bcustomer_id%5D=1&filter%5Btype%5D=Top+Up&filter%5Bspace_id%5D=1&filter%5Bamount%5D=%3E100&sort=-created_at&include=customer&per_page=15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "customer_id": 42,
            "space_id": 1,
            "amount": "50.00",
            "operation": "+",
            "type": "Top Up",
            "remarks": "Birthday top-up",
            "created_at": "2025-05-06T14:30:01.000000Z",
            "updated_at": "2025-05-06T14:30:01.000000Z"
        }
    ],
    "links": {
        "first": "...",
        "last": "...",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 15,
        "to": 1,
        "total": 1
    }
}

Create Credit

POST

https://explore.pixalink.io.test

/api/credits

requires authentication

Creates a new credit entry for a customer (top up, deduct, revert, etc.).

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

customer_id

integer

Customer ID. Required if phone_number not provided.

Example:

phone_number

string

Customer phone number. Required if customer_id not provided.

Example:

+60123456789

amount

numeric

required

Credit amount in dollars.

Example:

50.00

type

string

required

Credit type. One of: Top Up, Deduct, Bonus, Refund, Referral, Revert.

Example:

Top Up

space_id

integer

Space ID.

Example:

remarks

string

Additional remarks. Max 500 characters.

Example:

Birthday top-up

custom_properties

object

Custom properties for this credit entry.

Example:

[]

source_credit_id

integer

Required when type is Revert. The original TopUp credit to revert.

Example:

Response Fields

integer

The credit ID.

customer_id

integer

The customer who owns this credit entry.

space_id

integer|null

The space where this credit was issued.

amount

string

decimal The credit amount in dollars.

operation

string

Operation direction: + for credit, - for debit.

type

string

Credit type.

remarks

string|null

Optional remarks.

created_at

string

datetime When the credit was created.

updated_at

string

datetime When the credit was last updated.

quantity

integer

The quantity multiplier for this credit entry.

custom_properties

object|null

Custom metadata attached to this credit entry.

valid_amount

decimal The remaining redeemable amount (after partial use).

expired_at

datetime|null When this credit entry expires, or null if it does not expire.

reward_id

integer|null

The reward associated with this credit entry, if any.

Auth

Bearer

Headers

Body

{ "customer_id": 42, "phone_number": "+60123456789", "amount": "50.00", "type": "Top Up", "space_id": 1, "remarks": "Birthday top-up", "custom_properties": [], "source_credit_id": 10 }

Received response

Example request:

curl --request POST \
    "https://explore.pixalink.io.test/api/credits" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"customer_id\": 42,
    \"phone_number\": \"+60123456789\",
    \"amount\": \"50.00\",
    \"type\": \"Top Up\",
    \"space_id\": 1,
    \"remarks\": \"Birthday top-up\",
    \"custom_properties\": [],
    \"source_credit_id\": 10
}"

Example response:

{
    "data": {
        "id": 1,
        "customer_id": 42,
        "space_id": 1,
        "amount": "50.00",
        "operation": "+",
        "type": "Top Up",
        "remarks": "Birthday top-up",
        "created_at": "2025-05-06T14:30:01.000000Z",
        "updated_at": "2025-05-06T14:30:01.000000Z"
    }
}

Get Credit Details

GET

https://explore.pixalink.io.test

/api/credits/{id}

requires authentication

Retrieve detailed information about a specific credit.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the credit.

Example:

credit

integer

required

The ID of the credit.

Example:

Query Parameters

include

string

Relationships to include (customer, space, reward).

Example:

customer

Response Fields

integer

The credit ID.

customer_id

integer

The customer who owns this credit entry.

space_id

integer|null

The space where this credit was issued.

amount

string

decimal The credit amount in dollars.

operation

string

Operation direction: + for credit, - for debit.

type

string

Credit type.

remarks

string|null

Optional remarks.

created_at

string

datetime When the credit was created.

updated_at

string

datetime When the credit was last updated.

quantity

integer

The quantity multiplier for this credit entry.

custom_properties

object|null

Custom metadata attached to this credit entry.

valid_amount

decimal The remaining redeemable amount (after partial use).

expired_at

datetime|null When this credit entry expires, or null if it does not expire.

reward_id

integer|null

The reward associated with this credit entry, if any.

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/credits/3?include=customer" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": 1,
        "customer_id": 42,
        "space_id": 1,
        "amount": "50.00",
        "operation": "+",
        "type": "Top Up",
        "remarks": "Birthday top-up",
        "created_at": "2025-05-06T14:30:01.000000Z",
        "updated_at": "2025-05-06T14:30:01.000000Z"
    }
}

Customer Paid Memberships

List Customer Paid Memberships

GET

https://explore.pixalink.io.test

/api/customer_paid_memberships

requires authentication

Returns a paginated list of customer paid membership instances. Records are scoped to the authenticated user's organisation via the model's global scope.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

include

string

Comma-separated relationships to include. Available: customer, paidMembershipType, transactions, payments, activePayment. Use payments to retrieve all payment records for reconciliation, or activePayment to retrieve only the currently linked payment.

Example:

paidMembershipType,customer

filter[customer_id]

integer

Filter by customer ID.

Example:

filter[paid_membership_type_id]

integer

Filter by membership type ID.

Example:

filter[is_active]

boolean

Filter by active flag.

Example:

true

filter[billing_cycle]

string

Filter by billing cycle (monthly or yearly).

Example:

yearly

filter[expires_at]

string

Filter by expiry date using comparison operators (>, <, =). ISO 8601 date.

Example:

>2025-04-01

sort

string

Sort field and direction. Prefix with - for descending. Available: created_at, starts_at, expires_at. Defaults to -created_at.

Example:

-expires_at

per_page

integer

Number of records per page. Defaults to 15.

Example:

Response Fields

integer

The unique identifier of the membership instance.

membership_status

string

active if is_active and not expired, otherwise inactive.

membership_type_name

string

The membership type display name.

billing_cycle

string

monthly or yearly.

starts_at

date Start date (ISO 8601).

expires_at

date Expiry date (ISO 8601).

auto_renew

boolean

Whether auto-renew is enabled for this membership.

is_active

boolean

Whether the membership is currently active.

payment_status

string|null

Payment lifecycle state: pending, paid, failed, or null for memberships assigned without a tracked payment.

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/customer_paid_memberships?include=paidMembershipType%2Ccustomer&filter%5Bcustomer_id%5D=1&filter%5Bpaid_membership_type_id%5D=1&filter%5Bis_active%5D=1&filter%5Bbilling_cycle%5D=yearly&filter%5Bexpires_at%5D=%3E2025-04-01&sort=-expires_at&per_page=15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

cache-control: no-cache, private
content-type: application/json
content-security-policy: default-src 'self'; script-src https: 'self' 'unsafe-inline' 'unsafe-eval' blob: http://localhost:5173; style-src https: 'self' 'unsafe-inline' http://localhost:5173; font-src https: 'self' data:; img-src https: 'self' data: blob:; media-src https: 'self' blob:; connect-src https: wss: 'self' ws://localhost:5173; frame-src https: 'self' phpstorm:; worker-src 'self' blob:; frame-ancestors 'self'; base-uri 'self'; upgrade-insecure-requests; form-action 'self'
referrer-policy: strict-origin-when-cross-origin
permissions-policy: geolocation=(), microphone=(), camera=(self), payment=(self), usb=(), magnetometer=(), gyroscope=(), accelerometer=(), autoplay=(), encrypted-media=(), fullscreen=*, picture-in-picture=()
x-content-type-options: nosniff
x-frame-options: DENY
access-control-allow-origin: *

{
    "message": "Unauthenticated."
}

Assign a Paid Membership

POST

https://explore.pixalink.io.test

/api/customer_paid_memberships

requires authentication

Assigns a paid membership of the given type and billing cycle to a customer. Any existing active membership for that customer is automatically deactivated. Delegates lifecycle logic to PaidMembershipService::assignMembership, which records a ManualAssign transaction and issues any rewards configured on the membership type.

If the integrator has already collected payment in their own system, an optional payment object may be supplied. When present, a Payment row is recorded against the membership and a ManualPayment transaction is logged. The accepted payment.method values (cash, card, e_wallet) are deliberately limited to manually-recorded instruments — gateway methods are not accepted via this endpoint. Omit payment entirely for free/comp assignments.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

customer_id

string

required

The ID of the customer to assign the membership to. Must belong to your organisation. The id of an existing record in the customers table.

Example:

paid_membership_type_id

string

required

The ID of the paid membership type catalog entry. Must belong to your organisation. The id of an existing record in the paid_membership_types table.

Example:

billing_cycle

string

required

The billing cycle for this membership. Must be one of the cycles configured in the membership type pricing options.

Must be one of:

monthly
yearly

Example:

monthly

starts_at

string

Optional start date. Defaults to now if omitted. ISO 8601 (YYYY-MM-DD). Must be a valid date.

Example:

2025-04-01

remarks

string

Optional internal note explaining the assignment (e.g. promotion code, manual signup reason). Must not be greater than 500 characters.

Example:

Manually assigned by support after refund.

payment

object

Optional payment record. Use when the integrator has already collected payment in their own system and wants Pixalink to record it alongside the membership. Omit this object entirely for a free/comp assignment.

method

string

The payment instrument used. Must be one of: cash, card, e_wallet. Payment gateway methods are not accepted here. This field is required when payment is present.

Must be one of:

cash
card
e_wallet

Example:

cash

amount

number

The amount collected, in major currency units (e.g. 99.00 for RM 99.00). Must be greater than zero — omit the payment block entirely for free/comp assignments. This field is required when payment is present. Must be at least 0.01.

Example:

currency

string

ISO 4217 currency code. Defaults to MYR if omitted. Must be 3 characters.

Example:

MYR

reference_id

string

The integrator's own transaction identifier, stored on the payment row for later reconciliation. Must not be greater than 255 characters.

Example:

POS-12345

remarks

string

Optional note attached to the payment record. Must not be greater than 500 characters.

Example:

Paid at counter

Response Fields

integer

The unique identifier of the membership instance.

membership_status

string

Always active for a freshly assigned membership.

membership_type_name

string

The membership type display name.

billing_cycle

string

monthly or yearly.

starts_at

string

date Start date (ISO 8601).

expires_at

string

date Expiry date (ISO 8601).

auto_renew

boolean

Defaults to false for manually assigned memberships.

is_active

boolean

Always true on creation.

payment_status

string|null

Payment lifecycle state when a payment was recorded, otherwise null.

Auth

Bearer

Headers

Body

{ "customer_id": 1, "paid_membership_type_id": 1, "billing_cycle": "monthly", "starts_at": "2025-04-01", "remarks": "Manually assigned by support after refund.", "payment": { "method": "cash", "amount": 99, "currency": "MYR", "reference_id": "POS-12345", "remarks": "Paid at counter" } }

Received response

Example request:

curl --request POST \
    "https://explore.pixalink.io.test/api/customer_paid_memberships" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"customer_id\": 1,
    \"paid_membership_type_id\": 1,
    \"billing_cycle\": \"monthly\",
    \"starts_at\": \"2025-04-01\",
    \"remarks\": \"Manually assigned by support after refund.\",
    \"payment\": {
        \"method\": \"cash\",
        \"amount\": 99,
        \"currency\": \"MYR\",
        \"reference_id\": \"POS-12345\",
        \"remarks\": \"Paid at counter\"
    }
}"

Example response:

{
    "data": {
        "id": 1,
        "membership_status": "active",
        "membership_type_name": "VIP Gold",
        "billing_cycle": "monthly",
        "starts_at": "2025-04-01",
        "expires_at": "2025-05-01",
        "is_active": true
    },
    "message": "Paid membership assigned successfully"
}

Show Customer Paid Membership

GET

https://explore.pixalink.io.test

/api/customer_paid_memberships/{id}

requires authentication

Retrieves a single customer paid membership by ID. Cross-organisation access returns 404.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the customer paid membership.

Example:

customer_paid_membership

integer

required

The ID of the membership instance.

Example:

Query Parameters

include

string

Example:

payments

Response Fields

integer

The unique identifier of the membership instance.

membership_status

string

active if is_active and not expired, otherwise inactive.

membership_type_name

string

The membership type display name.

billing_cycle

string

monthly or yearly.

starts_at

string

date Start date (ISO 8601).

expires_at

string

date Expiry date (ISO 8601).

auto_renew

boolean

Whether auto-renew is enabled.

is_active

boolean

Whether the membership is currently active.

payment_status

string|null

Payment lifecycle state: pending, paid, failed, or null.

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/customer_paid_memberships/1?include=payments" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": 1,
        "membership_status": "active",
        "membership_type_name": "VIP Gold",
        "billing_cycle": "monthly",
        "starts_at": "2025-04-01",
        "expires_at": "2025-05-01",
        "auto_renew": false,
        "is_active": true
    }
}

Update Customer Paid Membership

PUT

PATCH

https://explore.pixalink.io.test

/api/customer_paid_memberships/{id}

requires authentication

Either extends the membership (via extend_days + remarks) or toggles auto_renew. The two operations are mutually exclusive — sending both at once returns a 422.

Extending delegates to PaidMembershipService::extendMembership, which records a ManualExtend transaction and sends the customer the configured notification.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the customer paid membership.

Example:

customer_paid_membership

integer

required

The ID of the membership to update.

Example:

Body Parameters

extend_days

integer

Number of days to extend the membership by. Mutually exclusive with auto_renew. Requires remarks. This field is required when auto_renew is not present. This field is required when remarks is present. Must be at least 1. Must not be greater than 3650.

Example:

remarks

string

Internal note for the extension. Required when extend_days is set. This field is required when extend_days is present. Must not be greater than 500 characters.

Example:

Goodwill extension after service outage.

auto_renew

boolean

Toggle the auto-renew flag for this membership. Mutually exclusive with extend_days / remarks. This field is required when extend_days is not present.

Example:

true

Response Fields

integer

The unique identifier of the membership instance.

membership_status

string

active or inactive.

membership_type_name

string

The membership type display name.

billing_cycle

string

monthly or yearly.

starts_at

string

date Start date (ISO 8601).

expires_at

string

date Updated expiry date when extend_days was supplied.

auto_renew

boolean

Reflects the latest toggle value.

payment_status

string|null

Payment lifecycle state: pending, paid, failed, or null.

is_active

boolean

Whether the membership is currently active.

Auth

Bearer

Headers

URL Parameters

Body

{ "extend_days": 14, "remarks": "Goodwill extension after service outage.", "auto_renew": true }

Received response

Example request:

curl --request PUT \
    "https://explore.pixalink.io.test/api/customer_paid_memberships/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"extend_days\": 14,
    \"remarks\": \"Goodwill extension after service outage.\",
    \"auto_renew\": true
}"

Example response:

{
    "data": {
        "id": 1,
        "membership_status": "active",
        "membership_type_name": "VIP Gold",
        "billing_cycle": "monthly",
        "starts_at": "2025-04-01",
        "expires_at": "2025-05-15",
        "auto_renew": true,
        "is_active": true
    },
    "message": "Paid membership updated successfully"
}

Cancel Customer Paid Membership

DELETE

https://explore.pixalink.io.test

/api/customer_paid_memberships/{id}

requires authentication

Cancels (deactivates) the customer's paid membership. Sets is_active to false and records a Cancelled transaction for the audit trail. The row is not hard-deleted — historical lookups remain intact.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the customer paid membership.

Example:

customer_paid_membership

integer

required

The ID of the membership to cancel.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://explore.pixalink.io.test/api/customer_paid_memberships/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[Empty response]

Customer Rewards

APIs for managing customer rewards

List Customer Rewards

GET

https://explore.pixalink.io.test

/api/customer_rewards

requires authentication

Returns a paginated list of customer rewards belonging to the authenticated user's organisation. Results can be filtered, sorted and include related data through query parameters.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

include

string

Comma-separated list of relationships to include:

customer
reward
validatedAtSpace
validatedByUser

Example:

customer,reward,validatedAtSpace,validatedByUser

filter[status]

string

Filter by reward status (Pending, Used, Expired).

Example:

Pending

filter[code]

string

Filter by exact reward code match.

Example:

ABC123

filter[expired_at]

string

Filter by expiry date with operators (>, <, =).

Example:

>2024-01-01

filter[used_at]

string

Filter by redemption date with operators (>, <, =).

Example:

<2024-12-31

filter[customer_id]

integer

Filter by customer ID.

Example:

filter[reward_id]

integer

Filter by reward ID.

Example:

filter[validated_at_space_id]

integer

Filter by validation space ID.

Example:

filter[validated_by_user_id]

integer

Filter by validator user ID.

Example:

sort

string

Sort field and direction. Allowed fields: expired_at, used_at, created_at.

Example:

-created_at

per_page

integer

Number of records per page.

Example:

Response Fields

integer

The unique identifier of the customer reward.

customer_id

integer

The ID of the customer who owns the reward.

reward_id

integer

The ID of the underlying reward.

status

string

The current status of the reward (Pending, Used, Expired).

code

string

The unique redemption code.

expired_at

datetime|null When the reward expires.

used_at

datetime|null When the reward was used (null if Pending).

customer

object|null

Customer details (included when relationship is loaded).

reward

object|null

Reward details (included when relationship is loaded).

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/customer_rewards?include=customer%2Creward%2CvalidatedAtSpace%2CvalidatedByUser&filter%5Bstatus%5D=Pending&filter%5Bcode%5D=ABC123&filter%5Bexpired_at%5D=%3E2024-01-01&filter%5Bused_at%5D=%3C2024-12-31&filter%5Bcustomer_id%5D=1&filter%5Breward_id%5D=1&filter%5Bvalidated_at_space_id%5D=1&filter%5Bvalidated_by_user_id%5D=1&sort=-created_at&per_page=15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
   "data":[
     {
        "id": 1,
        "customer_id": 1,
        "reward_id": 1,
        "status": "Pending",
        "code": "REWARD123",
        "expired_at": "2024-12-31T23:59:59.000000Z",
        "used_at": null,
        "created_at": "2024-02-11T00:00:00.000000Z",
        "updated_at": "2024-02-11T00:00:00.000000Z",
        "customer" : {
           "id": 1,
           "name": "John Smith",
           "email": "john.smith@example.com",
           "phone_number": "+60123456789",
           "gender": 1,
           "date_of_birth": "1990-05-15",
           "source": "WhatsApp",
           "status": "Converted",
           "current_point": 2500,
           "created_at": "2024-01-15T08:30:00.000000Z",
           "updated_at": "2024-02-01T14:22:33.000000Z",
           "notes": "Prefers to be contacted via WhatsApp",
           "is_manually_assign_tier": 0,
           "current_credits": 150,
           "birthday_month": 5,
           "tags": ["VIP", "Regular Customer"],
           "space_id": 1,
           "tier_id": 1,
           "organisation_id": 1,
         }
       },
     ],
    "links": {
      "first": "{{$baseUrl}}/customer_rewards?page=1",
      "last": "{{$baseUrl}}/customer_rewards?page=5",
      "prev": null,
      "next": "{{$baseUrl}}/customer_rewards?page=2"
    },
    "meta": {
      "current_page": 1,
      "from": 1,
      "last_page": 5,
      "links": [
        {
          "url": null,
          "label": "&laquo; Previous",
          "active": false
        },
        {
          "url": "{{$baseUrl}}/customer_rewards?page=1",
          "label": "1",
          "active": true
        },
        {
          "url": "{{$baseUrl}}/customer_rewards?page=2",
          "label": "2",
          "active": false
        },
        {
          "url": "{{$baseUrl}}/customer_rewards?page=3",
          "label": "3",
          "active": false
        },
        {
          "url": "{{$baseUrl}}/customer_rewards?page=2",
          "label": "Next &raquo;",
          "active": false
        }
      ],
      "path": "{{$baseUrl}}/customer_rewards",
      "per_page": 15,
      "to": 15,
      "total": 68
    }
  }

Create Customer Reward

POST

https://explore.pixalink.io.test

/api/customer_rewards

requires authentication

Assigns a reward to a customer and processes the point redemption. This endpoint performs several validation checks:

Verifies that the customer has sufficient points for the reward
Checks if the reward has reached its total availability limit (if configured)
For one-time rewards, ensures the customer hasn't already redeemed it
Validates that both customer and reward belong to the authenticated organisation

Upon successful validation, the system will:

Deduct points from the customer's balance
Create a customer reward record
Generate a unique redemption code
If mark_as_redeemed is true, immediately mark the reward as used

Note: The reward's points cost is determined by its configured amount. Ensure the customer has sufficient points before making this request to avoid validation errors.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

customer_id

integer

required

The ID of the customer who will receive the reward. Must belong to the authenticated organisation.

Example:

reward_id

integer

required

The ID of the reward to be redeemed. Must exist in one of the organisation's spaces.

Example:

mark_as_redeemed

boolean

optional If true, the reward will be marked as used immediately upon creation. Default: false.

Example:

false

currency_type

string

optional The currency type to use for redemption. Must be "point" or "credit". Defaults to "point" if not specified.

Example:

point

validated_at_space_id

integer

optional ID of the space where the reward was validated. Required when mark_as_redeemed is true.

Example:

validated_by_user_id

integer

optional ID of the user who validated the reward. Will default to current user if not specified when mark_as_redeemed is true.

Example:

Response Fields

integer

The unique identifier of the customer reward.

customer_id

integer

The ID of the customer who owns the reward.

reward_id

integer

The ID of the underlying reward.

status

string

The current status of the reward (Pending, Used, Expired).

code

string

The unique redemption code.

expired_at

string

datetime|null When the reward expires.

used_at

datetime|null When the reward was used (null if Pending).

Auth

Bearer

Headers

Body

{ "customer_id": 1, "reward_id": 1, "mark_as_redeemed": false, "currency_type": "point", "validated_at_space_id": 1, "validated_by_user_id": 1 }

Received response

Example request:

curl --request POST \
    "https://explore.pixalink.io.test/api/customer_rewards" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"customer_id\": 1,
    \"reward_id\": 1,
    \"mark_as_redeemed\": false,
    \"currency_type\": \"point\",
    \"validated_at_space_id\": 1,
    \"validated_by_user_id\": 1
}"

Example response:

{
    "data": {
        "id": 1,
        "customer_id": 1,
        "reward_id": 1,
        "status": "Pending",
        "code": "REWARD123",
        "expired_at": "2024-12-31T23:59:59.000000Z",
        "used_at": null,
        "created_at": "2024-02-11T00:00:00.000000Z",
        "updated_at": "2024-02-11T00:00:00.000000Z"
    },
    "message": "Customer reward created successfully"
}

Get Customer Reward Details

GET

https://explore.pixalink.io.test

/api/customer_rewards/{id}

requires authentication

Retrieves detailed information about a specific customer reward.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the customer reward.

Example:

Query Parameters

include

string

Comma-separated list of relationships to include (customer, reward, validatedAtSpace, validatedByUser).

Example:

customer,reward,validatedAtSpace,validatedByUser

Response Fields

integer

The unique identifier of the customer reward.

customer_id

integer

The ID of the customer who owns the reward.

reward_id

integer

The ID of the underlying reward.

status

string

The current status of the reward (Pending, Used, Expired).

code

string

The unique redemption code.

expired_at

string

datetime|null When the reward expires.

used_at

datetime|null When the reward was used (null if Pending).

customer

object|null

Customer details (included when relationship is loaded).

reward

object|null

Reward details (included when relationship is loaded).

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/customer_rewards/1?include=customer%2Creward%2CvalidatedAtSpace%2CvalidatedByUser" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": 1,
        "customer_id": 1,
        "reward_id": 1,
        "status": "Pending",
        "code": "REWARD123",
        "expired_at": "2024-12-31T23:59:59.000000Z",
        "used_at": null,
        "created_at": "2024-02-11T00:00:00.000000Z",
        "updated_at": "2024-02-11T00:00:00.000000Z"
    }
}

Update Customer Reward

PUT

PATCH

https://explore.pixalink.io.test

/api/customer_rewards/{id}

requires authentication

Updates a customer reward's details.
Can update status, expiry date, and usage date.
Cannot modify rewards that are Expired or Used for more than 1 hour.
Used rewards can be updated within 1 hour of being marked as used.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the customer reward.

Example:

Body Parameters

status

string

optional The reward status. Cannot update Expired rewards or Used rewards older than 1 hour. Used rewards can be updated within 1 hour.

Example:

Used

expired_at

datetime

optional New expiry date for the reward. Must be a future date.

Example:

2024-12-31T23:59:59Z

used_at

datetime

optional Date when the reward was used. Can only be set when status is Used. Must not be in the future.

Example:

2024-02-10T15:30:00Z

validated_at_space_id

integer

optional ID of the space where the reward was validated. Auto-set when marking as Used. Can be explicitly set to null when reverting to Pending.

Example:

validated_by_user_id

integer

optional ID of the user who validated the reward. Auto-set to current user when marking as Used. Can be explicitly set to null when reverting to Pending.

Example:

Response Fields

integer

The unique identifier of the customer reward.

customer_id

integer

The ID of the customer who owns the reward.

reward_id

integer

The ID of the underlying reward.

status

string

The current status of the reward (Pending, Used, Expired).

code

string

The unique redemption code.

expired_at

string

datetime|null When the reward expires.

used_at

string

datetime|null When the reward was used (null if Pending).

Auth

Bearer

Headers

URL Parameters

Body

{ "status": "Used", "expired_at": "2024-12-31T23:59:59Z", "used_at": "2024-02-10T15:30:00Z", "validated_at_space_id": 1, "validated_by_user_id": 1 }

Received response

Example request:

curl --request PUT \
    "https://explore.pixalink.io.test/api/customer_rewards/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"Used\",
    \"expired_at\": \"2024-12-31T23:59:59Z\",
    \"used_at\": \"2024-02-10T15:30:00Z\",
    \"validated_at_space_id\": 1,
    \"validated_by_user_id\": 1
}"

Example response:

{
    "data": {
        "id": 1,
        "status": "Used",
        "expired_at": "2024-12-31T23:59:59.000000Z",
        "used_at": "2024-02-11T00:00:00.000000Z",
        "updated_at": "2024-02-11T00:00:00.000000Z"
    },
    "message": "Customer reward updated successfully"
}

Delete Customer Reward

DELETE

https://explore.pixalink.io.test

/api/customer_rewards/{id}

requires authentication

Revokes/deletes a pending customer reward. Cannot revoke Used or Expired rewards.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the customer reward.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://explore.pixalink.io.test/api/customer_rewards/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "message": "Customer reward revoked successfully"
}

Customers

List Customers

GET

https://explore.pixalink.io.test

/api/customers

requires authentication

Returns a paginated list of customers belonging to the authenticated user's organisation.
Results can be filtered, sorted and include related data through query parameters.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

include

string

Comma-separated list of relationships to include:

tier
space
tags
address
activePaidMembership.paidMembershipType (includes active paid membership with type details)

Example:

tier,activePaidMembership.paidMembershipType

filter[phone_number]

string

Filter by phone number (partial match). Searches for phone numbers containing the provided value.

Example:

88888888 (matches +60188888888)

filter[email]

string

Filter by email match.

Example:

customer@example.com

filter[gender]

integer

Filter by gender. Must be one of:

0 (Female)
1 (Male)

Example:

filter[source]

string

Filter by customer source. Must be one of:

Email
Phone
Direct
Reservation
WhatsApp
StoreHub
Loyverse
Softinn
Loyalty

Example:

filter[status]

string

Filter by customer status. Must be one of:

Lead
Open
Replied
Opportunity
Quotation
Lost Quotation
Interested
Converted
Do Not Contact
Blocked

Example:

Lead

filter[current_point]

string

Filter by points with operators (>, <, =).

Example:

>100

filter[current_credits]

string

Filter by credits with operators (>, <, =).

Example:

>50

filter[created_at]

string

Filter by creation date with operators (>, <, =). You can:

Find customers created on a specific date: 2024-01-01
Find customers created after a date: >2024-01-01
Find customers created before a date: <2024-01-01
Find customers created between dates: >2024-01-01,<2024-01-31 Use ISO 8601 format (YYYY-MM-DD).

Example:

2024-01-01

filter[updated_at]

string

Filter by last update date with operators (>, <, =). Use ISO 8601 format (YYYY-MM-DD).

Example:

<2024-12-31

filter[tier]

string

Filter by tier ID.

Example:

filter[space]

string

Filter by space ID.

Example:

filter[has_tags]

string

Filter by tag name.

Example:

VIP

filter[name]

string

Filter by customer name (partial match).

Example:

John

filter[birthday_month]

integer

Filter by birth month (1-12).

Example:

sort

string

Sort field and direction. Allowed fields: name, created_at, current_point, current_credits.

Example:

-created_at

per_page

integer

Number of records per page.

Example:

Response Fields

integer

The ID of the customer

name

string

The customer's full name

string

The customer's email address

phone_number

string

The customer's phone number

date_of_birth

string

datetime The customer's date of birth

gender

integer|null

The customer's gender:

0: Female
1: Male

source

string

The source of the customer:

Email
Phone
Direct
Reservation
WhatsApp
StoreHub
Loyverse
Softinn
Loyalty

status

string

The customer's current status:

Lead
Open
Replied
Opportunity
Quotation
Lost Quotation
Interested
Converted
Do Not Contact
Blocked

current_point

integer

The customer's current loyalty points

created_at

string

datetime The timestamp when the customer was created

updated_at

string

datetime The timestamp when the customer was last updated

notes

string

Optional notes about the customer

is_manually_assign_tier

integer

Whether the tier was manually assigned (0: No, 1: Yes)

current_credits

integer

The customer's current credits balance

birthday_month

integer

The customer's birth month (1-12)

space_id

integer

The ID of the space the customer belongs to

organisation_id

integer

The ID of the organisation the customer belongs to

tier_id

object|null

The customer's tier information (included when relationships are loaded)

paidMembership

object|null

The customer's active paid membership (included when activePaidMembership.paidMembershipType is requested)

integer

The membership ID

membership_status

string

Either "active" (active & not expired) or "inactive" (expired/inactive)

membership_type_name

string

Name of the membership type (e.g., "VIP Gold")

billing_cycle

string

Either "monthly" or "yearly"

starts_at

date Membership start date (YYYY-MM-DD)

expires_at

date Membership expiry date (YYYY-MM-DD)

is_active

boolean

Whether the membership is currently active

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/customers?include=tier%2CactivePaidMembership.paidMembershipType&filter%5Bphone_number%5D=88888888+%28matches+%2B60188888888%29&filter%5Bemail%5D=customer%40example.com&filter%5Bgender%5D=1&filter%5Bsource%5D=WhatsApp&filter%5Bstatus%5D=Lead&filter%5Bcurrent_point%5D=%3E100&filter%5Bcurrent_credits%5D=%3E50&filter%5Bcreated_at%5D=2024-01-01&filter%5Bupdated_at%5D=%3C2024-12-31&filter%5Btier%5D=1&filter%5Bspace%5D=1&filter%5Bhas_tags%5D=VIP&filter%5Bname%5D=John&filter%5Bbirthday_month%5D=10&sort=-created_at&per_page=15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "name": "John Smith",
            "email": "john.smith@example.com",
            "phone_number": "+60123456789",
            "gender": 1,
            "date_of_birth": "1990-05-15",
            "source": "WhatsApp",
            "status": "Converted",
            "current_point": 2500,
            "created_at": "2024-01-15T08:30:00.000000Z",
            "updated_at": "2024-02-01T14:22:33.000000Z",
            "notes": "Prefers to be contacted via WhatsApp",
            "is_manually_assign_tier": 0,
            "current_credits": 150,
            "birthday_month": 5,
            "tags": [
                "VIP",
                "Regular Customer"
            ],
            "space_id": 1,
            "tier_id": 1,
            "organisation_id": 1,
            "tier": {
                "id": 1,
                "name": "Gold Member",
                "sort": 2,
                "min_point": 2000,
                "color": "#FFD700",
                "is_manual_assign": 1,
                "point_multiplier": 1.5,
                "perks": {
                    "birthday_multiplier": 2
                },
                "tier_configuration_id": 1
            },
            "space": {
                "id": 1,
                "uuid": "f2d75bf6-3cb8-305c-8f70-f71fe697cba3",
                "name": "Main Branch",
                "slug": "main-branch",
                "matterport_model_id": null,
                "description": "Our flagship store in the city centre",
                "visibility": "public",
                "email": "main@example.com",
                "phone_number": "+60312345678",
                "website": "{{$baseUrl}}",
                "social_media": {
                    "facebook": "example",
                    "instagram": "example"
                },
                "organisation_id": 1,
                "category_id": 1,
                "visits": 1250,
                "created_at": "2023-01-01T00:00:00.000000Z",
                "updated_at": "2024-01-15T08:30:00.000000Z",
                "deleted_at": null,
                "links": {
                    "public_url": "{{$baseUrl}}/spaces/main-branch"
                }
            },
            "address": {
                "address_line_1": "123 Customer Street",
                "address_line_2": "Unit 4B",
                "city": "Kuala Lumpur",
                "state": "Federal Territory of Kuala Lumpur",
                "country": "Malaysia",
                "postal_code": "50000",
                "full_address": "123 Customer Street, Unit 4B, Kuala Lumpur, Federal Territory of Kuala Lumpur, 50000, Malaysia"
            },
            "paidMembership": {
                "id": 123,
                "membership_status": "active",
                "membership_type_name": "VIP Gold",
                "billing_cycle": "monthly",
                "starts_at": "2024-01-01",
                "expires_at": "2024-02-01",
                "is_active": true
            }
        }
    ],
    "links": {
        "first": "{{$baseUrl}}/customers?page=1",
        "last": "{{$baseUrl}}/customers?page=5",
        "prev": null,
        "next": "{{$baseUrl}}/customers?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 5,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "{{$baseUrl}}/customers?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "{{$baseUrl}}/customers?page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "{{$baseUrl}}/customers?page=3",
                "label": "3",
                "active": false
            },
            {
                "url": "{{$baseUrl}}/customers?page=2",
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "{{$baseUrl}}/customers",
        "per_page": 15,
        "to": 15,
        "total": 68
    }
}

Create Customer

POST

https://explore.pixalink.io.test

/api/customers

requires authentication

Creates a new customer in the system.
The customer will be associated with the authenticated user's organisation.
Supports tag assignment.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

The full name of the customer. Must not be greater than 255 characters.

Example:

John Smith

string

The email address of the customer. Must be a valid RFC compliant email. Must be a valid email address.

Example:

john.smith@example.com

phone_number

string

required

The phone number of the customer in E.164 format.

Example:

+60123456789

gender

string

The gender of the customer.

Must be one of:

Example:

date_of_birth

string

The date of birth of the customer. Must be a valid date. Must be a date before 2008-05-21. Must be a date after 1914-05-21.

Example:

1990-01-01

space_id

string

The ID of the space this customer belongs to. Must belong to your organisation. The id of an existing record in the spaces table.

Example:

source

string

required

The source where the customer was acquired from.

Must be one of:

Email
Phone
Direct
Reservation
WhatsApp
StoreHub
Loyverse
Softinn
GeniusPos
WooCommerce
Shopify
Loyalty
Zeoniq
Bukku
IvendPos
LemonPos
PosPal
QnE

Example:

status

string

required

The status of the customer.

Must be one of:

Lead
Open
Replied
Opportunity
Quotation
Lost Quotation
Interested
Converted
Do Not Contact
Blocked

Example:

Lead

tier_id

string

The ID of the tier assigned to this customer. Must be a valid tier from your organisation.

Example:

is_manually_assign_tier

boolean

Whether the tier was manually assigned to the customer.

Example:

true

tags

string[]

Example:

["aliquid"]

notes

string

Additional notes about the customer. Must not be greater than 65535 characters.

Example:

Prefers to be contacted via WhatsApp

address

object

address_line_1

string

The first line of the customer's address. Must not be greater than 255 characters.

Example:

123 Main Street

address_line_2

string

The second line of the customer's address (optional). Must not be greater than 255 characters.

Example:

Unit 4B

country

string

The country of residence. This field is required when address.address_line_1 is present.

Must be one of:

Malaysia
Singapore

Example:

Malaysia

state

string

The state of residence. Must exist in our database. This field is required when address.address_line_1 is present. The name of an existing record in the states table.

Example:

Selangor

city

string

The city of residence. Must exist in our database. This field is required when address.address_line_1 is present. The name of an existing record in the cities table.

Example:

Petaling Jaya

postal_code

string

The postal code. Must be exactly 5 digits. This field is required when address.address_line_1 is present. Must be 5 digits.

Example:

46150

Response Fields

integer

The ID of the customer

name

string

The customer's full name

string

The customer's email address

phone_number

string

The customer's phone number

date_of_birth

datetime The customer's date of birth

gender

integer|null

The customer's gender (0: Female, 1: Male)

source

string

The source of the customer

status

string

The customer's current status

current_point

integer

The customer's current loyalty points

created_at

datetime The timestamp when the customer was created

updated_at

datetime The timestamp when the customer was last updated

notes

string

Optional notes about the customer

is_manually_assign_tier

integer

Whether the tier was manually assigned (0: No, 1: Yes)

current_credits

integer

The customer's current credits balance

birthday_month

integer

The customer's birth month (1-12)

space_id

integer

The ID of the space the customer belongs to

organisation_id

integer

The ID of the organisation the customer belongs to

address

object|null

The customer's address details

tier_id

integer|null

The ID of the tier the customer belongs to.

Auth

Bearer

Headers

Body

{ "name": "John Smith", "email": "john.smith@example.com", "phone_number": "+60123456789", "gender": 1, "date_of_birth": "1990-01-01", "space_id": 1, "source": "WhatsApp", "status": "Lead", "tier_id": 1, "is_manually_assign_tier": true, "tags": [ "aliquid" ], "notes": "Prefers to be contacted via WhatsApp", "address": { "address_line_1": "123 Main Street", "address_line_2": "Unit 4B", "country": "Malaysia", "state": "Selangor", "city": "Petaling Jaya", "postal_code": "46150" } }

Received response

Example request:

curl --request POST \
    "https://explore.pixalink.io.test/api/customers" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"John Smith\",
    \"email\": \"john.smith@example.com\",
    \"phone_number\": \"+60123456789\",
    \"gender\": 1,
    \"date_of_birth\": \"1990-01-01\",
    \"space_id\": 1,
    \"source\": \"WhatsApp\",
    \"status\": \"Lead\",
    \"tier_id\": 1,
    \"is_manually_assign_tier\": true,
    \"tags\": [
        \"aliquid\"
    ],
    \"notes\": \"Prefers to be contacted via WhatsApp\",
    \"address\": {
        \"address_line_1\": \"123 Main Street\",
        \"address_line_2\": \"Unit 4B\",
        \"country\": \"Malaysia\",
        \"state\": \"Selangor\",
        \"city\": \"Petaling Jaya\",
        \"postal_code\": \"46150\"
    }
}"

Example response:

{
   "data": {
       "id": 1,
       "name": "John Doe",
       "email": "john@example.com",
       "phone_number": "+60123456789",
       "gender": 1,
       "date_of_birth": "1990-01-01",
       "source": "WhatsApp",
       "status": "Lead",
       "current_point": 0,
       "notes": "Prefers evening appointments",
       "custom_properties": null,
       "is_manually_assign_tier": 0,
       "current_credits": 0,
       "birthday_month": 1,
       "space_id": 1,
       "organisation_id": 1,
       "created_at": "2025-02-01T00:00:00.000000Z",
       "updated_at": "2025-02-01T00:00:00.000000Z",
       "address": {
            "address_line_1": "No 39, Jalan Desa 1/1",
            "address_line_2": "Taman Desa",
            "city": "Petaling Jaya",
            "state": "Selangor",
            "country": "Malaysia",
            "postal_code": "58100",
            "full_address": "No 39, Jalan Desa 1/1, Taman Desa, Petaling Jaya, Selangor, 58100, Malaysia",
        }
   },
   "message": "Customer created successfully"
}

Show Customer Details

GET

https://explore.pixalink.io.test

/api/customers/{id}

requires authentication

Retrieves detailed information about a specific customer, including any requested relationships.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the customer to delete.

Example:

Query Parameters

include

string

Comma-separated list of relationships to include. Available relationships:

tier
space
address
tags
activePaidMembership.paidMembershipType (includes active paid membership with type details)

Example:

tier,activePaidMembership.paidMembershipType

Response Fields

integer

The ID of the customer

name

string

The customer's full name

string

The customer's email address

phone_number

string

The customer's phone number

date_of_birth

string

datetime The customer's date of birth

gender

integer|null

The customer's gender (0: Female, 1: Male)

source

string

The source of the customer

status

string

The customer's current status

current_point

integer

The customer's current loyalty points

created_at

string

datetime The timestamp when the customer was created

updated_at

string

datetime The timestamp when the customer was last updated

notes

string

Optional notes about the customer

is_manually_assign_tier

integer

Whether the tier was manually assigned (0: No, 1: Yes)

current_credits

integer

The customer's current credits balance

birthday_month

integer

The customer's birth month (1-12)

space_id

integer

The ID of the space the customer belongs to

organisation_id

integer

The ID of the organisation the customer belongs to

tier_id

integer|null

The customer's tier ID

tier

object|null

Tier details (included when relationship is loaded)

paidMembership

object|null

Active paid membership (included when activePaidMembership.paidMembershipType is requested)

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/customers/1?include=tier%2CactivePaidMembership.paidMembershipType" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": 1,
        "name": "John Doe",
        "email": "john@example.com",
        "phone_number": "+60123456789",
        "gender": 1,
        "date_of_birth": "1990-01-01",
        "source": "WhatsApp",
        "status": "Lead",
        "current_point": 0,
        "notes": "Prefers evening appointments",
        "custom_properties": null,
        "is_manually_assign_tier": 0,
        "current_credits": 0,
        "birthday_month": 1,
        "space_id": 1,
        "organisation_id": 1,
        "created_at": "2025-02-01T00:00:00.000000Z",
        "updated_at": "2025-02-01T00:00:00.000000Z",
        "tier_id": 1,
        "tier": {
            "id": 1,
            "name": "Bronze",
            "points_required": 0
        },
        "paidMembership": {
            "id": 123,
            "membership_status": "active",
            "membership_type_name": "VIP Gold",
            "billing_cycle": "monthly",
            "starts_at": "2024-01-01",
            "expires_at": "2024-02-01",
            "is_active": true
        }
    }
}

Update Customer

PUT

PATCH

https://explore.pixalink.io.test

/api/customers/{id}

requires authentication

Updates an existing customer's information.
All fields are optional.
Existing tags will be synced with the provided tags array if included.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the customer to delete.

Example:

Body Parameters

name

string

optional The customer's full name.

Example:

John Doe

string

optional A valid email address.

Example:

john@example.com

phone_number

string

optional Phone number with country code.

Example:

+60123456789

gender

integer|null

optional Gender (0: Female, 1: Male). If present, must be one of:

0 (Female)
1 (Male)

Example:

date_of_birth

date

optional The customer's birthdate (Y-m-d format).

Example:

1990-01-01

space_id

integer

optional The ID of the space this customer belongs to.

Example:

source

string

optional Source of the customer. Must be one of:

Email
Phone
Direct
Reservation
WhatsApp
StoreHub
Loyverse
Softinn
Loyalty

Example:

status

string

optional Customer's status. Must be one of:

Lead
Open
Replied
Opportunity
Quotation
Lost Quotation
Interested
Converted
Do Not Contact
Blocked

Example:

Lead

tier_id

string

The ID of the tier assigned to this customer. Must be a valid tier from your organisation.

Example:

is_manually_assign_tier

boolean

Whether the tier was manually assigned to the customer.

Example:

true

tags

string[]

optional Array of tag IDs to sync with the customer. Will remove any existing tags not in the array.

Example:

["VIP","Frequent Visitor"]

notes

string

optional Additional notes about the customer.

Example:

Prefers evening appointments

address

object

address_line_1

string

optional The first line of the address.

Example:

No 39, Jalan Desa 1/1

address_line_2

string

optional The second line of the address.

Example:

Taman Desa

country

string

optional|required_with:address.address_line_1 The country (Malaysia or Singapore).

Example:

Malaysia

state

string

optional|required_with:address.address_line_1 The state name.

Example:

Selangor

city

string

optional|required_with:address.address_line_1 The city name.

Example:

Petaling Jaya

postal_code

string

optional|required_with:address.address_line_1 5-digit postal code.

Example:

58100

Response Fields

integer

The ID of the customer

name

string

The customer's full name

string

The customer's email address

phone_number

string

The customer's phone number

date_of_birth

datetime The customer's date of birth

gender

integer|null

The customer's gender (0: Female, 1: Male)

source

string

The source of the customer

status

string

The customer's current status

current_point

integer

The customer's current loyalty points

created_at

datetime The timestamp when the customer was created

updated_at

datetime The timestamp when the customer was last updated

notes

string

Optional notes about the customer

is_manually_assign_tier

integer

Whether the tier was manually assigned (0: No, 1: Yes)

current_credits

integer

The customer's current credits balance

birthday_month

integer

The customer's birth month (1-12)

space_id

integer

The ID of the space the customer belongs to

organisation_id

integer

The ID of the organisation the customer belongs to

address

object|null

The customer's address details

tier_id

integer|null

The ID of the tier the customer belongs to.

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "John Doe", "email": "john@example.com", "phone_number": "+60123456789", "gender": "1", "date_of_birth": "1990-01-01", "space_id": 1, "source": "WhatsApp", "status": "Lead", "tier_id": 1, "is_manually_assign_tier": true, "tags": [ "VIP", "Frequent Visitor" ], "notes": "Prefers evening appointments", "address": { "address_line_1": "No 39, Jalan Desa 1\/1", "address_line_2": "Taman Desa", "country": "Malaysia", "state": "Selangor", "city": "Petaling Jaya", "postal_code": "58100" } }

Received response

Example request:

curl --request PUT \
    "https://explore.pixalink.io.test/api/customers/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"John Doe\",
    \"email\": \"john@example.com\",
    \"phone_number\": \"+60123456789\",
    \"gender\": \"1\",
    \"date_of_birth\": \"1990-01-01\",
    \"space_id\": 1,
    \"source\": \"WhatsApp\",
    \"status\": \"Lead\",
    \"tier_id\": 1,
    \"is_manually_assign_tier\": true,
    \"tags\": [
        \"VIP\",
        \"Frequent Visitor\"
    ],
    \"notes\": \"Prefers evening appointments\",
    \"address\": {
        \"address_line_1\": \"No 39, Jalan Desa 1\\/1\",
        \"address_line_2\": \"Taman Desa\",
        \"country\": \"Malaysia\",
        \"state\": \"Selangor\",
        \"city\": \"Petaling Jaya\",
        \"postal_code\": \"58100\"
    }
}"

Example response:

{
    "data": {
        "id": 1,
        "name": "John Doe",
        "email": "john@example.com",
        "phone_number": "+60123456789",
        "gender": 1,
        "date_of_birth": "1990-01-01",
        "source": "WhatsApp",
        "status": "Lead",
        "current_point": 0,
        "notes": "Prefers evening appointments",
        "custom_properties": null,
        "is_manually_assign_tier": 0,
        "current_credits": 0,
        "birthday_month": 1,
        "space_id": 1,
        "organisation_id": 1,
        "created_at": "2025-02-01T00:00:00.000000Z",
        "updated_at": "2025-02-01T00:00:00.000000Z",
        "address": {
             "address_line_1": "No 39, Jalan Desa 1/1",
             "address_line_2": "Taman Desa",
             "city": "Petaling Jaya",
             "state": "Selangor",
             "country": "Malaysia",
             "postal_code": "58100",
             "full_address": "No 39, Jalan Desa 1/1, Taman Desa, Petaling Jaya, Selangor, 58100, Malaysia",
        }
    },
    "message": "Customer updated successfully"
}

Delete Customer

DELETE

https://explore.pixalink.io.test

/api/customers/{id}

requires authentication

Queues a customer for deletion.
The deletion process runs asynchronously.
All related data will be deleted including rewards, transactions, and media (if any).

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the customer to delete.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://explore.pixalink.io.test/api/customers/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "message": "Customer deletion has been queued and will be processed shortly"
}

Bulk Import Customers

POST

https://explore.pixalink.io.test

/api/customers/bulk-import

requires authentication

Import multiple customers asynchronously.
The operation is queued and processed in chunks of 100 records.
Limited to 1,000 customers per request and rate limited to 10 requests per minute.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

customers

object[]

required

Array of customers to import (max 1,000). Must not have more than 1000 items.

name

string

required

Full name of the customer. Must not be greater than 255 characters.

Example:

John Doe

string

Email address (must be unique per organisation). Must be a valid email address.

Example:

john@example.com

phone_number

string

required

Phone number with country code (must be unique per organisation).

Example:

+60123456789

gender

string

Gender (0: Female, 1: Male).

Must be one of:

Example:

date_of_birth

string

Date of birth in Y-m-d format. Must be a valid date.

Example:

1990-01-01

source

string

Customer source. Must be one of: Email, Phone, Direct, Reservation, WhatsApp, StoreHub, Loyverse, Softinn, WooCommerce, Shopify, Loyalty, Zeoniq, Bukku, IvendPos, LemonPos, PosPal.

Must be one of:

Email
Phone
Direct
Reservation
WhatsApp
StoreHub
Loyverse
Softinn
GeniusPos
WooCommerce
Shopify
Loyalty
Zeoniq
Bukku
IvendPos
LemonPos
PosPal
QnE

Example:

status

string

Customer status. Must be one of: Lead, Open, Replied, Opportunity, Quotation, Lost Quotation, Interested, Converted, Do Not Contact, Blocked.

Must be one of:

Lead
Open
Replied
Opportunity
Quotation
Lost Quotation
Interested
Converted
Do Not Contact
Blocked

Example:

Lead

notes

string

Additional notes about the customer.

Example:

VIP customer

tags

string[]

required

Example:

["animi"]

space_id

string

The ID of the space to assign all customers to. The id of an existing record in the spaces table.

Example:

Auth

Bearer

Headers

Body

{ "customers": [ { "name": "John Doe", "email": "john@example.com", "phone_number": "+60123456789", "gender": "1", "date_of_birth": "1990-01-01", "source": "WhatsApp", "status": "Lead", "notes": "VIP customer", "tags": [ "animi" ] } ], "space_id": 1 }

Received response

Example request:

curl --request POST \
    "https://explore.pixalink.io.test/api/customers/bulk-import" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"customers\": [
        {
            \"name\": \"John Doe\",
            \"email\": \"john@example.com\",
            \"phone_number\": \"+60123456789\",
            \"gender\": 1,
            \"date_of_birth\": \"1990-01-01\",
            \"source\": \"WhatsApp\",
            \"status\": \"Lead\",
            \"notes\": \"VIP customer\",
            \"tags\": [
                \"VIP\",
                \"WhatsApp\"
            ]
        }
    ],
    \"space_id\": 1
}"

Example response:

{
    "message": "Bulk customer import has been queued and will be processed shortly"
}

Organisations

List Organisations

GET

https://explore.pixalink.io.test

/api/organisations

requires authentication

Returns a paginated list of organisations. Vendors see only their own organisation. Super admins with "View Any Organisation" permission see all organisations.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

filter[name]

string

Filter by organisation name (partial match).

Example:

Acme

sort

string

Sort field. Allowed: id, name, created_at.

Example:

-id

per_page

integer

Records per page.

Example:

Response Fields

integer

The organisation ID.

name

string

The organisation name.

friendly_name

string|null

Short display name.

string|null

Contact email.

phone_number

string|null

Contact phone.

pos_provider

string|null

POS provider identifier.

ecommerce_provider

string|null

E-commerce provider identifier.

features

object

Read-only feature flags for the organisation.

created_at

string

datetime When the organisation was created.

updated_at

string

datetime When the organisation was last updated.

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/organisations?filter%5Bname%5D=Acme&sort=-id&per_page=15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "name": "Acme Corp",
            "friendly_name": "Acme",
            "email": "hello@acme.com",
            "phone_number": "+60123456789",
            "pos_provider": null,
            "ecommerce_provider": null,
            "features": {
                "loyalty": true,
                "credits": false,
                "tiering": false,
                "ecommerce_integration": false
            },
            "created_at": "2024-01-01T00:00:00.000000Z",
            "updated_at": "2024-01-01T00:00:00.000000Z"
        }
    ],
    "links": {
        "first": "...",
        "last": "...",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 15,
        "to": 1,
        "total": 1
    }
}

Show Organisation

GET

https://explore.pixalink.io.test

/api/organisations/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The organisation ID.

Example:

Response Fields

integer

The organisation ID.

name

string

The organisation name.

friendly_name

string|null

Short display name.

string|null

Contact email.

phone_number

string|null

Contact phone.

pos_provider

string|null

POS provider identifier.

ecommerce_provider

string|null

E-commerce provider identifier.

features

object

Read-only feature flags for the organisation.

created_at

datetime When the organisation was created.

updated_at

datetime When the organisation was last updated.

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/organisations/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": 1,
        "name": "Acme Corp",
        "features": {
            "loyalty": true,
            "credits": false,
            "tiering": false,
            "ecommerce_integration": false
        }
    }
}

Update Organisation

PUT

PATCH

https://explore.pixalink.io.test

/api/organisations/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The organisation ID.

Example:

Body Parameters

name

string

The name of the organisation. Must not be greater than 255 characters.

Example:

Acme Corp

friendly_name

string

A short display name for the organisation. Must not be greater than 255 characters.

Example:

Acme

string

Contact email address for the organisation. Must be a valid email address.

Example:

hello@acme.com

phone_number

string

Contact phone number for the organisation. Must not be greater than 50 characters.

Example:

+60123456789

Response Fields

integer

The organisation ID.

name

string

The organisation name.

friendly_name

string|null

Short display name.

string|null

Contact email.

phone_number

string|null

Contact phone.

pos_provider

string|null

POS provider identifier.

ecommerce_provider

string|null

E-commerce provider identifier.

features

object

Read-only feature flags for the organisation.

created_at

datetime When the organisation was created.

updated_at

datetime When the organisation was last updated.

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "Acme Corp", "friendly_name": "Acme", "email": "hello@acme.com", "phone_number": "+60123456789" }

Received response

Example request:

curl --request PUT \
    "https://explore.pixalink.io.test/api/organisations/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Acme Corp\",
    \"friendly_name\": \"Acme\",
    \"email\": \"hello@acme.com\",
    \"phone_number\": \"+60123456789\"
}"

Example response:

{
    "data": {
        "id": 1,
        "name": "Updated Name"
    },
    "message": "Organisation updated successfully"
}

Subscriptions

Stripe subscriptions belonging to an organisation.

List Organisation Subscriptions

GET

https://explore.pixalink.io.test

/api/organisations/{organisation_id}/subscriptions

requires authentication

Returns a paginated list of Stripe subscriptions for the specified organisation. Only the organisation's own members can access this endpoint.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

organisation_id

integer

required

The organisation ID.

Example:

Query Parameters

per_page

integer

Records per page.

Example:

Response Fields

integer

The subscription ID.

type

string

The subscription type (e.g. "default").

stripe_id

string

The Stripe subscription ID.

stripe_status

string

Subscription status (active, trialing, canceled, etc.).

stripe_price

string|null

The Stripe price ID for single-price subscriptions.

quantity

int|null

Quantity for metered subscriptions.

trial_ends_at

datetime|null When the trial period ends.

ends_at

datetime|null When the subscription ends or was canceled.

created_at

string

datetime When the subscription was created.

updated_at

string

datetime When the subscription was last updated.

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/organisations/1/subscriptions?per_page=15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "type": "default",
            "stripe_id": "sub_1ABC",
            "stripe_status": "active",
            "stripe_price": "price_1ABC",
            "quantity": 1,
            "trial_ends_at": null,
            "ends_at": null,
            "created_at": "2024-01-01T00:00:00.000000Z",
            "updated_at": "2024-01-01T00:00:00.000000Z"
        }
    ],
    "links": {
        "first": "...",
        "last": "...",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "total": 1
    }
}

POS Credits

List POS credits

GET

https://explore.pixalink.io.test

/api/posCredit

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

filter[status]

string

Filter by status (pending, adopted).

Example:

adopted

filter[space_id]

integer

Filter by space ID.

Example:

filter[ref_id]

string

Filter by ref_id.

Example:

REF-123

filter[transaction_timestamp]

string

Filter by date (YYYY-MM-DD).

Example:

2025-05-06

filter[amount]

string

Filter by amount with operators.

Example:

>50

sort

string

Sort field. Allowed: transaction_timestamp, amount, created_at.

Example:

-created_at

include

string

Relationships to include (space).

Example:

space

per_page

integer

Records per page.

Example:

Response Fields

integer

The POS credit ID.

ref_id

string

Unique reference ID from the POS system.

transaction_timestamp

string

datetime Timestamp of the POS transaction.

amount

string

decimal Credit amount in dollars (negative for refunds).

status

string

Status of the POS credit: pending or adopted.

pos_provider

string

The POS provider identifier.

organisation_id

integer

The owning organisation ID.

space_id

integer|null

The space where the credit was issued.

credit_id

integer|null

ID of the linked credit wallet entry (when adopted).

void_credit_id

integer|null

ID of the void credit entry (when voided).

payload

object

The raw POS payload.

created_at

string

datetime When the record was created.

updated_at

string

datetime When the record was last updated.

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/posCredit?filter%5Bstatus%5D=adopted&filter%5Bspace_id%5D=1&filter%5Bref_id%5D=REF-123&filter%5Btransaction_timestamp%5D=2025-05-06&filter%5Bamount%5D=%3E50&sort=-created_at&include=space&per_page=15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "ref_id": "CREDIT-12345",
            "transaction_timestamp": "2025-05-06T14:30:00.000000Z",
            "amount": "50.00",
            "status": "adopted",
            "pos_provider": "eats365",
            "organisation_id": 1,
            "space_id": 1,
            "credit_id": 101,
            "void_credit_id": null,
            "payload": {
                "terminal": "T001"
            },
            "created_at": "2025-05-06T14:30:01.000000Z",
            "updated_at": "2025-05-06T14:30:01.000000Z"
        }
    ],
    "links": {
        "first": "...",
        "last": "...",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 15,
        "to": 1,
        "total": 1
    }
}

Create POS Credit

POST

https://explore.pixalink.io.test

/api/posCredit

requires authentication

Ingests a POS credit record. If a customer is identified (via customer_id or phone_number), a credit wallet entry is created and the POS credit status is set to adopted. Without customer identification the record is stored as pending for later adoption.

Positive amounts create a Top Up credit.
Negative amounts create a Refund credit.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

ref_id

string

required

A unique reference ID for this POS credit transaction. Must be unique within the organisation.

Example:

REF-20250506-001

transaction_timestamp

string

required

The date and time when the transaction occurred at the POS terminal. Must be a valid date.

Example:

2025-05-06T14:30:00Z

amount

integer

required

Transaction amount in cents. Positive for top-ups, negative for refunds.

Example:

5000

payload

string

required

Raw payload from the POS system. Can be a JSON string or object.

Example:

{"receipt_no":"RCP-001","terminal_id":"T01"}

space_id

integer

required

The ID of the space (outlet) where this credit transaction occurred. Must belong to the authenticated organisation. The id of an existing record in the spaces table.

Example:

customer_id

integer

The ID of the customer to link this credit to. Optional — credit will be auto-adopted if provided. The id of an existing record in the customers table.

Example:

phone_number

string

Customer phone number as fallback for identification. Will be normalized to E.164 format.

Example:

+60123456789

remarks

string

Optional remarks for this POS credit transaction. Max 500 characters. Must not be greater than 500 characters.

Example:

Top-up via Eats365 POS

Response Fields

integer

The ID of the created POS credit.

ref_id

string

The unique reference ID.

transaction_timestamp

string

datetime The time of the transaction.

amount

string

decimal The credit amount in dollars.

status

string

Status of the POS credit: pending or adopted.

pos_provider

string

The POS provider.

credit_id

integer|null

ID of the linked credit wallet entry, if adopted.

void_credit_id

integer|null

ID of the void credit entry, if voided.

organisation_id

integer

The ID of the owning organisation.

space_id

integer|null

The space where the credit was issued.

payload

object

The raw POS payload data.

created_at

string

datetime When the POS credit record was created.

updated_at

string

datetime When the POS credit record was last updated.

Auth

Bearer

Headers

Body

{ "ref_id": "REF-20250506-001", "transaction_timestamp": "2025-05-06T14:30:00Z", "amount": 5000, "payload": { "receipt_no": "RCP-001", "terminal_id": "T01" }, "space_id": 1, "customer_id": 42, "phone_number": "+60123456789", "remarks": "Top-up via Eats365 POS" }

Received response

Example request:

curl --request POST \
    "https://explore.pixalink.io.test/api/posCredit" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ref_id\": \"REF-20250506-001\",
    \"transaction_timestamp\": \"2025-05-06T14:30:00Z\",
    \"amount\": 5000,
    \"payload\": {
        \"receipt_no\": \"RCP-001\",
        \"terminal_id\": \"T01\"
    },
    \"space_id\": 1,
    \"customer_id\": 42,
    \"phone_number\": \"+60123456789\",
    \"remarks\": \"Top-up via Eats365 POS\"
}"

Example response:

{
    "data": {
        "id": 1,
        "ref_id": "CREDIT-12345",
        "transaction_timestamp": "2025-05-06T14:30:00.000000Z",
        "amount": "50.00",
        "status": "adopted",
        "pos_provider": "eats365",
        "organisation_id": 1,
        "space_id": 1,
        "credit_id": 101,
        "void_credit_id": null,
        "payload": {
            "terminal": "T001"
        },
        "created_at": "2025-05-06T14:30:01.000000Z",
        "updated_at": "2025-05-06T14:30:01.000000Z"
    }
}

Void POS Credit

POST

https://explore.pixalink.io.test

/api/posCredit/{posCredit_id}/void

requires authentication

Voids an adopted POS credit record by creating a deduct entry in the customer's credit wallet.

Idempotency: Voiding an already-voided POS credit returns success without creating a duplicate entry.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

posCredit_id

integer

required

The ID of the posCredit.

Example:

posCredit

integer

required

The ID of the POS credit to void.

Example:

Body Parameters

customer_id

integer

The ID of the customer. Required only when the POS credit has no linked customer. Must belong to the authenticated organisation. The id of an existing record in the customers table.

Example:

remarks

string

Optional remarks for this void operation. Max 500 characters. Must not be greater than 500 characters.

Example:

Voided per customer request

Auth

Bearer

Headers

URL Parameters

Body

{ "customer_id": 42, "remarks": "Voided per customer request" }

Received response

Example request:

curl --request POST \
    "https://explore.pixalink.io.test/api/posCredit/1/void" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"customer_id\": 42,
    \"remarks\": \"Voided per customer request\"
}"

Example response:

{
    "message": "POS credit voided successfully.",
    "data": {
        "id": 202,
        "customer_id": 42,
        "amount": 50,
        "operation": "-",
        "type": "Deduct",
        "remarks": "Voided POS credit #1",
        "created_at": "2025-05-06T15:00:00.000000Z"
    }
}

POS Transaction

List POS transactions

GET

https://explore.pixalink.io.test

/api/posTransaction

requires authentication

Returns a paginated list of POS transactions for the authenticated organisation. Results can be filtered, sorted and paginated.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

filter[status]

string

Filter by transaction status.

Example:

adopted

filter[space_id]

string

Filter by space UUID.

Example:

filter[transaction_time]

string

Filter by transaction date (Y-m-d format).

Example:

2025-05-06

filter[amount_min]

number

Filter by minimum amount.

Example:

filter[amount_max]

number

Filter by maximum amount.

Example:

500

filter[ref_id]

string

Filter by reference ID.

Example:

TRX-123

sort

string

Sort by column (prefixed with - for descending). Available options: transaction_time, amount, created_at.

Example:

-transaction_time

include

string

Include related resources. Available options: space.

Example:

space

page

integer

Page number.

Example:

per_page

integer

Items per page (max 100).

Example:

Response Fields

integer

The unique ID of the POS transaction

ref_id

string

The reference ID of the transaction

transaction_time

string

datetime The date and time when the transaction occurred

amount

number

decimal The transaction amount

status

string

The status of the transaction

pos_provider

string

The POS provider used for this transaction

created_at

string

datetime The creation timestamp

updated_at

string

datetime The last update timestamp

space

object

The related space (when included)

payload

object

The raw POS payload data.

is_refund

boolean

Whether this transaction is a refund.

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/posTransaction?filter%5Bstatus%5D=adopted&filter%5Bspace_id%5D=1&filter%5Btransaction_time%5D=2025-05-06&filter%5Bamount_min%5D=50&filter%5Bamount_max%5D=500&filter%5Bref_id%5D=TRX-123&sort=-transaction_time&include=space&page=1&per_page=15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "ref_id": "TRX-12345678",
            "transaction_time": "2025-05-06T14:30:00Z",
            "amount": 150,
            "status": "adopted",
            "pos_provider": "provider_name",
            "organisation_id": 1,
            "created_at": "2025-05-06T14:35:00Z",
            "updated_at": "2025-05-06T14:35:00Z",
            "space": {
                "id": "1",
                "name": "Main Store",
                "slug": "main-store"
            }
        }
    ],
    "links": {
        "first": "{{$baseUrl}}/pos-transactions?page=1",
        "last": "{{$baseUrl}}/pos-transactions?page=5",
        "prev": null,
        "next": "{{$baseUrl}}/pos-transactions?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 5,
        "path": "{{$baseUrl}}/pos-transactions",
        "per_page": 15,
        "to": 15,
        "total": 75
    }
}

Create a new POS transaction

POST

https://explore.pixalink.io.test

/api/posTransaction

requires authentication

This endpoint creates a new POS transaction in the system. If a customer identifier (customer_id or phone_number) is provided, the transaction will be automatically adopted and a corresponding transaction record will be created for the customer.

Partial Refunds: To process a partial refund, send a negative amount. Optionally provide the original_ref_id of the transaction being refunded. The refund will deduct proportional points from the customer's balance.

Blind Refunds: If no original_ref_id is provided with a negative amount (blind refund), points will be deducted using the formula: refund_amount × tier_multiplier (or 1:1 if customer has no tier).

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

space_id

string

The UUID of the space where the transaction occurred. Must belong to the authenticated organisation.

Example:

ref_id

string

required

A unique reference ID for the transaction. Must be unique across all POS transactions.

Example:

TRX-12345678

transaction_time

datetime

required

The date and time when the transaction occurred. Must be a valid date format.

Example:

2025-05-06T14:30:00Z

amount

integer

required

The transaction amount in cents. Positive for purchases, negative for partial refunds.

Example:

15000

payload

json

required

Additional transaction details in JSON format.

Example:

{"items": [{"name": "Product A", "quantity": 2, "price": 7500}], "payment_method": "credit_card", "terminal_id": "T001"}

customer_id

integer

The ID of the customer associated with this transaction. Must exist in the customers table.

Example:

phone_number

string

The customer's phone number in E.164 format.

Example:

+60123456789

original_ref_id

string

The ref_id of the original transaction being refunded. Optional for refunds - if provided, points are deducted proportionally; if not provided (blind refund), points = refund_amount × tier_multiplier.

Example:

TRX-ORIGINAL-001

remarks

string

Free-form text describing the purchase items or refund reason. Max 500 characters.

Example:

2x Coffee, 1x Sandwich

Response Fields

integer

The ID of the created POS transaction.

ref_id

string

The unique reference ID of the transaction.

transaction_time

string

datetime The date and time when the transaction occurred.

amount

number

decimal The transaction amount in decimal format (converted from cents). Negative for refunds.

status

string

The status of the transaction. Possible values: 'pending', 'adopted'.

pos_provider

string

The POS provider used for this transaction.

remarks

string

Free-form text describing the purchase or refund reason.

is_refund

boolean

True if this is a partial refund transaction.

created_at

string

datetime The timestamp when the record was created.

updated_at

string

datetime The timestamp when the record was last updated.

payload

object

The raw POS payload data.

Auth

Bearer

Headers

Body

{ "space_id": "1", "ref_id": "TRX-12345678", "transaction_time": "2025-05-06T14:30:00Z", "amount": 15000, "payload": "{\"items\": [{\"name\": \"Product A\", \"quantity\": 2, \"price\": 7500}], \"payment_method\": \"credit_card\", \"terminal_id\": \"T001\"}", "customer_id": 42, "phone_number": "+60123456789", "original_ref_id": "TRX-ORIGINAL-001", "remarks": "2x Coffee, 1x Sandwich" }

Received response

Example request:

curl --request POST \
    "https://explore.pixalink.io.test/api/posTransaction" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"space_id\": \"1\",
    \"ref_id\": \"TRX-12345678\",
    \"transaction_time\": \"2025-05-06T14:30:00Z\",
    \"amount\": 15000,
    \"payload\": \"{\\\"items\\\": [{\\\"name\\\": \\\"Product A\\\", \\\"quantity\\\": 2, \\\"price\\\": 7500}], \\\"payment_method\\\": \\\"credit_card\\\", \\\"terminal_id\\\": \\\"T001\\\"}\",
    \"customer_id\": 42,
    \"phone_number\": \"+60123456789\",
    \"original_ref_id\": \"TRX-ORIGINAL-001\",
    \"remarks\": \"2x Coffee, 1x Sandwich\"
}"

Example response:

{
    "data": {
        "id": 1,
        "ref_id": "TRX-12345678",
        "transaction_time": "2025-05-06T14:30:00Z",
        "amount": 150,
        "status": "pending",
        "pos_provider": "provider_name",
        "space_id": "1",
        "organisation_id": 1,
        "created_at": "2025-05-06T14:35:00Z",
        "updated_at": "2025-05-06T14:35:00Z"
    }
}

Void POS Transaction

POST

https://explore.pixalink.io.test

/api/posTransaction/{posTransaction_id}/void

requires authentication

Voids an adopted POS transaction and deducts the exact points that were earned. This generic endpoint works for all POS providers.

The void operation uses the linked transaction_id to deduct the exact amount of points that were earned, accounting for tier multipliers. For example:

Customer with 2x Gold tier earns 200 points on $100 purchase
Voiding deducts exactly 200 points (not 100)

Idempotency: Attempting to void the same transaction multiple times will return success but only create one void transaction.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

posTransaction_id

integer

required

The ID of the posTransaction.

Example:

1140884

posTransaction

integer

required

The ID of the POS transaction to void.

Example:

123

Body Parameters

customer_id

integer

required

The ID of the customer who earned the points.

Example:

456

remarks

string

Optional custom remarks for the void transaction.

Example:

"Transaction voided - customer request"

Auth

Bearer

Headers

URL Parameters

Body

{ "customer_id": 456, "remarks": "\"Transaction voided - customer request\"" }

Received response

Example request:

curl --request POST \
    "https://explore.pixalink.io.test/api/posTransaction/1140884/void" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"customer_id\": 456,
    \"remarks\": \"\\\"Transaction voided - customer request\\\"\"
}"

Example response:

{
    "message": "POS transaction voided successfully.",
    "data": {
        "id": 789,
        "customer_id": 456,
        "amount": 200,
        "operation": "-",
        "remarks": "Transaction voided from POS System (Ref: REF-12345)",
        "created_at": "2025-10-25T14:30:00Z"
    }
}

Paid Membership Types

List Paid Membership Types

GET

https://explore.pixalink.io.test

/api/paid_membership_types

requires authentication

Returns a paginated list of paid membership type catalog entries belonging to the authenticated user's organisation. Supports filtering and sorting via query parameters.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

filter[is_active]

boolean

Filter by active status.

Example:

true

filter[name]

string

Filter by membership type name (partial match).

Example:

Gold

sort

string

Sort field and direction. Prefix with - for descending. Available fields: sort, name, created_at. Defaults to sort.

Example:

-created_at

per_page

integer

Number of records per page. Defaults to 15.

Example:

Response Fields

integer

The unique identifier of the paid membership type.

organisation_id

integer

The organisation this catalog entry belongs to.

name

string

The display name of the membership type (e.g. "VIP Gold").

description

string

The description shown to customers.

pricing_options

string[]

List of available billing cycles and prices (price stored in cents).

benefits

string[]

Benefit list configured for marketing display.

sort

integer

Display order; lower values appear first.

is_active

boolean

Whether the membership type is currently sellable.

created_at

string

datetime Created timestamp.

updated_at

string

datetime Last-updated timestamp.

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/paid_membership_types?filter%5Bis_active%5D=1&filter%5Bname%5D=Gold&sort=-created_at&per_page=15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "organisation_id": 1,
            "name": "VIP Gold",
            "description": "Priority support and birthday rewards.",
            "pricing_options": [
                {
                    "cycle": "monthly",
                    "price": 3500
                },
                {
                    "cycle": "yearly",
                    "price": 35000
                }
            ],
            "benefits": [
                {
                    "icon": "heroicon-o-star",
                    "heading": "Priority Support",
                    "description": "Get priority customer support"
                }
            ],
            "sort": 1,
            "is_active": true,
            "created_at": "2025-01-31T21:16:49.000000Z",
            "updated_at": "2025-01-31T21:16:49.000000Z"
        }
    ],
    "links": {
        "first": "...",
        "last": "...",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "...",
        "per_page": 15,
        "to": 1,
        "total": 1
    }
}

Show Paid Membership Type

GET

https://explore.pixalink.io.test

/api/paid_membership_types/{id}

requires authentication

Retrieves a single paid membership type by ID. Cross-organisation access returns 404.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the paid membership type.

Example:

paid_membership_type

integer

required

The ID of the paid membership type.

Example:

Response Fields

integer

The unique identifier of the paid membership type.

organisation_id

integer

The organisation this catalog entry belongs to.

name

string

The display name of the membership type.

description

string

The description shown to customers.

pricing_options

string[]

List of available billing cycles and prices (price stored in cents).

benefits

string[]

Benefit list configured for marketing display.

sort

integer

Display order; lower values appear first.

is_active

boolean

Whether the membership type is currently sellable.

created_at

string

datetime Created timestamp.

updated_at

string

datetime Last-updated timestamp.

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/paid_membership_types/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": 1,
        "organisation_id": 1,
        "name": "VIP Gold",
        "description": "Priority support and birthday rewards.",
        "pricing_options": [
            {
                "cycle": "monthly",
                "price": 3500
            }
        ],
        "benefits": [],
        "sort": 1,
        "is_active": true,
        "created_at": "2025-01-31T21:16:49.000000Z",
        "updated_at": "2025-01-31T21:16:49.000000Z"
    }
}

Payments

List Payments

GET

https://explore.pixalink.io.test

/api/payments

requires authentication

Get a paginated list of payments and refunds belonging to the authenticated user's organisation. Results can be filtered, sorted and expanded with related data through query parameters.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

filter[type]

string

Filter by record type. Available values: payment, refund.

Example:

payment

filter[status]

integer

Filter by payment status code (e.g. 0 = pending, 1 = success, 2 = failed).

Example:

filter[method]

string

Filter by payment method (e.g. commerce_pay, manual, credit).

Example:

commerce_pay

filter[payable_type]

string

Filter by the fully-qualified class of what was paid for.

Example:

App\Models\Reservation

filter[created_at]

string

Filter by creation date with operators.

Example:

>2024-01-01

filter[completed_at]

string

Filter by completion date with operators.

Example:

>2024-01-01

sort

string

Sort field. Allowed: created_at, completed_at, amount. Use - for descending.

Example:

-created_at

include

string

Comma-separated relationships to include. Allowed: refunds, refundingPayment.

Example:

refunds

per_page

integer

Number of records per page.

Example:

Response Fields

integer

The unique identifier of the payment.

type

string

The record type (payment or refund).

method

string

The payment method (e.g. commerce_pay, manual, credit).

reference_id

string|null

The gateway transaction reference, if any.

amount

number

The payment amount in major currency units.

currency_code

string

The ISO currency code (e.g. MYR).

status

integer

The payment status code.

is_manual

boolean

Whether the payment was recorded manually (no gateway).

payment_type

string|null

Business payment type, if recorded in metadata.

source

string|null

Origin of the payment, if recorded in metadata.

attempted_at

string

datetime|null When the payment was attempted.

completed_at

string

datetime|null When the payment completed.

failed_at

datetime|null When the payment failed.

failure_reason

string|null

Reason for failure, if failed.

created_at

string

datetime When the record was created.

refunds

string[]

Refund records linked to this payment (only when include=refunds).

refunding_payment

object|null

The original payment this record refunds (only when include=refundingPayment).

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/payments?filter%5Btype%5D=payment&filter%5Bstatus%5D=1&filter%5Bmethod%5D=commerce_pay&filter%5Bpayable_type%5D=App%5CModels%5CReservation&filter%5Bcreated_at%5D=%3E2024-01-01&filter%5Bcompleted_at%5D=%3E2024-01-01&sort=-created_at&include=refunds&per_page=15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "type": "payment",
            "method": "commerce_pay",
            "reference_id": "TXN-1234567890",
            "amount": 150,
            "currency_code": "MYR",
            "status": 1,
            "is_manual": false,
            "payment_type": null,
            "source": null,
            "attempted_at": "2025-01-01T00:00:00+00:00",
            "completed_at": "2025-01-01T00:01:00+00:00",
            "failed_at": null,
            "failure_reason": null,
            "created_at": "2025-01-01T00:00:00+00:00"
        }
    ],
    "links": {
        "first": "...",
        "last": "...",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "per_page": 15,
        "total": 1
    }
}

Show Payment

GET

https://explore.pixalink.io.test

/api/payments/{id}

requires authentication

Retrieve detailed information about a specific payment or refund.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the payment.

Example:

payment

integer

required

The ID of the payment.

Example:

Query Parameters

include

string

Comma-separated relationships to include. Allowed: refunds, refundingPayment.

Example:

refunds

Response Fields

integer

The unique identifier of the payment.

type

string

The record type (payment or refund).

method

string

The payment method (e.g. commerce_pay, manual, credit).

reference_id

string|null

The gateway transaction reference, if any.

amount

number

The payment amount in major currency units.

currency_code

string

The ISO currency code (e.g. MYR).

status

integer

The payment status code.

is_manual

boolean

Whether the payment was recorded manually (no gateway).

payment_type

string|null

Business payment type, if recorded in metadata.

source

string|null

Origin of the payment, if recorded in metadata.

attempted_at

string

datetime|null When the payment was attempted.

completed_at

string

datetime|null When the payment completed.

failed_at

datetime|null When the payment failed.

failure_reason

string|null

Reason for failure, if failed.

created_at

string

datetime When the record was created.

refunds

string[]

Refund records linked to this payment (only when include=refunds).

refunding_payment

object|null

The original payment this record refunds (only when include=refundingPayment).

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/payments/1?include=refunds" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": 1,
        "type": "payment",
        "method": "commerce_pay",
        "reference_id": "TXN-1234567890",
        "amount": 150,
        "currency_code": "MYR",
        "status": 1,
        "is_manual": false,
        "payment_type": null,
        "source": null,
        "attempted_at": "2025-01-01T00:00:00+00:00",
        "completed_at": "2025-01-01T00:01:00+00:00",
        "failed_at": null,
        "failure_reason": null,
        "created_at": "2025-01-01T00:00:00+00:00"
    }
}

Plans

List Plans

GET

https://explore.pixalink.io.test

/api/plans

requires authentication

Returns a paginated list of active subscription plans, including their prices.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

filter[name]

string

Filter by plan name (partial match).

Example:

Premium

sort

string

Sort field. Allowed: id, name, created_at.

Example:

-id

per_page

integer

Records per page.

Example:

Response Fields

integer

The plan ID.

name

string

The plan name.

description

string|null

The plan description.

is_active

boolean

Whether the plan is active.

features

object

Feature flags and limits for this plan.

prices

string[]

Active prices for this plan across currencies and billing periods.

integer

The price ID.

currency

string

3-letter currency code (e.g. MYR, USD).

billing_period

string

Billing period (monthly, quarterly, semi_annual, yearly).

amount

number

Price amount in major units.

stripe_price_id

string|null

The Stripe price ID.

is_active

boolean

Whether this price is active.

created_at

string

datetime When the plan was created.

updated_at

string

datetime When the plan was last updated.

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/plans?filter%5Bname%5D=Premium&sort=-id&per_page=15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "name": "Premium",
            "description": "Full access to all features",
            "is_active": true,
            "features": {
                "loyalty_enabled": true,
                "credits_enabled": true,
                "tiering_enabled": true,
                "max_spaces": 3,
                "max_customers": 10000
            },
            "prices": [
                {
                    "id": 1,
                    "currency": "MYR",
                    "billing_period": "monthly",
                    "amount": 350,
                    "stripe_price_id": "price_1ABC",
                    "is_active": true,
                    "description": null
                }
            ],
            "created_at": "2024-01-01T00:00:00.000000Z",
            "updated_at": "2024-01-01T00:00:00.000000Z"
        }
    ],
    "links": {
        "first": "...",
        "last": "...",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 15,
        "to": 1,
        "total": 1
    }
}

Show Plan

GET

https://explore.pixalink.io.test

/api/plans/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The plan ID.

Example:

Response Fields

integer

The plan ID.

name

string

The plan name.

description

string|null

The plan description.

is_active

boolean

Whether the plan is active.

features

object

Feature flags and limits for this plan.

prices

string[]

Active prices for this plan across currencies and billing periods.

created_at

datetime When the plan was created.

updated_at

datetime When the plan was last updated.

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/plans/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": 1,
        "name": "Premium",
        "features": {
            "loyalty_enabled": true
        },
        "prices": []
    }
}

Reward Validation

APIs for validating reward redemption codes

Validate Reward Code

POST

https://explore.pixalink.io.test

/api/customer_rewards/validate

requires authentication

Validates a 6-digit reward redemption code and returns validation status along with complete reward details. This endpoint is designed for cashiers and POS systems to verify reward codes before processing redemptions.

The validation process checks:

Code format (must be exactly 6 digits)
Code existence in the system
Code expiration status
Whether the code has already been used
Organisation-level multi-tenancy

The response includes the full reward object with properties field containing POS integration settings. For iVend POS: Check reward.properties.ivend.enabled to determine if the reward can be processed. Use reward.properties.ivend.amount to apply the discount amount.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

code

string

required

The 6-digit reward redemption code to validate. Must be exactly 6 digits.

Example:

123456

organisation_id

integer

required

The ID of the organisation the validation is being performed for. Must be a valid organisation ID.

Example:

123

Auth

Bearer

Headers

Body

{ "code": "123456", "organisation_id": 123 }

Received response

Example request:

curl --request POST \
    "https://explore.pixalink.io.test/api/customer_rewards/validate" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"123456\",
    \"organisation_id\": 123
}"

Example response:

{
    "valid": true,
    "message": "Code is valid",
    "data": {
        "id": 101,
        "status": "Pending",
        "code": "123456",
        "expired_at": "2024-12-31T23:59:59.000000Z",
        "used_at": null,
        "customer_id": 42,
        "reward_id": 5,
        "customer": {
            "id": 42,
            "name": "John Doe",
            "phone_number": "+601234567890",
            "email": "john@example.com",
            "current_point": 2500,
            "current_credits": 150
        },
        "reward": {
            "id": 5,
            "name": "Free Coffee",
            "description": "Complimentary coffee of your choice",
            "terms": "Valid at all outlets. One redemption per visit.",
            "is_active": true,
            "start_at": null,
            "end_at": null,
            "valid_days": 30,
            "amount": 100,
            "point_is_active": true,
            "credit_is_active": false,
            "credit_amount": null,
            "credit_earn_point": false,
            "available_currency_types": [
                "point"
            ],
            "allow_customer_self_reward": true,
            "is_one_time_reward": false,
            "is_direct_link_accessible": false,
            "is_redeemable": true,
            "is_custom_valid_days": true,
            "is_limit_total_availability": false,
            "total_availability": null,
            "total_redeemed": 15,
            "cover": "gift",
            "automations": [],
            "notification_settings": {},
            "properties": {
                "ivend": {
                    "enabled": true,
                    "type": "amount",
                    "amount": 5
                }
            },
            "created_at": "2024-01-15T08:30:00.000000Z",
            "updated_at": "2024-02-10T10:45:00.000000Z"
        }
    }
}

Rewards

List Rewards

GET

https://explore.pixalink.io.test

/api/rewards

requires authentication

Returns a paginated list of rewards belonging to the authenticated user's organisation spaces.
Supports filtering, sorting and relationship inclusion through query parameters.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

include

string

Comma-separated list of relationships to include. Available relationships:

space
customerRewards
rewardVouchers
inviterReferralItem
inviteeReferralItem
rewardBundleItems
pendingRewardVouchers

Example:

space,customerRewards

filter[space_id]

integer

Filter by space ID.

Example:

filter[is_active]

boolean

Filter by active status.

Example:

true

filter[is_redeemable]

boolean

Filter by redeemable status.

Example:

true

filter[is_one_time_reward]

boolean

Filter by one-time reward status.

Example:

false

filter[allow_customer_self_reward]

boolean

Filter by self-reward permission.

Example:

true

filter[point_is_active]

boolean

Filter by point redemption availability.

Example:

true

filter[credit_is_active]

boolean

Filter by credit redemption availability.

Example:

true

filter[available]

boolean

Filter by availability (considers active status and date range).

Example:

true

filter[name]

string

Filter by reward name (partial match).

Example:

Birthday

sort

string

Sort field and direction. Note: Prefix with - for descending order. Available sort fields:

name
start_at
end_at
created_at
amount

Example:

-created_at

per_page

integer

Number of records per page. Defaults to 15.

Example:

Response Fields

integer

The unique identifier of the reward.

name

string

The name/title of the reward.

description

string

Detailed description of what the reward offers.

terms

string

Terms and conditions for using the reward.

is_active

boolean

Whether the reward is currently active and can be issued.

start_at

string

datetime|null The date when the reward becomes available.

end_at

string

datetime|null The date when the reward expires.

valid_days

integer|null

Number of days the reward is valid after being issued to a customer.

amount

integer

The value or points associated with this reward.

point_is_active

boolean

Whether point-based redemption is enabled for this reward.

credit_is_active

boolean

Whether credit-based redemption is enabled for this reward.

credit_amount

number|null

Amount of credits required to redeem this reward (in currency units).

credit_earn_point

boolean

Whether customers earn points when redeeming this reward with credits.

available_currency_types

string[]

List of available currency types for redemption (e.g., ["point", "credit"]).

allow_customer_self_reward

boolean

Whether customers can claim this reward themselves.

is_one_time_reward

boolean

Whether the reward can only be claimed once per customer.

is_direct_link_accessible

boolean

Whether the reward can be accessed via a direct link.

is_redeemable

boolean

Whether the reward can be redeemed by customers.

is_custom_valid_days

boolean

Whether the reward uses custom validity period.

is_limit_total_availability

boolean

Whether there's a limit on total number of rewards.

total_availability

integer|null

Maximum number of rewards that can be issued.

total_redeemed

integer

Number of rewards that have been redeemed.

cover

string

required

Type of cover image preset being used.

automations

string[]

Automation settings configured for this reward.

properties

object

Read-only. POS integration settings and custom properties for this reward (can only be managed through admin panel).

zeoniq

object|null

Zeoniq POS integration settings (only present for Zeoniq organisations).

eats365

object|null

Eats365 POS integration settings (only present for Eats365 organisations).

ivend

object|null

iVend POS integration settings (only present for iVend organisations).

notification_settings

object

Configuration for various reward notifications.

new_reward

object

Settings for when customer receives a new reward

expired_reward

object

Settings for when reward expires

expiring_reward

object

Settings for when reward is about to expire

created_at

string

datetime Timestamp when the reward was created.

updated_at

string

datetime Timestamp when the reward was last updated.

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/rewards?include=space%2CcustomerRewards&filter%5Bspace_id%5D=1&filter%5Bis_active%5D=1&filter%5Bis_redeemable%5D=1&filter%5Bis_one_time_reward%5D=&filter%5Ballow_customer_self_reward%5D=1&filter%5Bpoint_is_active%5D=1&filter%5Bcredit_is_active%5D=1&filter%5Bavailable%5D=1&filter%5Bname%5D=Birthday&sort=-created_at&per_page=15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "name": "Birthday Reward",
            "description": "Special reward for customer birthdays",
            "terms": "Valid for 30 days from issue",
            "is_active": true,
            "start_at": "2025-01-01T00:00:00.000000Z",
            "end_at": "2025-12-31T23:59:59.000000Z",
            "valid_days": 30,
            "amount": 1000,
            "allow_customer_self_reward": false,
            "is_one_time_reward": true,
            "is_direct_link_accessible": false,
            "is_redeemable": true,
            "is_custom_valid_days": true,
            "is_limit_total_availability": true,
            "total_availability": 100,
            "total_redeemed": 0,
            "cover": "gift",
            "automations": [],
            "notification_settings": {
                "new_reward": {
                    "is_enabled": true,
                    "message": "You've received a birthday reward!"
                }
            },
            "properties": {
                "ivend": {
                    "enabled": true,
                    "type": "amount",
                    "amount": 10
                }
            },
            "created_at": "2025-01-31T21:16:49.000000Z",
            "updated_at": "2025-01-31T21:16:49.000000Z"
        }
    ],
    "links": {
        "first": "{{$baseUrl}}/api/rewards?page=1",
        "last": "{{$baseUrl}}/api/rewards?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "{{$baseUrl}}/api/rewards",
        "per_page": 15,
        "to": 1,
        "total": 1
    }
}

Create Reward

POST

https://explore.pixalink.io.test

/api/rewards

requires authentication

Creates a new reward in the system.
The reward will be associated with the specified space in the authenticated user's organisation.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

The reward's name.

Example:

Birthday Reward

description

string

required

Description of the reward.

Example:

Special reward for customer birthdays

terms

string

required

Terms and conditions for the reward.

Example:

Valid for 30 days from issue

space_id

integer

required

The ID of the space this reward belongs to. Must be from user's organisation.

Example:

is_active

boolean

Whether the reward is active. Default: true.

Example:

true

start_at

datetime

nullable Start date of the reward availability.

Example:

2025-01-01

end_at

datetime

nullable required_without:valid_days End date of the reward availability.

Example:

2025-12-31

is_redeemable

boolean

Whether the reward can be redeemed. Default: true.

Example:

true

is_custom_valid_days

boolean

Whether to use custom validity period.

Example:

true

valid_days

integer

nullable required_without:end_at Number of days the reward is valid after issuance.

Example:

amount

integer

required

Value/points for the reward.

Example:

1000

point_is_active

boolean

Whether point-based redemption is enabled for this reward.

Example:

true

credit_is_active

boolean

Whether credit-based redemption is enabled for this reward.

Example:

true

credit_amount

numeric

Amount of credits required to redeem this reward (in currency units).

Example:

10.50

credit_earn_point

boolean

Whether customers earn points when redeeming this reward with credits.

Example:

false

allow_customer_self_reward

boolean

Whether customers can claim the reward themselves.

Example:

true

is_one_time_reward

boolean

Whether the reward can only be claimed once per customer.

Example:

true

is_direct_link_accessible

boolean

Whether the reward can be accessed via direct link.

Example:

false

is_limit_total_availability

boolean

Whether to limit total number of rewards.

Example:

true

total_availability

integer

required_if:is_limit_total_availability,true Maximum number of rewards available.

Example:

100

cover

string

required

Cover preset type. Must be one of: discount, gift, voucher, custom.

Example:

gift

custom_cover

file

required_if:cover.preset,custom Square image file (1:1 ratio).

automations

string[]

optional Automation settings for the reward.

notification_settings

object

optional Notification settings for various reward events.

new_reward

object

Notification settings for new rewards.

expired_reward

object

expiring_reward

object

Response Fields

integer

The unique identifier of the reward.

name

string

The name/title of the reward.

description

string

Detailed description of what the reward offers.

terms

string

Terms and conditions for using the reward.

is_active

boolean

Whether the reward is currently active and can be issued.

start_at

string

datetime|null The date when the reward becomes available.

end_at

string

datetime|null The date when the reward expires.

valid_days

integer|null

Number of days the reward is valid after being issued to a customer.

amount

integer

The value or points associated with this reward.

allow_customer_self_reward

boolean

Whether customers can claim this reward themselves.

is_one_time_reward

boolean

Whether the reward can only be claimed once per customer.

is_direct_link_accessible

boolean

Whether the reward can be accessed via a direct link.

is_redeemable

boolean

Whether the reward can be redeemed by customers.

is_custom_valid_days

boolean

Whether the reward uses custom validity period.

is_limit_total_availability

boolean

Whether there's a limit on total number of rewards.

total_availability

integer|null

Maximum number of rewards that can be issued.

total_redeemed

integer

Number of rewards that have been redeemed.

cover

string

Type of cover image preset being used.

automations

string[]

Automation settings configured for this reward.

properties

object

Read-only POS integration settings and custom properties for this reward.

notification_settings

object

Configuration for various reward notifications.

created_at

string

datetime Timestamp when the reward was created.

updated_at

string

datetime Timestamp when the reward was last updated.

point_is_active

boolean

Whether the reward can be redeemed with points.

credit_is_active

boolean

Whether the reward can be redeemed with credits.

credit_amount

decimal The credit amount required to redeem this reward.

credit_earn_point

boolean

Whether redeeming this reward also earns points.

available_currency_types

string[]

The currency types available for redemption.

Auth

Bearer

Headers

Body

{ "name": "Birthday Reward", "description": "Special reward for customer birthdays", "terms": "Valid for 30 days from issue", "space_id": 1, "is_active": true, "start_at": "2025-01-01", "end_at": "2025-12-31", "is_redeemable": true, "is_custom_valid_days": true, "valid_days": 30, "amount": 1000, "point_is_active": true, "credit_is_active": true, "credit_amount": "10.50", "credit_earn_point": false, "allow_customer_self_reward": true, "is_one_time_reward": true, "is_direct_link_accessible": false, "is_limit_total_availability": true, "total_availability": 100, "cover": "gift", "custom_cover": null, "automations": null, "notification_settings": { "new_reward": { "is_enabled": false, "message": "Hi {{NAME}}, you have received a new reward from {{SPACE_NAME}}!" }, "expired_reward": { "is_enabled": true, "message": "Hi {{NAME}}, your reward from {{SPACE_NAME}} has expired." }, "expiring_reward": { "is_enabled": true, "message": "Hi {{NAME}}, your reward from {{SPACE_NAME}} is expiring soon.", "send_notification_before": "facere" } } }

Received response

Example request:

curl --request POST \
    "https://explore.pixalink.io.test/api/rewards" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Birthday Reward\",
    \"description\": \"Special reward for customer birthdays\",
    \"terms\": \"Valid for 30 days from issue\",
    \"space_id\": 1,
    \"is_active\": true,
    \"start_at\": \"2025-01-01\",
    \"end_at\": \"2025-12-31\",
    \"is_redeemable\": true,
    \"is_custom_valid_days\": true,
    \"valid_days\": 30,
    \"amount\": 1000,
    \"point_is_active\": true,
    \"credit_is_active\": true,
    \"credit_amount\": \"10.50\",
    \"credit_earn_point\": false,
    \"allow_customer_self_reward\": true,
    \"is_one_time_reward\": true,
    \"is_direct_link_accessible\": false,
    \"is_limit_total_availability\": true,
    \"total_availability\": 100,
    \"cover\": \"gift\",
    \"notification_settings\": {
        \"new_reward\": {
            \"is_enabled\": false,
            \"message\": \"Hi {{NAME}}, you have received a new reward from {{SPACE_NAME}}!\"
        },
        \"expired_reward\": {
            \"is_enabled\": true,
            \"message\": \"Hi {{NAME}}, your reward has expired.\"
        },
        \"expiring_reward\": {
            \"is_enabled\": true,
            \"message\": \"Hi {{NAME}}, your reward will expire soon!\",
            \"send_notification_before\": \"7\"
        }
    }
}"

$client = new \GuzzleHttp\Client();
$url = 'https://explore.pixalink.io.test/api/rewards';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Birthday Reward',
            'description' => 'Special reward for customer birthdays',
            'terms' => 'Valid for 30 days from issue',
            'space_id' => 1,
            'is_active' => true,
            'start_at' => '2025-01-01',
            'end_at' => '2025-12-31',
            'is_redeemable' => true,
            'is_custom_valid_days' => true,
            'valid_days' => 30,
            'amount' => 1000,
            'point_is_active' => true,
            'credit_is_active' => true,
            'credit_amount' => '10.50',
            'credit_earn_point' => false,
            'allow_customer_self_reward' => true,
            'is_one_time_reward' => true,
            'is_direct_link_accessible' => false,
            'is_limit_total_availability' => true,
            'total_availability' => 100,
            'cover' => 'gift',
            'notification_settings' => [
                'new_reward' => [
                    'is_enabled' => false,
                    'message' => 'Hi {{NAME}}, you have received a new reward from {{SPACE_NAME}}!',
                ],
                'expired_reward' => [
                    'is_enabled' => true,
                    'message' => 'Hi {{NAME}}, your reward has expired.',
                ],
                'expiring_reward' => [
                    'is_enabled' => true,
                    'message' => 'Hi {{NAME}}, your reward will expire soon!',
                    'send_notification_before' => '7',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response:

{
    "data": {
        "id": 1,
        "name": "Birthday Reward",
        "description": "Special reward for customer birthdays",
        "terms": "Valid for 30 days from issue",
        "is_active": true,
        "start_at": "2025-01-01T00:00:00.000000Z",
        "end_at": "2025-12-31T23:59:59.000000Z",
        "valid_days": 30,
        "amount": 1000,
        "allow_customer_self_reward": false,
        "is_one_time_reward": true,
        "is_direct_link_accessible": false,
        "is_redeemable": true,
        "is_custom_valid_days": true,
        "is_limit_total_availability": true,
        "total_availability": 100,
        "total_redeemed": 0,
        "cover": "gift",
        "automations": [],
        "notification_settings": {
            "new_reward": {
                "is_enabled": true,
                "message": "You've received a birthday reward!"
            }
        },
        "properties": {
            "ivend": {
                "enabled": true,
                "type": "amount",
                "amount": 10
            }
        },
        "created_at": "2025-01-31T21:16:49.000000Z",
        "updated_at": "2025-01-31T21:16:49.000000Z"
    },
    "message": "Reward created successfully"
}

Show Reward Details

GET

https://explore.pixalink.io.test

/api/rewards/{id}

requires authentication

Retrieves detailed information about a specific reward, including any requested relationships.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the reward.

Example:

Query Parameters

include

string

Comma-separated list of relationships to include. Available relationships:

space
customerRewards
rewardVouchers
inviterReferralItem
inviteeReferralItem
rewardBundleItems
pendingRewardVouchers

Example:

space,customerRewards

Response Fields

integer

The unique identifier of the reward.

name

string

The name/title of the reward.

description

string

Detailed description of what the reward offers.

terms

string

Terms and conditions for using the reward.

is_active

boolean

Whether the reward is currently active and can be issued.

start_at

string

datetime|null The date when the reward becomes available.

end_at

string

datetime|null The date when the reward expires.

valid_days

integer|null

Number of days the reward is valid after being issued to a customer.

amount

integer

The value or points associated with this reward.

allow_customer_self_reward

boolean

Whether customers can claim this reward themselves.

is_one_time_reward

boolean

Whether the reward can only be claimed once per customer.

is_direct_link_accessible

boolean

Whether the reward can be accessed via a direct link.

is_redeemable

boolean

Whether the reward can be redeemed by customers.

is_custom_valid_days

boolean

Whether the reward uses custom validity period.

is_limit_total_availability

boolean

Whether there's a limit on total number of rewards.

total_availability

integer|null

Maximum number of rewards that can be issued.

total_redeemed

integer

Number of rewards that have been redeemed.

cover

string

Type of cover image preset being used.

automations

string[]

Automation settings configured for this reward.

properties

object

Read-only POS integration settings and custom properties for this reward.

notification_settings

object

Configuration for various reward notifications.

created_at

string

datetime Timestamp when the reward was created.

updated_at

string

datetime Timestamp when the reward was last updated.

point_is_active

boolean

Whether the reward can be redeemed with points.

credit_is_active

boolean

Whether the reward can be redeemed with credits.

credit_amount

decimal The credit amount required to redeem this reward.

credit_earn_point

boolean

Whether redeeming this reward also earns points.

available_currency_types

string[]

The currency types available for redemption.

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/rewards/1?include=space%2CcustomerRewards" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": 1,
        "name": "Birthday Reward",
        "description": "Special reward for customer birthdays",
        "terms": "Valid for 30 days from issue",
        "is_active": true,
        "start_at": "2025-01-01T00:00:00.000000Z",
        "end_at": "2025-12-31T23:59:59.000000Z",
        "valid_days": 30,
        "amount": 1000,
        "allow_customer_self_reward": false,
        "is_one_time_reward": true,
        "is_direct_link_accessible": false,
        "is_redeemable": true,
        "is_custom_valid_days": true,
        "is_limit_total_availability": true,
        "total_availability": 100,
        "total_redeemed": 0,
        "cover": "gift",
        "automations": [],
        "notification_settings": {
            "new_reward": {
                "is_enabled": true,
                "message": "You've received a birthday reward!"
            }
        },
        "properties": {
            "ivend": {
                "enabled": true,
                "type": "amount",
                "amount": 10
            }
        },
        "created_at": "2025-01-31T21:16:49.000000Z",
        "updated_at": "2025-01-31T21:16:49.000000Z"
    }
}

Update Reward

PUT

PATCH

https://explore.pixalink.io.test

/api/rewards/{id}

requires authentication

Updates an existing reward's information.
All fields are optional.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the reward.

Example:

Body Parameters

name

string

The reward's name.

Example:

Birthday Reward

description

string

Description of the reward.

Example:

Special reward for customer birthdays

terms

string

Terms and conditions for the reward.

Example:

Valid for 30 days from issue

space_id

integer

The ID of the space this reward belongs to. Must be from user's organisation.

Example:

is_active

boolean

Whether the reward is active.

Example:

true

start_at

datetime

nullable Start date of the reward availability.

Example:

2025-01-01

end_at

datetime

nullable required_without:valid_days End date of the reward availability.

Example:

2025-12-31

is_redeemable

boolean

Whether the reward can be redeemed.

Example:

true

is_custom_valid_days

boolean

Whether to use custom validity period.

Example:

true

valid_days

integer

nullable required_without:end_at Number of days the reward is valid after issuance.

Example:

amount

integer

Value/points for the reward.

Example:

1000

point_is_active

boolean

Whether point-based redemption is enabled for this reward.

Example:

true

credit_is_active

boolean

Whether credit-based redemption is enabled for this reward.

Example:

true

credit_amount

numeric

Amount of credits required to redeem this reward (in currency units).

Example:

10.50

credit_earn_point

boolean

Whether customers earn points when redeeming this reward with credits.

Example:

false

allow_customer_self_reward

boolean

Whether customers can claim the reward themselves.

Example:

true

is_one_time_reward

boolean

Whether the reward can only be claimed once per customer.

Example:

true

is_direct_link_accessible

boolean

Whether the reward can be accessed via direct link.

Example:

false

is_limit_total_availability

boolean

Whether to limit total number of rewards.

Example:

true

total_availability

integer

required_if:is_limit_total_availability,true Maximum number of rewards available.

Example:

100

cover

string

required

Cover preset type. Must be one of: discount, gift, voucher, custom.

Example:

gift

custom_cover

file

Square image file (1:1 ratio).

automations

string[]

Automation settings for the reward.

notification_settings

object

Notification settings for various reward events.

new_reward

object

Notification settings for new rewards.

expired_reward

object

expiring_reward

object

Response Fields

integer

The unique identifier of the reward.

name

string

The name/title of the reward.

description

string

Detailed description of what the reward offers.

terms

string

Terms and conditions for using the reward.

is_active

boolean

Whether the reward is currently active and can be issued.

start_at

string

datetime|null The date when the reward becomes available.

end_at

string

datetime|null The date when the reward expires.

valid_days

integer|null

Number of days the reward is valid after being issued to a customer.

amount

integer

The value or points associated with this reward.

allow_customer_self_reward

boolean

Whether customers can claim this reward themselves.

is_one_time_reward

boolean

Whether the reward can only be claimed once per customer.

is_direct_link_accessible

boolean

Whether the reward can be accessed via a direct link.

is_redeemable

boolean

Whether the reward can be redeemed by customers.

is_custom_valid_days

boolean

Whether the reward uses custom validity period.

is_limit_total_availability

boolean

Whether there's a limit on total number of rewards.

total_availability

integer|null

Maximum number of rewards that can be issued.

total_redeemed

integer

Number of rewards that have been redeemed.

cover

string

Type of cover image preset being used.

automations

string[]

Automation settings configured for this reward.

properties

object

Read-only POS integration settings and custom properties for this reward.

notification_settings

object

Configuration for various reward notifications.

created_at

string

datetime Timestamp when the reward was created.

updated_at

string

datetime Timestamp when the reward was last updated.

point_is_active

boolean

Whether the reward can be redeemed with points.

credit_is_active

boolean

Whether the reward can be redeemed with credits.

credit_amount

decimal The credit amount required to redeem this reward.

credit_earn_point

boolean

Whether redeeming this reward also earns points.

available_currency_types

string[]

The currency types available for redemption.

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "Birthday Reward", "description": "Special reward for customer birthdays", "terms": "Valid for 30 days from issue", "space_id": 1, "is_active": true, "start_at": "2025-01-01", "end_at": "2025-12-31", "is_redeemable": true, "is_custom_valid_days": true, "valid_days": 30, "amount": 1000, "point_is_active": true, "credit_is_active": true, "credit_amount": "10.50", "credit_earn_point": false, "allow_customer_self_reward": true, "is_one_time_reward": true, "is_direct_link_accessible": false, "is_limit_total_availability": true, "total_availability": 100, "cover": "gift", "custom_cover": null, "automations": null, "notification_settings": { "new_reward": { "is_enabled": false, "message": "laboriosam" }, "expired_reward": { "is_enabled": true, "message": "Hi {{NAME}}, your reward has expired." }, "expiring_reward": { "is_enabled": true, "message": "Hi {{NAME}}, your reward will expire soon!", "send_notification_before": "7" } } }

Received response

Example request:

curl --request PUT \
    "https://explore.pixalink.io.test/api/rewards/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Birthday Reward\",
    \"description\": \"Special reward for customer birthdays\",
    \"terms\": \"Valid for 30 days from issue\",
    \"space_id\": 1,
    \"is_active\": true,
    \"start_at\": \"2025-01-01\",
    \"end_at\": \"2025-12-31\",
    \"is_redeemable\": true,
    \"is_custom_valid_days\": true,
    \"valid_days\": 30,
    \"amount\": 1000,
    \"point_is_active\": true,
    \"credit_is_active\": true,
    \"credit_amount\": \"10.50\",
    \"credit_earn_point\": false,
    \"allow_customer_self_reward\": true,
    \"is_one_time_reward\": true,
    \"is_direct_link_accessible\": false,
    \"is_limit_total_availability\": true,
    \"total_availability\": 100,
    \"cover\": \"gift\",
    \"notification_settings\": {
        \"new_reward\": {
            \"is_enabled\": false,
            \"message\": \"laboriosam\"
        },
        \"expired_reward\": {
            \"is_enabled\": true,
            \"message\": \"Hi {{NAME}}, your reward has expired.\"
        },
        \"expiring_reward\": {
            \"is_enabled\": true,
            \"message\": \"Hi {{NAME}}, your reward will expire soon!\",
            \"send_notification_before\": \"7\"
        }
    }
}"

$client = new \GuzzleHttp\Client();
$url = 'https://explore.pixalink.io.test/api/rewards/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Birthday Reward',
            'description' => 'Special reward for customer birthdays',
            'terms' => 'Valid for 30 days from issue',
            'space_id' => 1,
            'is_active' => true,
            'start_at' => '2025-01-01',
            'end_at' => '2025-12-31',
            'is_redeemable' => true,
            'is_custom_valid_days' => true,
            'valid_days' => 30,
            'amount' => 1000,
            'point_is_active' => true,
            'credit_is_active' => true,
            'credit_amount' => '10.50',
            'credit_earn_point' => false,
            'allow_customer_self_reward' => true,
            'is_one_time_reward' => true,
            'is_direct_link_accessible' => false,
            'is_limit_total_availability' => true,
            'total_availability' => 100,
            'cover' => 'gift',
            'notification_settings' => [
                'new_reward' => [
                    'is_enabled' => false,
                    'message' => 'laboriosam',
                ],
                'expired_reward' => [
                    'is_enabled' => true,
                    'message' => 'Hi {{NAME}}, your reward has expired.',
                ],
                'expiring_reward' => [
                    'is_enabled' => true,
                    'message' => 'Hi {{NAME}}, your reward will expire soon!',
                    'send_notification_before' => '7',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response:

{
    "data": {
        "id": 1,
        "name": "Birthday Reward",
        "description": "Special reward for customer birthdays",
        "terms": "Valid for 30 days from issue",
        "is_active": true,
        "start_at": "2025-01-01T00:00:00.000000Z",
        "end_at": "2025-12-31T23:59:59.000000Z",
        "valid_days": 30,
        "amount": 1000,
        "allow_customer_self_reward": false,
        "is_one_time_reward": true,
        "is_direct_link_accessible": false,
        "is_redeemable": true,
        "is_custom_valid_days": true,
        "is_limit_total_availability": true,
        "total_availability": 100,
        "total_redeemed": 0,
        "cover": "gift",
        "automations": [],
        "notification_settings": {
            "new_reward": {
                "is_enabled": true,
                "message": "You've received a birthday reward!"
            }
        },
        "properties": {
            "ivend": {
                "enabled": true,
                "type": "amount",
                "amount": 10
            }
        },
        "created_at": "2025-01-31T21:16:49.000000Z",
        "updated_at": "2025-01-31T21:16:49.000000Z"
    },
    "message": "Reward updated successfully"
}

Delete Reward

DELETE

https://explore.pixalink.io.test

/api/rewards/{id}

requires authentication

Deletes a reward from the system.
Only rewards that haven't been assigned to any customers can be deleted.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the reward.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://explore.pixalink.io.test/api/rewards/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[Empty response]

Reward Voucher

Third-party reward vouchers allow businesses to integrate external voucher codes (like e-commerce platform vouchers) into their loyalty program. These vouchers can be imported in bulk, managed within the system, and distributed to customers as rewards. Each voucher has a unique code and can be tracked through various states including available, used, expired, and pending. This feature enables seamless integration of external reward partnerships while maintaining full tracking and validation capabilities.

List reward vouchers

GET

https://explore.pixalink.io.test

/api/rewards/{reward_id}/vouchers

requires authentication

Get a paginated list of vouchers for a specific reward.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

reward_id

integer

required

The ID of the reward.

Example:

Body Parameters

status

string

Filter vouchers by status.

Must be one of:

Pending
Reserved
Active
Expired
Used

Example:

Active

string

Search vouchers by code or customer information.

Example:

REWARD123

page

integer

Page number for pagination. Must be at least 1.

Example:

per_page

integer

Number of items per page (max: 100). Must be at least 1. Must not be greater than 100.

Example:

Response Fields

integer

The unique identifier of the reward voucher.

code

string

The unique code for the voucher.

status

string

The current status of the voucher. Possible values: available, used, expired, pending.

expired_at

string

datetime|null The expiration date and time of the voucher.

given_at

datetime|null The date and time when the voucher was given to a customer.

used_at

datetime|null The date and time when the voucher was used.

created_at

datetime When the voucher was created.

updated_at

datetime When the voucher was last updated.

Auth

Bearer

Headers

URL Parameters

Body

{ "status": "Active", "search": "REWARD123", "page": 1, "per_page": 15 }

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/rewards/10/vouchers" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"Active\",
    \"search\": \"REWARD123\",
    \"page\": 1,
    \"per_page\": 15
}"

Example response:

{
    "data": [
        {
            "id": 1,
            "code": "REWARD123",
            "status": "available",
            "expired_at": "2024-12-31T23:59:59Z",
            "given_at": null,
            "used_at": null,
            "customer_reward": {
                "customer": {
                    "id": 1,
                    "name": "John Doe",
                    "phone_number": "+1234567890"
                }
            }
        }
    ],
    "links": {
        "first": "{{$baseUrl}}/api/rewards/{{reward_id}}/vouchers?page=1",
        "last": "{{$baseUrl}}/api/rewards/{{reward_id}}/vouchers?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "last_page": 1,
        "per_page": 15,
        "total": 1
    }
}

Create reward voucher

POST

https://explore.pixalink.io.test

/api/rewards/{reward_id}/vouchers

requires authentication

Creates a reward voucher for a specific reward. The voucher is initially created in a pending status, which means it has been generated but not yet assigned. The voucher will remain in this state until it is given to a recipient or further processed.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

reward_id

integer

required

The ID of the reward.

Example:

Body Parameters

code

string

required

Unique voucher code for the reward. Must not be greater than 255 characters.

Example:

REWARD123XYZ

expired_at

string

required

The date and time when the voucher expires. Must be a valid date. Must be a date after now.

Example:

2024-12-31T23:59:59Z

Response Fields

integer

The unique identifier of the reward voucher.

code

string

The unique code for the voucher.

status

string

The current status of the voucher.

expired_at

string

datetime|null The expiration date and time of the voucher.

given_at

datetime|null The date and time when the voucher was given to a customer.

used_at

datetime|null The date and time when the voucher was used.

created_at

datetime When the voucher was created.

updated_at

datetime When the voucher was last updated.

Auth

Bearer

Headers

URL Parameters

Body

{ "code": "REWARD123XYZ", "expired_at": "2024-12-31T23:59:59Z" }

Received response

Example request:

curl --request POST \
    "https://explore.pixalink.io.test/api/rewards/2/vouchers" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"REWARD123XYZ\",
    \"expired_at\": \"2024-12-31T23:59:59Z\"
}"

Example response:

{
    "id": 1,
    "code": "REWARD123",
    "status": "available",
    "expired_at": "2024-12-31T23:59:59Z",
    "given_at": null,
    "used_at": null
}

Show reward voucher details

GET

https://explore.pixalink.io.test

/api/rewards/{reward_id}/vouchers/{id}

requires authentication

Retrieve detailed information about a specific reward voucher. This endpoint allows fetching a single voucher with optional related resources.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

reward_id

integer

required

The unique identifier of the reward.

Example:

integer

required

The unique identifier of the voucher.

Example:

Query Parameters

include

string

Optional related resources to include. Possible values: customerReward, customerReward.customer, reward

Example:

customerReward,reward

Response Fields

integer

The unique identifier of the reward voucher.

code

string

The unique code for the voucher.

status

string

The current status of the voucher. Possible values: available, used, expired, pending.

expired_at

string

datetime|null The expiration date and time of the voucher.

given_at

datetime|null The date and time when the voucher was given to a customer.

used_at

datetime|null The date and time when the voucher was used.

customer_reward

object|null

Details of the customer reward associated with this voucher.

reward

object

Details of the reward associated with this voucher.

created_at

datetime When the voucher was created.

updated_at

datetime When the voucher was last updated.

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/rewards/1/vouchers/42?include=customerReward%2Creward" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "id": 1,
    "code": "REWARD123",
    "status": "available",
    "expired_at": "2024-12-31T23:59:59Z",
    "given_at": null,
    "used_at": null,
    "customer_reward": {
        "id": 12,
        "status": "pending"
    },
    "reward": {
        "id": 1,
        "name": "Loyalty Discount",
        "description": "10% off next purchase"
    }
}

Update reward voucher status

PUT

PATCH

https://explore.pixalink.io.test

/api/rewards/{reward_id}/vouchers/{id}

requires authentication

Update the status of a specific voucher.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

reward_id

integer

required

The ID of the reward.

Example:

integer

required

The ID of the voucher.

Example:

Body Parameters

status

string

required

The new status for the voucher.

Must be one of:

Used
Expired

Example:

used

Response Fields

integer

The unique identifier of the reward voucher.

code

string

The unique code for the voucher.

status

string

The current status of the voucher.

expired_at

string

datetime|null The expiration date and time of the voucher.

given_at

string

datetime|null The date and time when the voucher was given to a customer.

used_at

string

datetime|null The date and time when the voucher was used.

created_at

datetime When the voucher was created.

updated_at

datetime When the voucher was last updated.

Auth

Bearer

Headers

URL Parameters

Body

{ "status": "used" }

Received response

Example request:

curl --request PUT \
    "https://explore.pixalink.io.test/api/rewards/20/vouchers/5" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"used\"
}"

Example response:

{
    "id": 1,
    "code": "REWARD123",
    "status": "used",
    "expired_at": "2024-12-31T23:59:59Z",
    "given_at": "2024-02-09T10:00:00Z",
    "used_at": "2024-02-09T12:00:00Z"
}

Delete reward voucher

DELETE

https://explore.pixalink.io.test

/api/rewards/{reward_id}/vouchers/{id}

requires authentication

Delete a specific voucher.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

reward_id

integer

required

The ID of the reward.

Example:

integer

required

The ID of the voucher.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://explore.pixalink.io.test/api/rewards/9/vouchers/20" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[Empty response]

Bulk Update Reward Vouchers

POST

https://explore.pixalink.io.test

/api/rewards/{reward_id}/vouchers/bulk-update

requires authentication

Updates the status of multiple reward vouchers asynchronously. The operation is queued as a background job and processed in chunks of 100 records. This endpoint is rate limited to 10 requests per minute.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

reward_id

integer

required

The ID of the reward these vouchers belong to.

Example:

Body Parameters

voucher_codes

string[]

A valid voucher code string. This field is required when voucher_codes is present. The code of an existing record in the reward_vouchers table.

Example:

["REWARD123"]

voucher_ids

integer[]

A valid voucher ID integer. This field is required when voucher_ids is present. The id of an existing record in the reward_vouchers table.

Example:

[1]

status

string

required

The new status to be applied to the selected vouchers.

Must be one of:

Used
Expired

Example:

Used

Auth

Bearer

Headers

URL Parameters

Body

{ "voucher_codes": [ "REWARD123" ], "voucher_ids": [ 1 ], "status": "Used" }

Received response

Example request:

curl --request POST \
    "https://explore.pixalink.io.test/api/rewards/1/vouchers/bulk-update" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"voucher_codes\": [
        \"REWARD123\"
    ],
    \"voucher_ids\": [
        1
    ],
    \"status\": \"Used\"
}"

Example response:

{
    "message": "Bulk voucher update has been queued and will be processed shortly",
    "updated_count": 3
}

Bulk import vouchers

POST

https://explore.pixalink.io.test

/api/rewards/{reward_id}/vouchers/bulk-import

requires authentication

Import multiple vouchers for a reward asynchronously. The operation is queued and processed in chunks of 100 records. Limited to 10,000 vouchers per request and rate limited to 10 requests per minute.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

reward_id

integer

required

The ID of the reward.

Example:

Body Parameters

vouchers

string[]

required

Array of vouchers to import (max 10,000).

code

string

required

Unique identifier for each reward voucher within this reward. Must be a string no longer than 255 characters. Must not be greater than 255 characters.

Example:

REWARD123

expired_at

string

required

Expiration date and time for the voucher. Must be a future date in ISO 8601 format. Must be a valid date. Must be a date after now.

Example:

2026-12-31T23:59:59Z

object

auto_reassign

boolean

Whether to automatically trigger voucher reassignment to pending customer rewards after import completes. Defaults to false.

Example:

false

Auth

Bearer

Headers

URL Parameters

Body

{ "vouchers": { "code": "REWARD123", "expired_at": "2026-12-31T23:59:59Z", "*": { "code": "REWARD123", "expired_at": "2024-12-31T23:59:59Z" } }, "auto_reassign": false }

Received response

Example request:

curl --request POST \
    "https://explore.pixalink.io.test/api/rewards/2/vouchers/bulk-import" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vouchers\": [
        {
            \"code\": \"REWARD123\",
            \"expired_at\": \"2024-12-31T23:59:59Z\"
        }
    ],
    \"auto_reassign\": false
}"

Example response:

{
    "message": "Bulk voucher import has been queued and will be processed shortly"
}

Roles

List Roles

GET

https://explore.pixalink.io.test

/api/roles

requires authentication

Returns a paginated list of all available roles.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

filter[name]

string

Filter by role name (partial match).

Example:

Admin

sort

string

Sort field. Allowed: id, name, created_at.

Example:

-id

per_page

integer

Records per page.

Example:

Response Fields

integer

The role ID.

name

string

The role name.

guard_name

string

The guard this role belongs to.

created_at

string

datetime When the role was created.

updated_at

string

datetime When the role was last updated.

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/roles?filter%5Bname%5D=Admin&sort=-id&per_page=15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "name": "Super Admin",
            "guard_name": "web",
            "created_at": "2024-01-01T00:00:00.000000Z",
            "updated_at": "2024-01-01T00:00:00.000000Z"
        }
    ],
    "links": {
        "first": "...",
        "last": "...",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 15,
        "to": 1,
        "total": 1
    }
}

Show Role

GET

https://explore.pixalink.io.test

/api/roles/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The role ID.

Example:

Response Fields

integer

The role ID.

name

string

The role name.

guard_name

string

The guard this role belongs to.

created_at

datetime When the role was created.

updated_at

datetime When the role was last updated.

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/roles/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": 1,
        "name": "Admin",
        "guard_name": "web"
    }
}

Spaces

List Spaces

GET

https://explore.pixalink.io.test

/api/spaces

requires authentication

Returns a paginated list of spaces belonging to the authenticated user's organisation.
Supports filtering, sorting and relationship inclusion through query parameters.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

include

string

Comma-separated list of relationships to include. Available relationships:

category (Space category details)
address (Physical address details)

Example:

category,address

filter[visibility]

string

Filter by visibility status. Available options:

public (Listed and viewable by anyone)
private (Not listed, viewable with link)
hidden (Not listed, cannot be searched)
draft (Not listed, cannot be searched)

Example:

public

filter[category_id]

integer

Filter by category ID.

Example:

filter[name]

string

Filter by space name (partial match).

Example:

Coworking

filter[description]

string

Filter by space description (partial match).

Example:

modern

filter[email]

string

Filter by space email (partial match).

Example:

space@example.com

filter[organisation_id]

integer

Filter by organisation ID.

Example:

filter[has_posts]

boolean

Filter spaces that have posts.

Example:

true

sort

string

Sort field and direction. Available fields:

name (Sort by space name)
created_at (Sort by creation date)
updated_at (Sort by last update)
visits (Sort by number of visits) Default: -created_at

Example:

-visits

per_page

integer

Number of records per page. Default: 15.

Example:

Response Fields

integer

The unique identifier of the space

name

string

The name of the space

slug

string

The URL-friendly slug of the space

matterport_model_id

string|null

The Matterport 3D model identifier if available

description

string

The detailed description of the space

visibility

string

The visibility status (public, private, hidden, draft)

string|null

The contact email address

phone_number

string

The contact phone number in E.164 format

website

string|null

The website URL

social_media

string[][]

array|null Social media platform details:

Facebook: username
Instagram: username
Twitter: username
YouTube: channel ID
LinkedIn: company URL ID
WhatsApp: phone number
TripAdvisor: page link
TikTok: username

organisation_id

integer

The ID of the owning organisation

category_id

integer

The ID of the space's category

visits

integer

Number of visits/views

created_at

string

datetime ISO 8601 datetime of creation

updated_at

string

datetime ISO 8601 datetime of last update

deleted_at

datetime|null ISO 8601 datetime of deletion if applicable

address

object

Contains address details when included:

address_line_1: string
address_line_2: string|null
postal_code: string
city: string
state: string
country: string

Create Space

POST

https://explore.pixalink.io.test

/api/spaces

requires authentication

Creates a new space in the system.
The space will be associated with the authenticated user's organisation.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

The name of the space.

Example:

Modern Coworking Space

description

string

required

The description of the space (max: 65535 characters).

Example:

A modern coworking space in the heart of the city

visibility

string

required

The visibility of the space. Must be one of:

Public (Listed and viewable by anyone)
Private (Not listed, viewable with link)
Hidden (Not listed, cannot be searched)
Draft (Not listed, cannot be searched)

Example:

Public

string

optional A valid email address.

Example:

space@example.com

phone_number

string

The contact phone number in E.164 format (e.g. +60125452222). Starting with + followed by country code and number with no spaces or special characters.

Example:

+60123456789

website

string

optional A valid URL.

Example:

category_id

integer

required

The ID of a subcategory.

Example:

social_media

string[]

optional Array of social media details.

name

string

required

Example:

username

string

required

Must not be greater than 255 characters.

Example:

alwqrmlumoaaqh

object

address

string[]

required

The space's address.

address_line_1

string

required

The first line of address.

Example:

123 Main Street

address_line_2

string

optional The second line of address.

Example:

Suite 45

postal_code

string

required

5-digit postal code.

Example:

50450

country

string

required

Country name (only Malaysia and Singapore allowed).

Example:

Malaysia

state

string

required

State name (must exist for selected country).

Example:

Selangor

city

string

required

City name (must exist for selected state).

Example:

Petaling Jaya

tags

string[]

optional Array of tag names.

Example:

["Coworking","24\/7"]

classification

string[]

optional Array of classification tags.

Example:

["Premium","Featured"]

media

object

optional Media files for the space.

Response Fields

integer

The unique identifier of the newly created space

name

string

The name of the space as provided in the request

slug

string

The automatically generated URL-friendly version of the name

matterport_model_id

string|null

The Matterport 3D model identifier (null for new spaces)

description

string

The detailed description of the space

visibility

string

The visibility status:

public (Listed and viewable by anyone)
private (Not listed, viewable with link)
hidden (Not listed, cannot be searched)
draft (Not listed, cannot be searched)

string|null

The contact email address for the space

phone_number

string

The contact phone number in E.164 format (e.g. +60123456789)

website

string|null

The website URL for the space

social_media

string[][]

array|null Array of social media platform details with structure:

name: Platform name (Facebook, Instagram, Twitter, etc.)
username: Platform-specific identifier or username

organisation_id

integer

The ID of the organisation that owns the space

category_id

integer

The ID of the space's assigned category

visits

integer

Number of visits (starts at 0 for new spaces)

created_at

string

datetime ISO 8601 datetime when the space was created

updated_at

string

datetime ISO 8601 datetime when the space was last updated

deleted_at

datetime|null ISO 8601 datetime of soft deletion (null for new spaces)

address

object

The space's address details when included:

id: integer (Address record ID)
address_line_1: string (Primary address line)
address_line_2: string|null (Secondary address line)
postal_code: string (5-digit postal code)
city: string (City name)
state: string (State name)
country: string (Country name)

links

object

Navigation URLs:

public_url: string (Full URL to the space's public page)

uuid

string

The unique UUID of the space.

Auth

Bearer

Headers

Body

{ "name": "Modern Coworking Space", "description": "A modern coworking space in the heart of the city", "visibility": "Public", "email": "space@example.com", "phone_number": "+60123456789", "website": "{{$baseUrl}}", "category_id": 1, "social_media": { "name": "et", "username": "alwqrmlumoaaqh", "*": { "name": "Twitter", "username": "@modernspace" } }, "address": { "address_line_1": "123 Main Street", "address_line_2": "Suite 45", "postal_code": "50450", "country": "Malaysia", "state": "Selangor", "city": "Petaling Jaya" }, "tags": [ "Coworking", "24\/7" ], "classification": [ "Premium", "Featured" ], "media": { "preview": null, "featured_image": null, "gallery": null, "logo": null } }

Received response

Example request:

curl --request POST \
    "https://explore.pixalink.io.test/api/spaces" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Modern Coworking Space\",
    \"description\": \"A modern coworking space in the heart of the city\",
    \"visibility\": \"Public\",
    \"email\": \"space@example.com\",
    \"phone_number\": \"+60123456789\",
    \"website\": \"{{$baseUrl}}\",
    \"category_id\": 1,
    \"social_media\": [
        \"qui\"
    ],
    \"address\": [
        \"aliquam\"
    ],
    \"tags\": [
        \"Coworking\",
        \"24\\/7\"
    ],
    \"classification\": [
        \"Premium\",
        \"Featured\"
    ]
}"

Example response:

{
    "data": {
        "id": 1,
        "uuid": "f2d75bf6-3cb8-305c-8f70-f71fe697cba3",
        "name": "Modern Coworking Space",
        "slug": "modern-coworking-space",
        "matterport_model_id": null,
        "description": "A modern coworking space in the heart of the city offering flexible workspace solutions for professionals and teams",
        "visibility": "public",
        "email": "space@example.com",
        "phone_number": "+60123456789",
        "website": "https://pixalink.io/spaces/modern-coworking",
        "social_media": [
            {
                "name": "Twitter",
                "username": "@modernspace"
            },
            {
                "name": "Facebook",
                "username": "modernspacekl"
            },
            {
                "name": "Instagram",
                "username": "@modernspace.kl"
            }
        ],
        "organisation_id": 1,
        "category_id": 2,
        "visits": 0,
        "created_at": "2024-02-08T15:00:00Z",
        "updated_at": "2024-02-08T15:00:00Z",
        "deleted_at": null,
        "address": {
            "id": 1,
            "address_line_1": "123 Jalan Sultan Ismail",
            "address_line_2": "Level 23",
            "postal_code": "50250",
            "city": "Kuala Lumpur",
            "state": "Wilayah Persekutuan",
            "country": "Malaysia"
        },
        "links": {
            "public_url": "{{$baseUrl}}/spaces/modern-coworking-space"
        }
    }
}

Show Space Details

GET

https://explore.pixalink.io.test

/api/spaces/{id}

requires authentication

Retrieves detailed information about a specific space, including any requested relationships.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the space.

Example:

Query Parameters

include

string

Comma-separated list of relationships to include. Available relationships:

category
address
posts
widgets
activeWidgets
activeCalendars

Example:

category,address

Response Fields

integer

The unique identifier of the space

name

string

The name of the space

slug

string

The URL-friendly slug of the space

matterport_model_id

string|null

The Matterport 3D model identifier if available

description

string

The detailed description of the space

visibility

string

The visibility status (public, private, hidden, draft)

string|null

The contact email address

phone_number

string

The contact phone number in E.164 format

website

string|null

The website URL

social_media

string[][]

array|null Social media platform details

organisation_id

integer

The ID of the owning organisation

category_id

integer

The ID of the space's category

visits

integer

Number of visits/views

created_at

string

datetime ISO 8601 datetime of creation

updated_at

string

datetime ISO 8601 datetime of last update

deleted_at

datetime|null ISO 8601 datetime of deletion if applicable

address

object

Address details (when included)

Update Space

PUT

PATCH

https://explore.pixalink.io.test

/api/spaces/{id}

requires authentication

Updates an existing space's information.
All fields are optional.
Omitted fields will retain their current values.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the space.

Example:

Body Parameters

name

string

optional The name of the space.

Example:

Modern Coworking Space

description

string

optional The description of the space (max: 65535 characters).

Example:

A modern coworking space in the heart of the city

visibility

string

optional The visibility status. Must be one of:

Public (Listed and viewable by anyone)
Private (Not listed, viewable with link)
Hidden (Not listed, cannot be searched)
Draft (Not listed, cannot be searched)

Example:

Public

string

optional A valid email address.

Example:

space@example.com

phone_number

string

The contact phone number in E.164 format (e.g. +60125452222). Starting with + followed by country code and number with no spaces or special characters.

Example:

ipsum

website

string

optional A valid URL.

Example:

category_id

integer

optional The ID of a subcategory.

Example:

social_media

string[]

optional Array of social media details. Will replace existing entries.

name

string

Example:

illum

username

string

Must not be greater than 255 characters.

Example:

fvnvpxwjwf

object

address

string[]

optional The space's address details to update.

address_line_1

string

optional The first line of address.

Example:

123 Main Street

address_line_2

string

optional The second line of address.

Example:

Suite 45

postal_code

string

optional 5-digit postal code.

Example:

50450

country

string

optional Country name (only Malaysia and Singapore allowed).

Example:

Malaysia

state

string

optional State name (must exist for selected country).

Example:

Selangor

city

string

optional City name (must exist for selected state).

Example:

Petaling Jaya

tags

string[]

optional Array of tag names to update.

Example:

["Coworking","24\/7"]

classification

string[]

optional Array of classification tags to update.

Example:

["Premium","Featured"]

media

object

optional Media files to update.

Response Fields

integer

The unique identifier of the space

name

string

The name of the space

slug

string

The URL-friendly slug of the space

matterport_model_id

string|null

The Matterport 3D model identifier if available

description

string

The detailed description of the space

visibility

string

The visibility status (public, private, hidden, draft)

string|null

The contact email address

phone_number

string

The contact phone number in E.164 format

website

string|null

The website URL

social_media

string[][]

array|null Social media platform details

organisation_id

integer

The ID of the owning organisation

category_id

integer

The ID of the space's category

visits

integer

Number of visits/views

created_at

string

datetime ISO 8601 datetime of creation

updated_at

string

datetime ISO 8601 datetime of last update

uuid

string

The unique UUID of the space.

deleted_at

datetime|null When the space was soft-deleted, or null if active.

links

object

Navigation URLs for this space (contains public_url).

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "Modern Coworking Space", "description": "A modern coworking space in the heart of the city", "visibility": "Public", "email": "space@example.com", "phone_number": "ipsum", "website": "{{$baseUrl}}", "category_id": 1, "social_media": { "name": "illum", "username": "fvnvpxwjwf", "*": { "name": "Twitter", "username": "@modernspace" } }, "address": { "address_line_1": "123 Main Street", "address_line_2": "Suite 45", "postal_code": "50450", "country": "Malaysia", "state": "Selangor", "city": "Petaling Jaya" }, "tags": [ "Coworking", "24\/7" ], "classification": [ "Premium", "Featured" ], "media": { "preview": null, "featured_image": null, "gallery": null, "logo": null } }

Received response

Example request:

curl --request PUT \
    "https://explore.pixalink.io.test/api/spaces/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Modern Coworking Space\",
    \"description\": \"A modern coworking space in the heart of the city\",
    \"visibility\": \"Public\",
    \"email\": \"space@example.com\",
    \"phone_number\": \"ipsum\",
    \"website\": \"{{$baseUrl}}\",
    \"category_id\": 1,
    \"social_media\": [
        \"amet\"
    ],
    \"address\": [
        \"quasi\"
    ],
    \"tags\": [
        \"Coworking\",
        \"24\\/7\"
    ],
    \"classification\": [
        \"Premium\",
        \"Featured\"
    ]
}"

Example response:

{
    "data": {
        "id": 1,
        "uuid": "f2d75bf6-3cb8-305c-8f70-f71fe697cba3",
        "name": "Modern Coworking Space",
        "slug": "modern-coworking-space",
        "matterport_model_id": null,
        "description": "A modern coworking space in the heart of the city",
        "visibility": "public",
        "email": "space@example.com",
        "phone_number": "+60123456789",
        "website": "{{$baseUrl}}",
        "social_media": [
            {
                "name": "Twitter",
                "username": "@modernspace"
            }
        ],
        "tags": [
            "Coworking",
            "24/7"
        ],
        "classification": [
            "Premium",
            "Featured"
        ],
        "category_id": 1,
        "organisation_id": 1,
        "visits": 150,
        "created_at": "2024-02-02T12:00:00Z",
        "updated_at": "2024-02-02T12:00:00Z"
    }
}

Delete Space

DELETE

https://explore.pixalink.io.test

/api/spaces/{id}

requires authentication

Deletes a space and all its associated data including:

Address
Media (preview, gallery, logo)
Tags and classifications
Widgets
Posts
POS integration settings

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the space.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://explore.pixalink.io.test/api/spaces/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[Empty response]

Transactions

List Transactions

GET

https://explore.pixalink.io.test

/api/transactions

requires authentication

Get a paginated list of transactions for the organisation.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

filter[customer_id]

integer

Filter by customer ID.

Example:

filter[type]

string

Filter by transaction type. Available types:

Purchase: Points earned from purchases
Review: Points earned from reviews
Referral: Points earned from referrals
Point Reward Redeem: Points spent on reward redemption

Example:

Purchase

filter[space_id]

integer

Filter by space ID.

Example:

filter[amount]

string

Filter by amount with operators (>, <, =).

Example:

>100

filter[created_at]

string

Filter by date with operators.

Example:

>2024-01-01

filter[updated_at]

string

Filter by updated date with operators.

Example:

>2024-01-01

sort

string

Sort field (created_at, amount). Use -field for descending.

Example:

-created_at

include

string

Include relationships (customer, reward, space, customerRewards).

Example:

customer,reward,customerRewards

per_page

integer

Number of records per page.

Example:

Response Fields

integer

The unique identifier of the transaction.

amount

integer

The transaction amount in points.

valid_amount

integer|null

The remaining valid points amount if expiry is enabled.

operation

string

The operation type (+/-) indicating points earned or spent.

type

string

The transaction type:

Purchase: Points earned from purchases
Review: Points earned from reviews
Referral: Points earned from referrals
Point Reward Redeem: Points spent on reward redemption

remarks

string|null

Additional notes or description for the transaction.

customer_id

integer

The ID of the customer who earned/spent the points.

space_id

integer|null

The ID of the space where the transaction occurred.

reward_id

integer|null

The ID of the reward if this was a redemption transaction.

custom_properties

object|null

Custom fields associated with the transaction.

expired_at

string

datetime|null When the points from this transaction will expire.

created_at

string

datetime When the transaction was created.

updated_at

string

datetime When the transaction was last updated.

customer

object|null

The associated customer details if included:

id: The customer's ID
name: The customer's name
email: The customer's email
phone_number: The customer's phone number
current_point: Customer's current points balance
current_credits: Customer's current credits balance

reward

object|null

The associated reward details if included:

id: The reward's ID
name: The reward's name
amount: Points required for this reward
description: Description of the reward

space

object|null

The associated space details if included:

id: The space's ID
name: The space's name
slug: URL-friendly name
description: Description of the space

customerRewards

object[]|null

The associated customer rewards if included:

id: The customer reward's ID
customer_id: The customer's ID
reward_id: The reward's ID
status: The status of the reward (Pending, Used, Expired)
code: The unique code for the reward
expired_at: When the reward expires
used_at: When the reward was used

quantity

integer

The quantity multiplier for this transaction.

purchase_amount

decimal The original purchase amount associated with this transaction.

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/transactions?filter%5Bcustomer_id%5D=1&filter%5Btype%5D=Purchase&filter%5Bspace_id%5D=1&filter%5Bamount%5D=%3E100&filter%5Bcreated_at%5D=%3E2024-01-01&filter%5Bupdated_at%5D=%3E2024-01-01&sort=-created_at&include=customer%2Creward%2CcustomerRewards&per_page=15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "amount": 1000,
            "valid_amount": 1000,
            "operation": "+",
            "type": "Purchase",
            "remarks": "Purchase at Store #123",
            "customer_id": 1,
            "space_id": 1,
            "reward_id": null,
            "custom_properties": {
                "purchase_amount": 1000,
                "receipt_number": "R12345"
            },
            "expired_at": "2024-02-10T23:59:59.000000Z",
            "created_at": "2024-02-09T10:00:00.000000Z",
            "updated_at": "2024-02-09T10:00:00.000000Z",
            "customer": {
                "id": 1,
                "name": "John Smith",
                "email": "john.smith@example.com",
                "phone_number": "+60123456789",
                "current_point": 2500,
                "current_credits": 150
            }
        },
        {
            "id": 2,
            "amount": 500,
            "valid_amount": 500,
            "operation": "-",
            "type": "Point_Reward_Redeem",
            "remarks": "Reward: Free Coffee",
            "customer_id": 1,
            "space_id": 1,
            "reward_id": 5,
            "custom_properties": null,
            "expired_at": null,
            "created_at": "2024-02-08T15:30:00.000000Z",
            "updated_at": "2024-02-08T15:30:00.000000Z",
            "reward": {
                "id": 5,
                "name": "Free Coffee",
                "amount": 500,
                "description": "Redeem a free coffee at any of our locations"
            },
            "customerRewards": [
                {
                    "id": 1,
                    "status": "Used",
                    "code": null,
                    "expired_at": "2024-02-08T15:30:00.000000Z",
                    "used_at": "2024-02-08T15:30:00.000000Z",
                    "customer_id": 1,
                    "reward_id": 5
                }
            ]
        }
    ],
    "links": {
        "first": "{{$baseUrl}}/api/v1/transactions?page=1",
        "last": "{{$baseUrl}}/api/v1/transactions?page=5",
        "prev": null,
        "next": "{{$baseUrl}}/api/v1/transactions?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 5,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "{{$baseUrl}}/api/v1/transactions?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "{{$baseUrl}}/api/v1/transactions?page=2",
                "label": "2",
                "active": false
            }
        ],
        "path": "{{$baseUrl}}/api/v1/transactions",
        "per_page": 15,
        "to": 15,
        "total": 68
    }
}

Create Transaction

POST

https://explore.pixalink.io.test

/api/transactions

requires authentication

Creates a new transaction record for tracking customer points/rewards. If no existing customer is found, a new customer will be automatically created with the provided phone number. Key features:

Points are multiplied by the customer's tier multiplier if applicable
Points may expire based on organisation settings
Handles referral tracking and rewards
Sends notifications if enabled in organisation settings
Can mark linked customer rewards as used during transaction

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

customer_id

integer

Customer's ID. Required if phone_number not provided.

Example:

phone_number

string

Customer's phone number. Required if customer_id not provided.

Example:

+60123456789

amount

integer

required

Transaction amount/points.

Example:

1000

space_id

integer

optional Space ID where transaction occurred.

Example:

remarks

string

optional Additional remarks.

Example:

Purchase at Store #123

custom_properties

object

optional Custom fields for the transaction.

Example:

[]

customer_reward_ids

string[]

optional An array of customer reward IDs to be marked as used in this transaction. Only pending rewards that have not expired can be used.

Example:

[1,2,3]

Response Fields

integer

The transaction ID.

amount

integer

The transaction amount in points.

valid_amount

integer|null

Remaining valid points (if expiry enabled).

operation

string

+ for earned, - for spent.

type

string

Transaction type (Purchase, Review, Referral, Point Reward Redeem).

remarks

string|null

Optional notes.

customer_id

integer

The customer ID.

space_id

integer|null

The space where the transaction occurred.

reward_id

integer|null

The reward ID if this was a redemption.

expired_at

string

datetime|null When these points expire.

created_at

string

datetime When the transaction was created.

updated_at

string

datetime When the transaction was last updated.

quantity

integer

The quantity multiplier for this transaction.

custom_properties

object|null

Custom metadata attached to this transaction.

purchase_amount

decimal The original purchase amount associated with this transaction.

Auth

Bearer

Headers

Body

{ "customer_id": 1, "phone_number": "+60123456789", "amount": 1000, "space_id": 1, "remarks": "Purchase at Store #123", "custom_properties": [], "customer_reward_ids": [ 1, 2, 3 ] }

Received response

Example request:

curl --request POST \
    "https://explore.pixalink.io.test/api/transactions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"customer_id\": 1,
    \"phone_number\": \"+60123456789\",
    \"amount\": 1000,
    \"space_id\": 1,
    \"remarks\": \"Purchase at Store #123\",
    \"custom_properties\": [],
    \"customer_reward_ids\": [
        1,
        2,
        3
    ]
}"

Example response:

{
    "data": {
        "id": 1,
        "amount": 1000,
        "valid_amount": 1000,
        "operation": "+",
        "type": "Purchase",
        "remarks": "Purchase at Store #123",
        "customer_id": 1,
        "space_id": 1,
        "expired_at": "2024-02-10T23:59:59.000000Z",
        "created_at": "2024-02-09T10:00:00.000000Z",
        "updated_at": "2024-02-09T10:00:00.000000Z",
        "customer_rewards": [
            {
                "id": 1,
                "customer_id": 1,
                "reward_id": 5,
                "status": "Used",
                "code": "REWARD123",
                "expired_at": "2024-12-31T23:59:59.000000Z",
                "used_at": "2024-02-09T10:00:00.000000Z"
            },
            {
                "id": 2,
                "customer_id": 1,
                "reward_id": 6,
                "status": "Used",
                "code": "REWARD456",
                "expired_at": "2024-12-31T23:59:59.000000Z",
                "used_at": "2024-02-09T10:00:00.000000Z"
            }
        ]
    }
}

Get Transaction Details

GET

https://explore.pixalink.io.test

/api/transactions/{id}

requires authentication

Retrieve detailed information about a specific transaction.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the transaction.

Example:

transaction

integer

required

The ID of the transaction.

Example:

Query Parameters

include

string

Relationships to include (customer, reward, space, customerRewards).

Example:

customer,reward,customerRewards

Response Fields

integer

The transaction ID.

amount

integer

The transaction amount in points.

valid_amount

integer|null

Remaining valid points (if expiry enabled).

operation

string

+ for earned, - for spent.

type

string

Transaction type (Purchase, Review, Referral, Point Reward Redeem).

remarks

string|null

Optional notes.

customer_id

integer

The customer ID.

space_id

integer|null

The space where the transaction occurred.

reward_id

integer|null

The reward ID if this was a redemption.

expired_at

string

datetime|null When these points expire.

created_at

string

datetime When the transaction was created.

updated_at

string

datetime When the transaction was last updated.

quantity

integer

The quantity multiplier for this transaction.

custom_properties

object|null

Custom metadata attached to this transaction.

purchase_amount

decimal The original purchase amount associated with this transaction.

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/transactions/1?include=customer%2Creward%2CcustomerRewards" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": 1,
        "amount": 1000,
        "valid_amount": 1000,
        "operation": "+",
        "type": "Purchase",
        "remarks": "Purchase at Store #123",
        "customer_id": 1,
        "space_id": 1,
        "reward_id": null,
        "expired_at": "2024-12-31T23:59:59.000000Z",
        "created_at": "2024-02-09T10:00:00.000000Z",
        "updated_at": "2024-02-09T10:00:00.000000Z"
    }
}

Users

List Users

GET

https://explore.pixalink.io.test

/api/users

requires authentication

Returns a paginated list of users belonging to the authenticated user's organisation.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

filter[name]

string

Filter by user name (partial match).

Example:

Alice

filter[email]

string

Filter by email (partial match).

Example:

alice@example.com

sort

string

Sort field. Allowed: id, name, created_at.

Example:

-id

per_page

integer

Records per page.

Example:

Response Fields

integer

The user ID.

name

string

The user's name.

string

The user's email.

organisation_id

integer

The organisation ID.

roles

string[]

array List of role names assigned to the user.

last_login_at

string

datetime|null When the user last logged in.

created_at

string

datetime When the user was created.

updated_at

string

datetime When the user was last updated.

email_verified_at

datetime|null When the user verified their email, or null if unverified.

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/users?filter%5Bname%5D=Alice&filter%5Bemail%5D=alice%40example.com&sort=-id&per_page=15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "name": "Alice Tan",
            "email": "alice@acme.com",
            "organisation_id": 1,
            "roles": [
                "Super Admin"
            ],
            "last_login_at": "2024-06-01T08:00:00.000000Z",
            "created_at": "2024-01-01T00:00:00.000000Z",
            "updated_at": "2024-01-01T00:00:00.000000Z"
        }
    ],
    "links": {
        "first": "...",
        "last": "...",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 15,
        "to": 1,
        "total": 1
    }
}

Show User

GET

https://explore.pixalink.io.test

/api/users/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The user ID.

Example:

Response Fields

integer

The user ID.

name

string

The user's name.

string

The user's email.

organisation_id

integer

The organisation ID.

roles

array List of role names assigned to the user.

last_login_at

datetime|null When the user last logged in.

created_at

datetime When the user was created.

updated_at

datetime When the user was last updated.

email_verified_at

datetime|null When the user verified their email, or null if unverified.

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/users/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": 1,
        "name": "Alice",
        "email": "alice@example.com"
    }
}

Calendars

List Calendars

GET

https://explore.pixalink.io.test

/api/calendars

requires authentication

Returns a paginated list of calendars belonging to the authenticated user's organisation spaces.
Supports filtering, sorting and relationship inclusion through query parameters.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

include

string

Comma-separated list of relationships to include. Available relationships:

space
reservations

Example:

space,reservations

filter[space_id]

integer

Filter by space ID.

Example:

filter[is_active]

boolean

Filter by active status.

Example:

true

filter[visibility]

string

Filter by visibility. Must be one of: Public, Private.

Example:

Public

filter[name]

string

Filter by calendar name (partial match).

Example:

Meeting Room

sort

string

Sort field and direction. Note: Prefix with - for descending order. Available sort fields:

name
created_at
updated_at

Example:

-created_at

per_page

integer

Number of records per page. Defaults to 15.

Example:

Response Fields

integer

The unique identifier of the calendar.

name

string

The name of the calendar.

slug

string

The URL-friendly slug of the calendar.

description

string|null

Detailed description of the calendar.

is_active

boolean

Whether the calendar is currently active and accepting reservations.

space_id

integer

The ID of the space this calendar belongs to.

visibility

string

The visibility of the calendar. Values: Public, Private.

min_capacity

integer|null

Minimum capacity for reservations on this calendar.

max_capacity

integer|null

Maximum capacity for reservations on this calendar.

is_required_approval

boolean

Whether reservations require approval before confirmation.

is_auto_approval

boolean

Whether approved reservations are automatically confirmed.

cancel_before_minutes

integer|null

Number of minutes before the reservation start time that cancellation is allowed.

book_before_minutes

integer|null

Number of minutes before the reservation start time that booking is allowed.

reminder_minutes

integer|null

Number of minutes before the reservation to send reminders.

crm_auto_import

boolean

Whether to automatically import customers from reservations to CRM.

is_unavailable_timeslots_visible

boolean

Whether unavailable timeslots are shown to customers.

is_qr_code_visible

boolean

Whether QR codes are displayed for reservations.

default_timeslots

string[]

Default available time slots for this calendar.

block_dates

string[]

Array of blocked dates and time slots for this calendar.

notification_settings

object|null

Notification settings for calendar events.

custom_properties

object|null

Custom properties configured for this calendar.

channels

string[]

Available communication channels for notifications.

terms

string|null

Terms and conditions for using this calendar.

created_at

string

datetime Timestamp when the calendar was created.

updated_at

string

datetime Timestamp when the calendar was last updated.

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/calendars?include=space%2Creservations&filter%5Bspace_id%5D=1&filter%5Bis_active%5D=1&filter%5Bvisibility%5D=Public&filter%5Bname%5D=Meeting+Room&sort=-created_at&per_page=15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "name": "Meeting Room A",
            "slug": "meeting-room-a",
            "description": "Large meeting room for up to 20 people",
            "is_active": true,
            "space_id": 1,
            "visibility": "Public",
            "min_capacity": 1,
            "max_capacity": 20,
            "is_required_approval": false,
            "is_auto_approval": true,
            "cancel_before_minutes": 60,
            "book_before_minutes": 30,
            "reminder_minutes": 15,
            "crm_auto_import": true,
            "is_unavailable_timeslots_visible": false,
            "is_qr_code_visible": true,
            "default_timeslots": [
                {
                    "start_time": "09:00",
                    "end_time": "10:00",
                    "days": [
                        "monday",
                        "tuesday",
                        "wednesday",
                        "thursday",
                        "friday"
                    ]
                }
            ],
            "block_dates": [],
            "notification_settings": {
                "new_reservation": {
                    "enabled": true,
                    "message": "Your reservation has been confirmed"
                }
            },
            "custom_properties": {},
            "channels": [
                "WhatsApp",
                "Sms"
            ],
            "terms": "Please arrive 5 minutes before your scheduled time",
            "created_at": "2025-01-31T21:16:49.000000Z",
            "updated_at": "2025-01-31T21:16:49.000000Z"
        }
    ],
    "links": {
        "first": "{{$baseUrl}}/api/calendars?page=1",
        "last": "{{$baseUrl}}/api/calendars?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "{{$baseUrl}}/api/calendars",
        "per_page": 15,
        "to": 1,
        "total": 1
    }
}

Create Calendar

POST

https://explore.pixalink.io.test

/api/calendars

requires authentication

Creates a new calendar in the system.
The calendar will be associated with the specified space in the authenticated user's organisation.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

The calendar's name.

Example:

Meeting Room A

slug

string

The URL-friendly slug. Will be auto-generated if not provided.

Example:

meeting-room-a

description

string

Description of the calendar.

Example:

Large meeting room for up to 20 people

space_id

integer

required

The ID of the space this calendar belongs to. Must be from user's organisation.

Example:

is_active

boolean

Whether the calendar is active and accepting reservations. Default: true.

Example:

true

visibility

string

The visibility of the calendar. Must be one of: Public, Private. Default: Public.

Example:

Public

min_capacity

integer

Minimum capacity for reservations.

Example:

max_capacity

integer

Maximum capacity for reservations.

Example:

is_required_approval

boolean

Whether reservations require approval. Default: false.

Example:

false

is_auto_approval

boolean

Whether approved reservations are automatically confirmed. Default: true.

Example:

true

cancel_before_minutes

integer

Minutes before reservation start when cancellation is allowed.

Example:

book_before_minutes

integer

Minutes before reservation start when booking is allowed.

Example:

is_max_advance_booking_enabled

boolean

Whether to enable a maximum advance booking limit for this calendar.

Example:

false

max_advance_booking_days

integer

Maximum number of days in advance a customer can make a booking. Required when is_max_advance_booking_enabled is true. This field is required when is_max_advance_booking_enabled is true. Must be at least 1. Must not be greater than 365.

Example:

reminder_minutes

integer

Minutes before reservation to send reminders.

Example:

crm_auto_import

boolean

Whether to auto-import customers from reservations. Default: true.

Example:

true

is_unavailable_timeslots_visible

boolean

Whether to show unavailable timeslots to customers. Default: false.

Example:

false

is_qr_code_visible

boolean

Whether to display QR codes for reservations. Default: true.

Example:

true

default_timeslots

string[]

Default available time slots for the calendar.

block_dates

string[]

Array of blocked dates and time slots.

notification_settings

object

Notification settings for calendar events.

custom_properties

object

Custom properties for the calendar.

Example:

[]

channels

string[]

Communication channels for notifications.

Example:

["WhatsApp","Sms"]

terms

string

Terms and conditions for using the calendar.

Example:

Please arrive 5 minutes before your scheduled time

Response Fields

integer

The unique identifier of the calendar.

name

string

The name of the calendar.

slug

string

The URL-friendly slug of the calendar.

description

string|null

Detailed description of the calendar.

is_active

boolean

Whether the calendar is currently active and accepting reservations.

space_id

integer

The ID of the space this calendar belongs to.

visibility

string

The visibility of the calendar. Values: Public, Private.

min_capacity

integer|null

Minimum capacity for reservations on this calendar.

max_capacity

integer|null

Maximum capacity for reservations on this calendar.

is_required_approval

boolean

Whether reservations require approval before confirmation.

is_auto_approval

boolean

Whether approved reservations are automatically confirmed.

cancel_before_minutes

integer|null

Number of minutes before the reservation start time that cancellation is allowed.

book_before_minutes

integer|null

Number of minutes before the reservation start time that booking is allowed.

reminder_minutes

integer|null

Number of minutes before the reservation to send reminders.

crm_auto_import

boolean

Whether to automatically import customers from reservations to CRM.

is_unavailable_timeslots_visible

boolean

Whether unavailable timeslots are shown to customers.

is_qr_code_visible

boolean

Whether QR codes are displayed for reservations.

default_timeslots

string[]

Default available time slots for this calendar.

block_dates

string[]

Array of blocked dates and time slots for this calendar.

notification_settings

object|null

Notification settings for calendar events.

custom_properties

object|null

Custom properties configured for this calendar.

channels

string[]

Available communication channels for notifications.

terms

string|null

Terms and conditions for using this calendar.

created_at

string

datetime Timestamp when the calendar was created.

updated_at

string

datetime Timestamp when the calendar was last updated.

Auth

Bearer

Headers

Body

{ "name": "Meeting Room A", "slug": "meeting-room-a", "description": "Large meeting room for up to 20 people", "space_id": 1, "is_active": true, "visibility": "Public", "min_capacity": 1, "max_capacity": 20, "is_required_approval": false, "is_auto_approval": true, "cancel_before_minutes": 60, "book_before_minutes": 30, "is_max_advance_booking_enabled": false, "max_advance_booking_days": 30, "reminder_minutes": 15, "crm_auto_import": true, "is_unavailable_timeslots_visible": false, "is_qr_code_visible": true, "default_timeslots": { "start_time": "09:00", "end_time": "10:00", "days": [ "monday", "tuesday" ] }, "block_dates": { "type": "date", "data": [] }, "notification_settings": { "new_reservation": { "enabled": true, "message": "Your reservation has been confirmed" } }, "custom_properties": [], "channels": [ "WhatsApp", "Sms" ], "terms": "Please arrive 5 minutes before your scheduled time" }

Received response

Example request:

curl --request POST \
    "https://explore.pixalink.io.test/api/calendars" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Meeting Room A\",
    \"slug\": \"meeting-room-a\",
    \"description\": \"Large meeting room for up to 20 people\",
    \"space_id\": 1,
    \"is_active\": true,
    \"visibility\": \"Public\",
    \"min_capacity\": 1,
    \"max_capacity\": 20,
    \"is_required_approval\": false,
    \"is_auto_approval\": true,
    \"cancel_before_minutes\": 60,
    \"book_before_minutes\": 30,
    \"is_max_advance_booking_enabled\": false,
    \"max_advance_booking_days\": 30,
    \"reminder_minutes\": 15,
    \"crm_auto_import\": true,
    \"is_unavailable_timeslots_visible\": false,
    \"is_qr_code_visible\": true,
    \"default_timeslots\": [
        \"eos\"
    ],
    \"block_dates\": [
        \"autem\"
    ],
    \"notification_settings\": {
        \"new_reservation\": {
            \"enabled\": true,
            \"message\": \"Your reservation has been confirmed\"
        }
    },
    \"custom_properties\": [],
    \"channels\": [
        \"WhatsApp\",
        \"Sms\"
    ],
    \"terms\": \"Please arrive 5 minutes before your scheduled time\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://explore.pixalink.io.test/api/calendars';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Meeting Room A',
            'slug' => 'meeting-room-a',
            'description' => 'Large meeting room for up to 20 people',
            'space_id' => 1,
            'is_active' => true,
            'visibility' => 'Public',
            'min_capacity' => 1,
            'max_capacity' => 20,
            'is_required_approval' => false,
            'is_auto_approval' => true,
            'cancel_before_minutes' => 60,
            'book_before_minutes' => 30,
            'is_max_advance_booking_enabled' => false,
            'max_advance_booking_days' => 30,
            'reminder_minutes' => 15,
            'crm_auto_import' => true,
            'is_unavailable_timeslots_visible' => false,
            'is_qr_code_visible' => true,
            'default_timeslots' => [
                'eos',
            ],
            'block_dates' => [
                'autem',
            ],
            'notification_settings' => [
                'new_reservation' => [
                    'enabled' => true,
                    'message' => 'Your reservation has been confirmed',
                ],
            ],
            'custom_properties' => [],
            'channels' => [
                'WhatsApp',
                'Sms',
            ],
            'terms' => 'Please arrive 5 minutes before your scheduled time',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response:

{
    "data": {
        "id": 1,
        "name": "Meeting Room A",
        "slug": "meeting-room-a",
        "description": "Large meeting room for up to 20 people",
        "is_active": true,
        "space_id": 1,
        "visibility": "Public",
        "min_capacity": 1,
        "max_capacity": 20,
        "is_required_approval": false,
        "is_auto_approval": true,
        "cancel_before_minutes": 60,
        "book_before_minutes": 30,
        "reminder_minutes": 15,
        "crm_auto_import": true,
        "is_unavailable_timeslots_visible": false,
        "is_qr_code_visible": true,
        "default_timeslots": [
            {
                "start_time": "09:00",
                "end_time": "10:00",
                "days": [
                    "monday",
                    "tuesday",
                    "wednesday",
                    "thursday",
                    "friday"
                ]
            }
        ],
        "block_dates": [],
        "notification_settings": {
            "new_reservation": {
                "enabled": true,
                "message": "Your reservation has been confirmed"
            }
        },
        "custom_properties": {},
        "channels": [
            "WhatsApp",
            "Sms"
        ],
        "terms": "Please arrive 5 minutes before your scheduled time",
        "created_at": "2025-01-31T21:16:49.000000Z",
        "updated_at": "2025-01-31T21:16:49.000000Z"
    },
    "message": "Calendar created successfully"
}

Show Calendar Details

GET

https://explore.pixalink.io.test

/api/calendars/{id}

requires authentication

Retrieves detailed information about a specific calendar, including any requested relationships.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the calendar.

Example:

Query Parameters

include

string

Comma-separated list of relationships to include. Available relationships:

space
reservations

Example:

space,reservations

Response Fields

integer

The unique identifier of the calendar.

name

string

The name of the calendar.

slug

string

The URL-friendly slug of the calendar.

description

string|null

Detailed description of the calendar.

is_active

boolean

Whether the calendar is currently active and accepting reservations.

space_id

integer

The ID of the space this calendar belongs to.

visibility

string

The visibility of the calendar. Values: Public, Private.

min_capacity

integer|null

Minimum capacity for reservations on this calendar.

max_capacity

integer|null

Maximum capacity for reservations on this calendar.

is_required_approval

boolean

Whether reservations require approval before confirmation.

is_auto_approval

boolean

Whether approved reservations are automatically confirmed.

cancel_before_minutes

integer|null

Number of minutes before the reservation start time that cancellation is allowed.

book_before_minutes

integer|null

Number of minutes before the reservation start time that booking is allowed.

reminder_minutes

integer|null

Number of minutes before the reservation to send reminders.

crm_auto_import

boolean

Whether to automatically import customers from reservations to CRM.

is_unavailable_timeslots_visible

boolean

Whether unavailable timeslots are shown to customers.

is_qr_code_visible

boolean

Whether QR codes are displayed for reservations.

default_timeslots

string[]

Default available time slots for this calendar.

block_dates

string[]

Array of blocked dates and time slots for this calendar.

notification_settings

object|null

Notification settings for calendar events.

custom_properties

object|null

Custom properties configured for this calendar.

channels

string[]

Available communication channels for notifications.

terms

string|null

Terms and conditions for using this calendar.

created_at

string

datetime Timestamp when the calendar was created.

updated_at

string

datetime Timestamp when the calendar was last updated.

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/calendars/1?include=space%2Creservations" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": 1,
        "name": "Meeting Room A",
        "slug": "meeting-room-a",
        "description": "Large meeting room for up to 20 people",
        "is_active": true,
        "space_id": 1,
        "visibility": "Public",
        "min_capacity": 1,
        "max_capacity": 20,
        "is_required_approval": false,
        "is_auto_approval": true,
        "cancel_before_minutes": 60,
        "book_before_minutes": 30,
        "reminder_minutes": 15,
        "crm_auto_import": true,
        "is_unavailable_timeslots_visible": false,
        "is_qr_code_visible": true,
        "default_timeslots": [
            {
                "start_time": "09:00",
                "end_time": "10:00",
                "days": [
                    "monday",
                    "tuesday",
                    "wednesday",
                    "thursday",
                    "friday"
                ]
            }
        ],
        "block_dates": [],
        "notification_settings": {
            "new_reservation": {
                "enabled": true,
                "message": "Your reservation has been confirmed"
            }
        },
        "custom_properties": {},
        "channels": [
            "WhatsApp",
            "Sms"
        ],
        "terms": "Please arrive 5 minutes before your scheduled time",
        "created_at": "2025-01-31T21:16:49.000000Z",
        "updated_at": "2025-01-31T21:16:49.000000Z"
    }
}

Update Calendar

PUT

PATCH

https://explore.pixalink.io.test

/api/calendars/{id}

requires authentication

Updates an existing calendar's information.
All fields are optional.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the calendar.

Example:

Body Parameters

name

string

The calendar's name.

Example:

Meeting Room A

slug

string

The URL-friendly slug.

Example:

meeting-room-a

description

string

Description of the calendar.

Example:

Large meeting room for up to 20 people

space_id

integer

The ID of the space this calendar belongs to. Must be from user's organisation.

Example:

is_active

boolean

Whether the calendar is active and accepting reservations.

Example:

true

visibility

string

The visibility of the calendar. Must be one of: Public, Private.

Example:

Public

min_capacity

integer

Minimum capacity for reservations.

Example:

max_capacity

integer

Maximum capacity for reservations.

Example:

is_required_approval

boolean

Whether reservations require approval.

Example:

false

is_auto_approval

boolean

Whether approved reservations are automatically confirmed.

Example:

true

cancel_before_minutes

integer

Minutes before reservation start when cancellation is allowed.

Example:

book_before_minutes

integer

Minutes before reservation start when booking is allowed.

Example:

is_max_advance_booking_enabled

boolean

Whether to enable a maximum advance booking limit for this calendar.

Example:

false

max_advance_booking_days

integer

Example:

reminder_minutes

integer

Minutes before reservation to send reminders.

Example:

crm_auto_import

boolean

Whether to auto-import customers from reservations.

Example:

true

is_unavailable_timeslots_visible

boolean

Whether to show unavailable timeslots to customers.

Example:

false

is_qr_code_visible

boolean

Whether to display QR codes for reservations.

Example:

true

default_timeslots

string[]

Default available time slots for the calendar.

block_dates

string[]

Array of blocked dates and time slots.

notification_settings

object

Notification settings for calendar events.

custom_properties

object

Custom properties for the calendar.

Example:

[]

channels

string[]

Communication channels for notifications.

Example:

["WhatsApp","Sms"]

terms

string

Terms and conditions for using the calendar.

Example:

Please arrive 5 minutes before your scheduled time

Response Fields

integer

The unique identifier of the calendar.

name

string

The name of the calendar.

slug

string

The URL-friendly slug of the calendar.

description

string|null

Detailed description of the calendar.

is_active

boolean

Whether the calendar is currently active and accepting reservations.

space_id

integer

The ID of the space this calendar belongs to.

visibility

string

The visibility of the calendar. Values: Public, Private.

min_capacity

integer|null

Minimum capacity for reservations on this calendar.

max_capacity

integer|null

Maximum capacity for reservations on this calendar.

is_required_approval

boolean

Whether reservations require approval before confirmation.

is_auto_approval

boolean

Whether approved reservations are automatically confirmed.

cancel_before_minutes

integer|null

Number of minutes before the reservation start time that cancellation is allowed.

book_before_minutes

integer|null

Number of minutes before the reservation start time that booking is allowed.

reminder_minutes

integer|null

Number of minutes before the reservation to send reminders.

crm_auto_import

boolean

Whether to automatically import customers from reservations to CRM.

is_unavailable_timeslots_visible

boolean

Whether unavailable timeslots are shown to customers.

is_qr_code_visible

boolean

Whether QR codes are displayed for reservations.

default_timeslots

string[]

Default available time slots for this calendar.

block_dates

string[]

Array of blocked dates and time slots for this calendar.

notification_settings

object|null

Notification settings for calendar events.

custom_properties

object|null

Custom properties configured for this calendar.

channels

string[]

Available communication channels for notifications.

terms

string|null

Terms and conditions for using this calendar.

created_at

string

datetime Timestamp when the calendar was created.

updated_at

string

datetime Timestamp when the calendar was last updated.

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "Meeting Room A", "slug": "meeting-room-a", "description": "Large meeting room for up to 20 people", "space_id": 1, "is_active": true, "visibility": "Public", "min_capacity": 1, "max_capacity": 20, "is_required_approval": false, "is_auto_approval": true, "cancel_before_minutes": 60, "book_before_minutes": 30, "is_max_advance_booking_enabled": false, "max_advance_booking_days": 30, "reminder_minutes": 15, "crm_auto_import": true, "is_unavailable_timeslots_visible": false, "is_qr_code_visible": true, "default_timeslots": { "start_time": "09:00", "end_time": "10:00", "days": [ "monday", "tuesday" ] }, "block_dates": { "type": "date", "data": { "date": "2025-12-25" } }, "notification_settings": { "new_reservation": { "enabled": true, "message": "Your reservation for {{CALENDAR_NAME}} has been confirmed for {{RESERVATION_DATE}} at {{RESERVATION_TIME}}." } }, "custom_properties": [], "channels": [ "WhatsApp", "Sms" ], "terms": "Please arrive 5 minutes before your scheduled time" }

Received response

Example request:

curl --request PUT \
    "https://explore.pixalink.io.test/api/calendars/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Meeting Room A\",
    \"slug\": \"meeting-room-a\",
    \"description\": \"Large meeting room for up to 20 people\",
    \"space_id\": 1,
    \"is_active\": true,
    \"visibility\": \"Public\",
    \"min_capacity\": 1,
    \"max_capacity\": 20,
    \"is_required_approval\": false,
    \"is_auto_approval\": true,
    \"cancel_before_minutes\": 60,
    \"book_before_minutes\": 30,
    \"is_max_advance_booking_enabled\": false,
    \"max_advance_booking_days\": 30,
    \"reminder_minutes\": 15,
    \"crm_auto_import\": true,
    \"is_unavailable_timeslots_visible\": false,
    \"is_qr_code_visible\": true,
    \"default_timeslots\": [
        \"et\"
    ],
    \"block_dates\": [
        \"deleniti\"
    ],
    \"notification_settings\": {
        \"new_reservation\": {
            \"enabled\": true,
            \"message\": \"Your reservation has been confirmed.\"
        }
    },
    \"custom_properties\": [],
    \"channels\": [
        \"WhatsApp\",
        \"Sms\"
    ],
    \"terms\": \"Please arrive 5 minutes before your scheduled time\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://explore.pixalink.io.test/api/calendars/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Meeting Room A',
            'slug' => 'meeting-room-a',
            'description' => 'Large meeting room for up to 20 people',
            'space_id' => 1,
            'is_active' => true,
            'visibility' => 'Public',
            'min_capacity' => 1,
            'max_capacity' => 20,
            'is_required_approval' => false,
            'is_auto_approval' => true,
            'cancel_before_minutes' => 60,
            'book_before_minutes' => 30,
            'is_max_advance_booking_enabled' => false,
            'max_advance_booking_days' => 30,
            'reminder_minutes' => 15,
            'crm_auto_import' => true,
            'is_unavailable_timeslots_visible' => false,
            'is_qr_code_visible' => true,
            'default_timeslots' => [
                'et',
            ],
            'block_dates' => [
                'deleniti',
            ],
            'notification_settings' => [
                'new_reservation' => [
                    'enabled' => true,
                    'message' => 'Your reservation has been confirmed.',
                ],
            ],
            'custom_properties' => [],
            'channels' => [
                'WhatsApp',
                'Sms',
            ],
            'terms' => 'Please arrive 5 minutes before your scheduled time',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response:

{
    "data": {
        "id": 1,
        "name": "Meeting Room A",
        "slug": "meeting-room-a",
        "description": "Large meeting room for up to 20 people",
        "is_active": true,
        "space_id": 1,
        "visibility": "Public",
        "min_capacity": 1,
        "max_capacity": 20,
        "is_required_approval": false,
        "is_auto_approval": true,
        "cancel_before_minutes": 60,
        "book_before_minutes": 30,
        "reminder_minutes": 15,
        "crm_auto_import": true,
        "is_unavailable_timeslots_visible": false,
        "is_qr_code_visible": true,
        "default_timeslots": [
            {
                "start_time": "09:00",
                "end_time": "10:00",
                "days": [
                    "monday",
                    "tuesday",
                    "wednesday",
                    "thursday",
                    "friday"
                ]
            }
        ],
        "block_dates": [],
        "notification_settings": {
            "new_reservation": {
                "enabled": true,
                "message": "Your reservation has been confirmed"
            }
        },
        "custom_properties": {},
        "channels": [
            "WhatsApp",
            "Sms"
        ],
        "terms": "Please arrive 5 minutes before your scheduled time",
        "created_at": "2025-01-31T21:16:49.000000Z",
        "updated_at": "2025-01-31T21:16:49.000000Z"
    },
    "message": "Calendar updated successfully"
}

Delete Calendar

DELETE

https://explore.pixalink.io.test

/api/calendars/{id}

requires authentication

Deletes a calendar from the system.
Only calendars without active reservations can be deleted.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the calendar.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://explore.pixalink.io.test/api/calendars/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[Empty response]

Reservations

List Reservations

GET

https://explore.pixalink.io.test

/api/reservations

requires authentication

Returns a paginated list of reservations belonging to the authenticated user's organisation.
Results can be filtered, sorted and include related data through query parameters.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

include

string

Comma-separated list of relationships to include:

calendar
customer
calendar.space

Example:

calendar,customer

filter[calendar_id]

integer

Filter by calendar ID.

Example:

filter[customer_id]

integer

Filter by customer ID.

Example:

filter[status]

string

Filter by reservation status. Must be one of:

pending
rejected
reserved
cancelled
no_show

Example:

reserved

filter[date]

string

Filter by reservation date. Use ISO 8601 format (YYYY-MM-DD).

Example:

2024-01-01

filter[date_from]

string

Filter reservations from this date onwards (inclusive). Use ISO 8601 format (YYYY-MM-DD).

Example:

2024-01-01

filter[date_to]

string

Filter reservations up to this date (inclusive). Use ISO 8601 format (YYYY-MM-DD).

Example:

2024-01-31

filter[name]

string

Filter by customer name (partial match).

Example:

John

filter[email]

string

Filter by customer email (partial match).

Example:

john@example.com

filter[phone_number]

string

Filter by customer phone number (partial match).

Example:

+60123

sort

string

Sort field and direction. Allowed fields: date, start_at, created_at, status, name.

Example:

-date

per_page

integer

Number of records per page.

Example:

Response Fields

integer

The ID of the reservation

ref_id

string

The unique reference ID of the reservation

date

string

The date of the reservation in Y-m-d format

start_at

string

The start date and time of the reservation in ISO 8601 format

end_at

string

The end date and time of the reservation in ISO 8601 format

name

string

The name of the person making the reservation

string|null

The email address of the person making the reservation

phone_number

string|null

The phone number of the person making the reservation

number_of_guests

integer

The number of guests for the reservation

status

string

The current status of the reservation:

pending: Awaiting approval or processing
rejected: Reservation has been declined
reserved: Reservation is confirmed
cancelled: Reservation has been cancelled
no_show: Customer did not show up for the reservation

remarks

string|null

Additional remarks or notes about the reservation

custom_fields

object|null

Custom fields associated with the reservation

timeslot_id

integer|null

The ID of the associated timeslot

calendar_id

integer

The ID of the calendar this reservation belongs to

customer_id

integer|null

The ID of the associated customer (if any)

reminder_sent_at

string|null

The timestamp when reminder was sent in ISO 8601 format

rejection_reason

string|null

The reason for rejection (if status is rejected)

created_at

string

The timestamp when the reservation was created in ISO 8601 format

updated_at

string

The timestamp when the reservation was last updated in ISO 8601 format

calendar

object

The calendar information (included when relationships are loaded)

customer

object|null

The customer information (included when relationships are loaded)

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/reservations?include=calendar%2Ccustomer&filter%5Bcalendar_id%5D=1&filter%5Bcustomer_id%5D=1&filter%5Bstatus%5D=reserved&filter%5Bdate%5D=2024-01-01&filter%5Bdate_from%5D=2024-01-01&filter%5Bdate_to%5D=2024-01-31&filter%5Bname%5D=John&filter%5Bemail%5D=john%40example.com&filter%5Bphone_number%5D=%2B60123&sort=-date&per_page=15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "ref_id": "RSV001234",
            "date": "2024-03-15",
            "start_at": "2024-03-15T14:30:00.000000Z",
            "end_at": "2024-03-15T16:00:00.000000Z",
            "name": "John Smith",
            "email": "john.smith@example.com",
            "phone_number": "+60123456789",
            "number_of_guests": 4,
            "status": "reserved",
            "remarks": "Birthday celebration",
            "custom_fields": {
                "dietary_requirements": "Vegetarian",
                "special_requests": "Window seat preferred"
            },
            "timeslot_id": 5,
            "calendar_id": 1,
            "customer_id": 123,
            "reminder_sent_at": "2024-03-14T14:30:00.000000Z",
            "rejection_reason": null,
            "created_at": "2024-03-01T10:15:30.000000Z",
            "updated_at": "2024-03-10T16:22:45.000000Z",
            "calendar": {
                "id": 1,
                "name": "Restaurant Reservations",
                "slug": "restaurant-reservations",
                "description": "Main dining room reservations",
                "is_active": true,
                "space_id": 1,
                "visibility": "public",
                "min_capacity": 1,
                "max_capacity": 8,
                "is_required_approval": true,
                "is_auto_approval": false,
                "cancel_before_minutes": 60,
                "book_before_minutes": 30,
                "reminder_minutes": 1440,
                "crm_auto_import": true,
                "is_unavailable_timeslots_visible": false,
                "is_qr_code_visible": true,
                "space": {
                    "id": 1,
                    "name": "Main Branch",
                    "slug": "main-branch",
                    "description": "Our flagship restaurant location"
                }
            },
            "customer": {
                "id": 123,
                "name": "John Smith",
                "email": "john.smith@example.com",
                "phone_number": "+60123456789",
                "current_point": 2500,
                "tier_id": 2
            }
        }
    ],
    "links": {
        "first": "{{$baseUrl}}/reservations?page=1",
        "last": "{{$baseUrl}}/reservations?page=5",
        "prev": null,
        "next": "{{$baseUrl}}/reservations?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 5,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "{{$baseUrl}}/reservations?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "{{$baseUrl}}/reservations?page=2",
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "{{$baseUrl}}/reservations",
        "per_page": 15,
        "to": 15,
        "total": 68
    }
}

Create Reservation

POST

https://explore.pixalink.io.test

/api/reservations

requires authentication

Creates a new reservation in the system.
The reservation will be associated with a calendar and optionally with a customer.
Auto-generates a unique reference ID.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

date

string

required

The date of the reservation in Y-m-d format. Must be a valid date. Must be a date after or equal to today.

Example:

2024-03-15

start_at

string

required

The start date and time of the reservation in ISO 8601 format. Must be a valid date. Must be a date after date.

Example:

2024-03-15T14:30:00Z

end_at

string

required

The end date and time of the reservation in ISO 8601 format. Must be a valid date. Must be a date after start_at.

Example:

2024-03-15T16:00:00Z

name

string

required

The full name of the person making the reservation. Must not be greater than 255 characters.

Example:

John Smith

string

The email address of the person making the reservation. Must be a valid email address. Must not be greater than 255 characters.

Example:

john.smith@example.com

phone_number

string

The phone number of the person making the reservation. Must not be greater than 255 characters.

Example:

+60123456789

number_of_guests

integer

required

The number of guests for the reservation. Must be at least 1. Must be at least 1. Must not be greater than 999.

Example:

status

string

required

The initial status of the reservation.

Must be one of:

pending
reserved
cancelled
rejected
no_show

Example:

pending

remarks

string

Additional remarks or notes about the reservation. Must not be greater than 65535 characters.

Example:

Birthday celebration, window seat preferred

custom_fields

object

Custom fields as key-value pairs for additional reservation data.

Example:

{"dietary_requirements":"Vegetarian","special_requests":"Birthday cake arrangement"}

timeslot_id

integer

The ID of the associated timeslot, if applicable.

Example:

calendar_id

string

required

The ID of the calendar this reservation belongs to. Must belong to your organisation and accessible spaces.

Example:

customer_id

string

The ID of the associated customer, if the reservation is linked to an existing customer. The id of an existing record in the customers table.

Example:

123

rejection_reason

string

The reason for rejection if the status is set to rejected. Must not be greater than 65535 characters.

Example:

Fully booked on requested date

Response Fields

integer

The ID of the reservation

ref_id

string

The unique reference ID of the reservation

date

string

The date of the reservation in Y-m-d format

start_at

string

The start date and time of the reservation in ISO 8601 format

end_at

string

The end date and time of the reservation in ISO 8601 format

name

string

The name of the person making the reservation

string|null

The email address of the person making the reservation

phone_number

string|null

The phone number of the person making the reservation

number_of_guests

integer

The number of guests for the reservation

status

string

The current status of the reservation

remarks

string|null

Additional remarks or notes about the reservation

custom_fields

object|null

Custom fields associated with the reservation

timeslot_id

integer|null

The ID of the associated timeslot

calendar_id

integer

The ID of the calendar this reservation belongs to

customer_id

integer|null

The ID of the associated customer (if any)

reminder_sent_at

string|null

The timestamp when reminder was sent in ISO 8601 format

rejection_reason

string|null

The reason for rejection (if status is rejected)

created_at

string

The timestamp when the reservation was created in ISO 8601 format

updated_at

string

The timestamp when the reservation was last updated in ISO 8601 format

Auth

Bearer

Headers

Body

{ "date": "2024-03-15", "start_at": "2024-03-15T14:30:00Z", "end_at": "2024-03-15T16:00:00Z", "name": "John Smith", "email": "john.smith@example.com", "phone_number": "+60123456789", "number_of_guests": 4, "status": "pending", "remarks": "Birthday celebration, window seat preferred", "custom_fields": { "dietary_requirements": "Vegetarian", "special_requests": "Birthday cake arrangement" }, "timeslot_id": 5, "calendar_id": 1, "customer_id": 123, "rejection_reason": "Fully booked on requested date" }

Received response

Example request:

curl --request POST \
    "https://explore.pixalink.io.test/api/reservations" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"date\": \"2024-03-15\",
    \"start_at\": \"2024-03-15T14:30:00Z\",
    \"end_at\": \"2024-03-15T16:00:00Z\",
    \"name\": \"John Smith\",
    \"email\": \"john.smith@example.com\",
    \"phone_number\": \"+60123456789\",
    \"number_of_guests\": 4,
    \"status\": \"pending\",
    \"remarks\": \"Birthday celebration, window seat preferred\",
    \"custom_fields\": {
        \"dietary_requirements\": \"Vegetarian\",
        \"special_requests\": \"Birthday cake arrangement\"
    },
    \"timeslot_id\": 5,
    \"calendar_id\": 1,
    \"customer_id\": 123,
    \"rejection_reason\": \"Fully booked on requested date\"
}"

Example response:

{
    "data": {
        "id": 1,
        "ref_id": "RSV001234",
        "date": "2024-03-15",
        "start_at": "2024-03-15T14:30:00.000000Z",
        "end_at": "2024-03-15T16:00:00.000000Z",
        "name": "John Smith",
        "email": "john.smith@example.com",
        "phone_number": "+60123456789",
        "number_of_guests": 4,
        "status": "pending",
        "remarks": "Birthday celebration",
        "custom_fields": {
            "dietary_requirements": "Vegetarian"
        },
        "timeslot_id": null,
        "calendar_id": 1,
        "customer_id": null,
        "reminder_sent_at": null,
        "rejection_reason": null,
        "created_at": "2024-03-01T10:15:30.000000Z",
        "updated_at": "2024-03-01T10:15:30.000000Z"
    },
    "message": "Reservation created successfully"
}

Show Reservation Details

GET

https://explore.pixalink.io.test

/api/reservations/{id}

requires authentication

Retrieves detailed information about a specific reservation, including any requested relationships.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the reservation to show.

Example:

Query Parameters

include

string

Comma-separated list of relationships to include. Available relationships:

calendar
customer
calendar.space

Example:

calendar,customer

Response Fields

integer

The ID of the reservation

ref_id

string

The unique reference ID of the reservation

date

string

The date of the reservation in Y-m-d format

start_at

string

The start date and time of the reservation in ISO 8601 format

end_at

string

The end date and time of the reservation in ISO 8601 format

name

string

The name of the person making the reservation

string|null

The email address of the person making the reservation

phone_number

string|null

The phone number of the person making the reservation

number_of_guests

integer

The number of guests for the reservation

status

string

The current status of the reservation

remarks

string|null

Additional remarks or notes about the reservation

custom_fields

object|null

Custom fields associated with the reservation

timeslot_id

integer|null

The ID of the associated timeslot

calendar_id

integer

The ID of the calendar this reservation belongs to

customer_id

integer|null

The ID of the associated customer (if any)

reminder_sent_at

string|null

The timestamp when reminder was sent in ISO 8601 format

rejection_reason

string|null

The reason for rejection (if status is rejected)

created_at

string

The timestamp when the reservation was created in ISO 8601 format

updated_at

string

The timestamp when the reservation was last updated in ISO 8601 format

calendar

object

Calendar information (included when relationship is loaded)

customer

object|null

Customer information (included when relationship is loaded)

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/reservations/1?include=calendar%2Ccustomer" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "id": 1,
        "ref_id": "RSV001234",
        "date": "2024-03-15",
        "start_at": "2024-03-15T14:30:00.000000Z",
        "end_at": "2024-03-15T16:00:00.000000Z",
        "name": "John Smith",
        "email": "john.smith@example.com",
        "phone_number": "+60123456789",
        "number_of_guests": 4,
        "status": "reserved",
        "remarks": "Birthday celebration",
        "custom_fields": {
            "dietary_requirements": "Vegetarian"
        },
        "timeslot_id": 5,
        "calendar_id": 1,
        "customer_id": 123,
        "reminder_sent_at": "2024-03-14T14:30:00.000000Z",
        "rejection_reason": null,
        "created_at": "2024-03-01T10:15:30.000000Z",
        "updated_at": "2024-03-10T16:22:45.000000Z",
        "calendar": {
            "id": 1,
            "name": "Restaurant Reservations",
            "space_id": 1
        }
    }
}

Update Reservation

PUT

PATCH

https://explore.pixalink.io.test

/api/reservations/{id}

requires authentication

Updates an existing reservation's information.
All fields are optional.
Status transitions are validated according to business rules.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the reservation to update.

Example:

Body Parameters

date

string

The date of the reservation in Y-m-d format. Must be a valid date. Must be a date after or equal to today.

Example:

2024-03-15

start_at

string

The start date and time of the reservation in ISO 8601 format. Must be a valid date. Must be a date after date.

Example:

2024-03-15T14:30:00Z

end_at

string

The end date and time of the reservation in ISO 8601 format. Must be a valid date. Must be a date after start_at.

Example:

2024-03-15T16:00:00Z

name

string

The full name of the person making the reservation. Must not be greater than 255 characters.

Example:

John Smith

string

The email address of the person making the reservation. Must be a valid email address. Must not be greater than 255 characters.

Example:

john.smith@example.com

phone_number

string

The phone number of the person making the reservation. Must not be greater than 255 characters.

Example:

+60123456789

number_of_guests

integer

The number of guests for the reservation. Must be at least 1. Must be at least 1. Must not be greater than 999.

Example:

status

string

The initial status of the reservation.

Must be one of:

pending
reserved
cancelled
rejected
no_show

Example:

pending

remarks

string

Additional remarks or notes about the reservation. Must not be greater than 65535 characters.

Example:

Birthday celebration, window seat preferred

custom_fields

object

Custom fields as key-value pairs for additional reservation data.

Example:

{"dietary_requirements":"Vegetarian","special_requests":"Birthday cake arrangement"}

timeslot_id

integer

The ID of the associated timeslot, if applicable.

Example:

calendar_id

string

The ID of the calendar this reservation belongs to. Must belong to your organisation and accessible spaces.

Example:

customer_id

string

The ID of the associated customer, if the reservation is linked to an existing customer. The id of an existing record in the customers table.

Example:

123

rejection_reason

string

The reason for rejection if the status is set to rejected. Must not be greater than 65535 characters.

Example:

Fully booked on requested date

Response Fields

integer

The ID of the reservation

ref_id

string

The unique reference ID of the reservation

date

string

The date of the reservation in Y-m-d format

start_at

string

The start date and time of the reservation in ISO 8601 format

end_at

string

The end date and time of the reservation in ISO 8601 format

name

string

The name of the person making the reservation

string|null

The email address of the person making the reservation

phone_number

string|null

The phone number of the person making the reservation

number_of_guests

integer

The number of guests for the reservation

status

string

The current status of the reservation

remarks

string|null

Additional remarks or notes about the reservation

custom_fields

object|null

Custom fields associated with the reservation

timeslot_id

integer|null

The ID of the associated timeslot

calendar_id

integer

The ID of the calendar this reservation belongs to

customer_id

integer|null

The ID of the associated customer (if any)

reminder_sent_at

string|null

The timestamp when reminder was sent in ISO 8601 format

rejection_reason

string|null

The reason for rejection (if status is rejected)

created_at

string

The timestamp when the reservation was created in ISO 8601 format

updated_at

string

The timestamp when the reservation was last updated in ISO 8601 format

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request PUT \
    "https://explore.pixalink.io.test/api/reservations/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"date\": \"2024-03-15\",
    \"start_at\": \"2024-03-15T14:30:00Z\",
    \"end_at\": \"2024-03-15T16:00:00Z\",
    \"name\": \"John Smith\",
    \"email\": \"john.smith@example.com\",
    \"phone_number\": \"+60123456789\",
    \"number_of_guests\": 4,
    \"status\": \"pending\",
    \"remarks\": \"Birthday celebration, window seat preferred\",
    \"custom_fields\": {
        \"dietary_requirements\": \"Vegetarian\",
        \"special_requests\": \"Birthday cake arrangement\"
    },
    \"timeslot_id\": 5,
    \"calendar_id\": 1,
    \"customer_id\": 123,
    \"rejection_reason\": \"Fully booked on requested date\"
}"

Example response:

{
    "data": {
        "id": 1,
        "ref_id": "RSV001234",
        "date": "2024-03-15",
        "start_at": "2024-03-15T14:30:00.000000Z",
        "end_at": "2024-03-15T16:00:00.000000Z",
        "name": "John Smith",
        "email": "john.smith@example.com",
        "phone_number": "+60123456789",
        "number_of_guests": 6,
        "status": "reserved",
        "remarks": "Anniversary celebration - updated guest count",
        "custom_fields": {
            "dietary_requirements": "Vegetarian, Gluten-free"
        },
        "timeslot_id": 5,
        "calendar_id": 1,
        "customer_id": 123,
        "reminder_sent_at": "2024-03-14T14:30:00.000000Z",
        "rejection_reason": null,
        "created_at": "2024-03-01T10:15:30.000000Z",
        "updated_at": "2024-03-10T16:22:45.000000Z"
    },
    "message": "Reservation updated successfully"
}

Delete Reservation

DELETE

https://explore.pixalink.io.test

/api/reservations/{id}

requires authentication

Soft deletes a reservation from the system.
The reservation can be restored later if needed.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the reservation to delete.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://explore.pixalink.io.test/api/reservations/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "message": "Reservation deleted successfully"
}

Endpoints

Get authenticated user

GET

https://explore.pixalink.io.test

/api/user

requires authentication

Retrieves the currently authenticated user's information.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Response Fields

integer

The unique identifier of the user

organisation_id

integer

The ID of the organisation the user belongs to

name

string

The user's full name

string

The user's email address

email_verified_at

string

datetime The timestamp when the user's email was verified

created_at

string

datetime The timestamp when the user was created

updated_at

string

datetime The timestamp when the user was last updated

deleted_at

datetime|null The timestamp when the user was deleted, null if not deleted

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/user" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "id": 3,
    "organisation_id": 2,
    "name": "User",
    "email": "vendor@pixalink.io",
    "email_verified_at": "2025-01-31T21:16:49.000000Z",
    "created_at": "2025-01-31T21:16:49.000000Z",
    "updated_at": "2025-01-31T21:16:49.000000Z",
    "deleted_at": null
}

Location Management

List all countries

GET

https://explore.pixalink.io.test

/api/countries

requires authentication

Get a list of all countries with their details.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

filter[name]

string

Filter countries by name.

Example:

Malaysia

filter[nationality]

string

Filter countries by nationality.

Example:

Malaysian

filter[iso]

string

Filter countries by ISO code.

Example:

per_page

integer

Number of records to display per page.

Example:

Response Fields

integer

The ID of the country

name

string

The name of the country

nationality

string

The nationality of the country's citizens

iso

string

The 2-letter ISO code

iso3

string

The 3-letter ISO code

nice_name

string

The display-friendly name of the country.

states_count

integer

Number of states/regions in this country.

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/countries?filter%5Bname%5D=Malaysia&filter%5Bnationality%5D=Malaysian&filter%5Biso%5D=MY&per_page=15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "name": "Malaysia",
            "nationality": "Malaysian",
            "iso": "MY",
            "iso3": "MYS"
        }
    ],
    "links": {
        "first": "{{$baseUrl}}/api/countries?page=1",
        "last": "{{$baseUrl}}/api/countries?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "{{$baseUrl}}/api/countries?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "{{$baseUrl}}/api/countries",
        "per_page": 15,
        "to": 1,
        "total": 1
    }
}

List all states

GET

https://explore.pixalink.io.test

/api/states

requires authentication

Get a list of all states with their associated countries.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

filter[name]

string

Filter states by name.

Example:

Selangor

filter[country_id]

integer

Filter states by country ID.

Example:

include

string

Include related models (Possible values: country).

Example:

country

per_page

integer

Number of records to display per page.

Example:

Response Fields

integer

The ID of the state

name

string

The name of the state

country

object

The country this state belongs to

integer

The ID of the country

name

string

The name of the country

nationality

string

The nationality of the country's citizens

iso

string

The 2-letter ISO code

iso3

string

The 3-letter ISO code

phone_code

string

The country's calling code

country_id

integer

The ID of the country this state belongs to.

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/states?filter%5Bname%5D=Selangor&filter%5Bcountry_id%5D=1&include=country&per_page=15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "name": "Selangor",
            "country": {
                "id": 1,
                "name": "Malaysia",
                "nationality": "Malaysian",
                "iso": "MY",
                "iso3": "MYS",
                "phone_code": "60"
            }
        }
    ],
    "links": {
        "first": "{{$baseUrl}}/api/states?page=1",
        "last": "{{$baseUrl}}/api/states?page=5",
        "prev": null,
        "next": "{{$baseUrl}}/api/states?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 5,
        "path": "{{$baseUrl}}/api/states",
        "per_page": 15,
        "to": 15,
        "total": 75
    }
}

List all cities

GET

https://explore.pixalink.io.test

/api/cities

requires authentication

Get a list of all cities with their associated states.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

filter[name]

string

Filter cities by name.

Example:

Petaling Jaya

filter[state_id]

integer

Filter cities by state ID.

Example:

include

string

Include related models (Possible values: state, state.country).

Example:

state,state.country

sort

string

Sort by specified field. Prefix with - for descending sort. Possible values: name

Example:

-name

per_page

integer

Number of records to display per page.

Example:

Response Fields

integer

The ID of the city

name

string

The name of the city

state

object

The state this city belongs to

state_id

integer

The ID of the state this city belongs to.

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://explore.pixalink.io.test/api/cities?filter%5Bname%5D=Petaling+Jaya&filter%5Bstate_id%5D=1&include=state%2Cstate.country&sort=-name&per_page=15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 1,
            "name": "Petaling Jaya",
            "state": {
                "id": 1,
                "name": "Selangor",
                "country": {
                    "id": 1,
                    "name": "Malaysia",
                    "nationality": "Malaysian",
                    "iso": "MY",
                    "iso3": "MYS",
                    "phone_code": "60"
                }
            }
        }
    ],
    "links": {
        "first": "{{$baseUrl}}/api/cities?page=1",
        "last": "{{$baseUrl}}/api/cities?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "{{$baseUrl}}/api/cities?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "{{$baseUrl}}/api/cities",
        "per_page": 15,
        "to": 1,
        "total": 1
    }
}

SSO

Generate a signed SSO login URL for a customer.

POST

https://explore.pixalink.io.test

/api/sso/redirect

requires authentication

Verifies the HMAC-signed request, finds or creates the customer by phone number, then returns a temporary signed URL that logs the customer into the loyalty portal. The signed URL is valid for 10 minutes.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

customer_phone

string

required

Phone number of the customer in E.164 format. Must match the regex /^+[1-9]\d{7,14}$/.

Example:

+60123456789

space_id

integer

required

ID of the Pixalink space. Must belong to your organisation. The id of an existing record in the spaces table.

Example:

timestamp

integer

required

Current Unix timestamp in seconds. Must be within ±60s of server time.

Example:

1746518400

redirect_to

string

Optional page to land on after login. Defaults to home.

Must be one of:

home
profile
rewards
points
credits
membership
order
reservations
referral

Example:

rewards

Response Fields

redirect_url

string

Temporary signed URL that logs the customer into the loyalty portal.

Auth

Bearer

Headers

Body

{ "customer_phone": "+60123456789", "space_id": 42, "timestamp": 1746518400, "redirect_to": "rewards" }

Received response

Example request:

curl --request POST \
    "https://explore.pixalink.io.test/api/sso/redirect" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"customer_phone\": \"+60123456789\",
    \"space_id\": 42,
    \"timestamp\": 1746518400,
    \"redirect_to\": \"rewards\"
}"

Example response:

{
    "redirect_url": "https://explore.pixalink.io/space/1/loyalty/login/42?expires=1746518400&signature=abc123..."
}

Resolve an outbound SSO ticket.

POST

https://explore.pixalink.io.test

/api/sso/resolve

requires authentication

Verifies the HMAC-signed request, then exchanges a single-use ticket for the customer identity it was minted against. The ticket is consumed on first use, so a second call with the same ticket returns 410. Only the organisation that owns the ticket may resolve it.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

ticket

string

required

The opaque ticket received on the redirect URL.

Example:

kP3x…opaque…9Qz

timestamp

integer

required

Current Unix timestamp in seconds. Must be within ±60s of server time.

Example:

1746518400

Response Fields

customer

object

The resolved customer identity.

context

object

Any context stored when the ticket was minted (e.g. an outlet or table reference).

Auth

Bearer

Headers

Body

{ "ticket": "kP3x\u2026opaque\u20269Qz", "timestamp": 1746518400 }

Received response

Example request:

curl --request POST \
    "https://explore.pixalink.io.test/api/sso/resolve" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ticket\": \"kP3x…opaque…9Qz\",
    \"timestamp\": 1746518400
}"

Example response:

{
    "customer": {
        "id": 42,
        "name": "Jane Doe",
        "phone_number": "+60123456789",
        "email": "jane@example.com",
        "space_id": 1,
        "organisation_id": 7
    },
    "context": {}
}

Pixalink Documentation

Pixalink Documentation

Introduction

Authenticating requests

Categories

List categories

Headers

Query Parameters

Response Fields

Credits

List Credits

Headers

Query Parameters

Response Fields

Create Credit

Headers

Body Parameters

Response Fields

Get Credit Details

Headers

URL Parameters

Query Parameters

Response Fields

Customer Paid Memberships

List Customer Paid Memberships

Headers

Query Parameters

Response Fields

Assign a Paid Membership

Headers

Body Parameters

Response Fields

Show Customer Paid Membership

Headers

URL Parameters

Query Parameters

Response Fields

Update Customer Paid Membership

Headers

URL Parameters

Body Parameters

Response Fields

Cancel Customer Paid Membership

Headers

URL Parameters

Customer Rewards

List Customer Rewards

Headers

Query Parameters

Response Fields

Create Customer Reward

Headers

Body Parameters

Response Fields

Get Customer Reward Details

Headers

URL Parameters

Query Parameters

Response Fields

Update Customer Reward

Headers

URL Parameters

Body Parameters

Response Fields

Delete Customer Reward

Headers

URL Parameters

Customers

List Customers

Headers

Query Parameters

Response Fields

Create Customer

Headers

Body Parameters

Response Fields

Show Customer Details

Headers

URL Parameters

Query Parameters