Public

Get a published extension

Returns a single extension with status: "public" by id, including its resolved surfaces and owning organization. Publicly accessible — no API key required. Responds 404 if the extension does not exist or is not public.

get/v1/public/published-extension/{extensionId}

Request

  • Base URL: https://api.finalpos.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.finalpos.com/v1/public/published-extension/{extensionId}
  • Auth: none required

Path parameters

extensionIdstring required

Response

The published extension.

_idstring required

Extension id.

labelstring required

Extension display name.

statusstring required

Publication status. Always public for these endpoints.

categorystring required

Extension category.

short_descriptionstring required

Short marketing description.

long_descriptionstring required

Long marketing description.

urlstring

Hosted iframe URL of the extension, if deployed.

descriptionstring

General/legacy description.

pricestring

Price label.

websitestring

Marketing website URL.

main_imagestring

Main listing image URL.

backgroundUrlstring

Background image URL.

gallerystring[]

Gallery image URLs.

themestring

Theme identifier.

redirectUrlstring

Post-install redirect URL.

organizationIdstring

Owning organization id (reference to companies).

createdAtstring required

Creation timestamp (ISO 8601).

updatedAtstring required

Last-update timestamp (ISO 8601).

Example response

{
  "_id": "6a148346ffb97bbf5a57700e",
  "label": "Product Groups",
  "status": "public",
  "category": "hub",
  "short_description": "Group products into named collections for quick POS filtering.",
  "long_description": "Product Groups lets admins create named groups of products from the dashboard...",
  "url": "https://product-groups-163feb.host.staging.code.finalpos.com",
  "price": "free",
  "gallery": [],
  "organizationId": "691df9c2047bfc55994d703c",
  "organization": {
    "_id": "691df9c2047bfc55994d703c",
    "name": "TestStaging",
    "organization_alias": "oz-12"
  },
  "createdAt": "2026-05-25T17:13:42.066Z",
  "updatedAt": "2026-05-25T17:13:42.066Z",
  "surfaces": [
    {
      "_id": "6a15d8cb5853f27495abdb74",
      "organizationId": "68a72892bc0a1b7cff31531a",
      "name": "Age gate",
      "surfaceId": "age-gate-unique",
      "platform": "hub",
      "type": "merchant-hub-widget",
      "url": "https://www.parkautomotorsports.ca/",
      "icon": "grid-icon",
      "buttonLabel": "Verify Age",
      "hubResource": "products",
      "createdAt": "2026-05-26T17:30:51.420Z",
      "updatedAt": "2026-05-26T17:30:51.420Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.