Contents
On this page

Get Map - Plugixa Image Map

GET /plugixa-image-map/v1/maps/{id}

Read one map with its whole document.

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/12

Path parameters

Name Type Description
id integer The map’s id

Responses

200 OK. data is the map.

{
  "success": true,
  "data": {
    "id": 12,
    "uid": "9b2f6c1e-4d7a-4f3b-9a51-2c8e7d0f6a13",
    "title": "Ground floor",
    "status": "published",
    "image_id": 58,
    "doc": {
      "schema": 1,
      "image": {
        "attachment_id": 58,
        "width": 1600,
        "height": 1000,
        "alt": "Ground floor plan"
      },
      "settings": {
        "general": {
          "responsive": true
        },
        "tooltips": {
          "enabled": true,
          "trigger": "hover",
          "sticky": false,
          "constrain": true,
          "animation": "fade"
        },
        "effects": {
          "pageload": "none"
        },
        "zoom": {
          "enabled": false,
          "max": 4.0,
          "buttons": true,
          "wheel": "ctrl",
          "fullscreen": false
        },
        "list": {
          "enabled": false,
          "position": "right",
          "search": true,
          "title": ""
        }
      },
      "objects": [
        {
          "id": "o_3f9a1c2e",
          "type": "spot",
          "name": "Reception",
          "geometry": {
            "x": 42.5,
            "y": 61.25,
            "w": 3.0
          },
          "style": {
            "default": {
              "fill": "#1976d2",
              "fill_opacity": 0.4,
              "stroke": "#ffffff",
              "stroke_opacity": 1.0,
              "stroke_width": 0.0,
              "radius": 4.0,
              "opacity": 1.0,
              "icon": "pin",
              "icon_color": "#ffffff",
              "shadow": false
            },
            "hover": []
          },
          "action": {
            "type": "none",
            "new_tab": false,
            "url": "",
            "event": ""
          },
          "tooltip": {
            "enabled": true,
            "position": "auto",
            "width": 260,
            "offset_x": 0.0,
            "offset_y": 0.0,
            "content": "<p>Reception desk, open 8:00 to 18:00.</p>"
          },
          "a11y": {
            "label": "Reception",
            "description": ""
          },
          "visible": true,
          "locked": false,
          "group": "",
          "ext": []
        }
      ],
      "groups": [],
      "ext": []
    },
    "doc_version": 1,
    "trusted_html": true,
    "object_count": 1,
    "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,
    "doc_error": false,
    "image_url": "https://your-site.example/wp-content/uploads/2026/11/ground-floor.png",
    "shortcode": "[plugixa_image_map id=\"12\"]",
    "thumbnail_url": "https://your-site.example/wp-content/uploads/2026/11/ground-floor-150x150.png"
  }
}
Field Type Meaning
data.id integer The map’s id
data.uid string A stable identity that survives export and import; the numeric id does not
data.title string The title, at most 255 characters
data.status string draft or published
data.image_id integer The Media Library attachment the map is drawn on, 0 for none
data.doc object The map document: picture, settings, hotspots and groups. See The map document
data.doc_version integer The document format, 1 in this version
data.trusted_html boolean Whether the last person to save could post unfiltered HTML, which decides how tooltips were cleaned
data.object_count integer Number of hotspots
data.rev integer The version number, up by one on every save. Send it back with an update
data.created_at string UTC datetime
data.modified_at string UTC datetime of the last save
data.deleted_at string|null null unless the map is in the trash
data.doc_error boolean true when the stored document could not be read and an empty map is shown in its place
data.image_url string|null Full-size URL of the picture
data.shortcode string The shortcode that embeds the map
data.thumbnail_url string|null Thumbnail URL of the picture

A document saved by an older version is brought up to the current format and any key added since is filled with its default. The stored copy is not rewritten until the map is saved again.

Errors

Status Code When
404 plugixa_image_map_not_found No map with that id, or the map is in the trash.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-image-map/v1/maps/12" \
  -u "admin:$WP_APP_PASSWORD"

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

Quick Links

Share