Contents
On this page

List Maps - Plugixa Image Map

GET /plugixa-image-map/v1/maps

List maps one page at a time, with a filter by status and a search by title.

Any signed-in user with the plugixa_image_map_view capability. Administrators have every Plugixa Image Map capability; see Roles and permissions.

Request

GET https://your-site.example/wp-json/plugixa-image-map/v1/maps?status=published&per_page=50

Query parameters

Name Type Default Description
status string draft or published. Any other value is refused with 400 rather than ignored.

Plus the list parameters every paged list accepts. search matches the title. orderby accepts id, title, status, object_count, created_at and modified_at.

Responses

200 OK. data is one page of maps.

{
  "success": true,
  "data": [
    {
      "id": 12,
      "uid": "9b2f6c1e-4d7a-4f3b-9a51-2c8e7d0f6a12",
      "title": "Ground floor",
      "status": "published",
      "image_id": 58,
      "doc_version": 1,
      "object_count": 18,
      "rev": 4,
      "created_by": 1,
      "modified_by": 1,
      "created_at": "2026-11-12 09:30:00",
      "modified_at": "2026-11-12 10:05:00",
      "deleted_at": null,
      "shortcode": "[plugixa_image_map id=\"12\"]",
      "thumbnail_url": "https://your-site.example/wp-content/uploads/2026/11/ground-floor-150x150.png"
    },
    {
      "id": 15,
      "uid": "9b2f6c1e-4d7a-4f3b-9a51-2c8e7d0f6a15",
      "title": "Campus map",
      "status": "published",
      "image_id": 58,
      "doc_version": 1,
      "object_count": 42,
      "rev": 9,
      "created_by": 1,
      "modified_by": 1,
      "created_at": "2026-11-10 14:00:00",
      "modified_at": "2026-11-11 16:20:00",
      "deleted_at": null,
      "shortcode": "[plugixa_image_map id=\"15\"]",
      "thumbnail_url": "https://your-site.example/wp-content/uploads/2026/11/ground-floor-150x150.png"
    }
  ],
  "meta": {
    "total": 2,
    "pages": 1
  }
}
Field Type Meaning
data[].id integer The map’s id
data[].title string The title
data[].status string draft or published
data[].object_count integer Number of hotspots
data[].rev integer The version number
data[].shortcode string The shortcode that embeds the map
data[].thumbnail_url string|null Thumbnail of the picture, null without one
data[].deleted_at string|null Set only in view=trash
meta.total integer Maps matching the filters, before paging
meta.pages integer Number of pages at this per_page

List rows never include the document. Get Map returns it.

Errors

Status Code When
400 plugixa_image_map_invalid_status status is not draft or published.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-image-map/v1/maps?status=published&per_page=50" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$query = http_build_query([
    'status'   => 'published',
    'per_page' => 50,
]);
$ch = curl_init('https://your-site.example/wp-json/plugixa-image-map/v1/maps?' . $query);
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 query = new URLSearchParams({
  status: 'published',
  per_page: '50',
});
const response = await fetch(`https://your-site.example/wp-json/plugixa-image-map/v1/maps?${query}`, {
  headers: {
    'Authorization': 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`),
  },
});
const { data, meta } = await response.json();

Quick Links

Share