List Gift Cards - Plugixa Car Wash for WordPress

List Gift Cards - Plugixa Car Wash

GET /plugixa-carwash/v1/gift-cards

List gift cards, one page at a time, with search, sorting and filters.

Needs Plugixa Car Wash Pro with the Gift cards app on, and the plugixa_carwash_view capability.

Request

GET https://your-site.example/wp-json/plugixa-carwash/v1/gift-cards

Query parameters

Name	Type	Default	Description
`status__in`	`string`		Comma-separated: `published`, `unpublished`.

Plus the list parameters every paged list accepts. search matches the code, the recipient’s name and e-mail, and the purchaser’s name. orderby accepts id, code, initial_value, balance, expires_on, status, created_at. Each filter is a field name and a comparison joined by two underscores: see Filters.

Responses

`200` OK. `data` is one page of gift cards.

{
  "success": true,
  "data": [
    {
      "id": 11,
      "code": "K7PQ2DW3HN9C",
      "initial_value": 50.0,
      "balance": 35.5,
      "currency": "USD",
      "recipient_name": "Mia",
      "recipient_email": "mia@example.com",
      "purchaser_name": "Lucas",
      "message": "Happy birthday!",
      "expires_on": "2027-11-12",
      "status": "published",
      "created_by": 1,
      "modified_by": 1,
      "created_at": "2026-11-10 08:15:00",
      "modified_at": "2026-11-12 09:30:00",
      "deleted_at": null
    }
  ],
  "meta": {
    "total": 12,
    "pages": 1
  }
}

Field	Type	Meaning
`data[].id`	`integer`	The gift card’s id
`data[].code`	`string`	Upper-case letters and digits
`data[].initial_value`	`number`	Its value when issued
`data[].balance`	`number`	What is left on it
`data[].currency`	`string`	It can only pay for bookings in this currency
`data[].expires_on`	`string\|null`	Last day it can be used, `Y-m-d`
`data[].created_at`	`string`	UTC datetime
`data[].modified_at`	`string`	UTC datetime of the last change. Send it back on an update to be warned about a conflicting edit
`data[].deleted_at`	`string\|null`	`null` unless the record is in the trash
`meta.total`	`integer`	Gift Cards matching the search and filters, before paging
`meta.pages`	`integer`	Number of pages at this `per_page`

Errors

Status	Code	When
`400`	`plugixa_carwash_unknown_filter`	A filter names a field this list cannot filter on.
`400`	`plugixa_carwash_unknown_operator`	A comparison that does not work on that field.
`400`	`plugixa_carwash_missing_value`	A filter that needs a value has none.
`400`	`plugixa_carwash_invalid_date`	A date filter value is not a date.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-carwash/v1/gift-cards" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-carwash/v1/gift-cards');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const auth = Buffer.from(`admin:${process.env.WP_APP_PASSWORD}`).toString('base64');
const response = await fetch('https://your-site.example/wp-json/plugixa-carwash/v1/gift-cards', {
  headers: {
    'Authorization': `Basic ${auth}`,
  },
});
const { data, meta } = await response.json();