Skip to content

Get an Organization's Products

Overview

Returns a list of all the products that are contained in an organization. As well as their key values.

Endpoint

GET https://api.salable.app/products

Headers

Header Name Description Required Value
x-api-key Your API key, from the Salable Dashboard ✅ string

Sample Request

https://api.salable.app/products

x-api-key: "Your API Key"

Response

The response is an array of objects.

Element Description Type Notes
uuid The UUID of the Product string
name The name of the product as shown in the Salable dashboard string
description The description of the product, for use in tooltips string
logoUrl Currently not in use. Will return null null
displayName The products display name for use in pricing tables string
organisation The id of your organization string
status Indicates if the product is currently active string ACTIVE or CANCELLED
paid Returns true for a paid plan and false for a free one Boolean
organisationPaymentIntegrationUuid The ID for the specific payment integration linked to the product string
paymentIntegrationProductId ? string
updatedAt Date the product was last updated in ISO 8601 and Coordinated Universal Time (UTC) string The format is: YYYY-MM-DDThh: mm:ss.sssZ

Sample Response

[
    {
        "uuid": "14c4ffd5-1e26-48de-ad0a-61886fcd778d",
        "name": "Product  One",
        "description": "",
        "logoUrl": null,
        "displayName": "Product One's Display Name",
        "organisation": "org_lSQANh7rD68mQ4Zx",
        "status": "ACTIVE",
        "paid": true,
        "organisationPaymentIntegrationUuid": "0f99c2ff-1752-4982-b8cc-04027471e242",
        "paymentIntegrationProductId": null,
        "updatedAt": "2022-07-11T14:04:00.142Z"
    },
    {
        "uuid": "e6d24c05-6ceb-46af-8168-2eea7f35e252",
        "name": "Product Two",
        "description": "nnn",
        "logoUrl": null,
        "displayName": "Product Two's Display Name",
        "organisation": "org_lSQANh7rD68mQ4Zx",
        "status": "ACTIVE",
        "paid": true,
        "organisationPaymentIntegrationUuid":"fe4089eb-974c-42e2-a0d3-dd010f734ec9",
        "paymentIntegrationProductId": "prod_M3YyAFVQ70nPYg",
        "updatedAt": "2022-07-14T13:13:18.261Z"
    }
]