Catalog API

You can get catalog data from your Limio app via our Catalog REST API.

See below for full documentation: Limio Catalog REST API Documentation

Get Campaigns

Retrieves all the campaigns in the Catalog matching the specified queries. It will retrieve an object containing a number for the amount of hits that responded to the query, an array with the details of these campaigns (limited to the pageSize property, default to 50) and a queryMore object for continuing query if the amount of hits exceeded the retrieved campaigns and pagination is activated.

GEThttps://your-environment.prod.limio.com/api/campaigns

Authorization

ApiKey

Query parameters

Response

200401

OK

Body

application/json

hitsnumber

Amount of records found on the catalog responding the query

Example: 1

headerobject

header with information about the requested data

itemsarray of ElasticCampaign (object)

Campaigns retrieved

queryMorequeryMore (object)

query more object used for pagination

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://your-environment.prod.limio.com/api/campaigns', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "hits": 1,
  "header": {
    "commitId": "e44d0795e9d0aa78ddea15c3e925cfd581adfb04"
  },
  "items": [
    {
      "id": "d89c80cd3919a193da90c6a141b0040b3663a8d0.97d170e1550eee4afc0af065b78cda302a97674c",
      "parent_path": "/offers",
      "path": "/offers/2019 Winter Campaign",
      "name": "2019 Winter Campaign",
      "data": {
        "description": "A campaign for new Limio customers",
        "headline": "Look at the Limio offers below!",
        "subline": "They are great!",
        "assets": [
          {
            "id": "d89c80cd3919a193da90c6a141b0040b3663a8d0.97d170e1550eee4afc0af065b78cda302a97674c",
            "name": "MyImage",
            "parent_path": "/assets/image",
            "path": "/assets/image/MyImage",
            "data": {
              "baseTemplate": "/config/templates/assets",
              "key": "1e1f1dd8-7609-4bb5-8ec0-7e0ec83abadd.png"
            }
          }
        ],
        "tags": [
          "/tags/test"
        ],
        "status": "draft",
        "validFrom": "20190226",
        "validTo": "20190305",
        "associatedOffers": [
          {
            "type": "cross-sell",
            "offer": {
              "id": "d89c80cd3919a193da90c6a141b0040b3663a8d0.97d170e1550eee4afc0af065b78cda302a97674c",
              "name": "Limio Regular Subscription",
              "parent_path": "/offers/2019 Winter Campaign",
              "path": "/offers/2019 Winter Campaign/Limio Regular Subscription",
              "data": {
                "price": [
                  {
                    "name": "charge_1",
                    "label": "Charge 1",
                    "currencyCode": "GBP",
                    "value": "75",
                    "type": "onetime",
                    "trigger": "subscription_start",
                    "repeat_interval": 1,
                    "repeat_interval_type": "months",
                    "repeat_count": 12,
                    "delay_trigger": "text",
                    "delay_interval": 1,
                    "delay_interval_type": "months"
                  }
                ],
                "products": [
                  {
                    "id": "d89c80cd3919a193da90c6a141b0040b3663a8d0.97d170e1550eee4afc0af065b78cda302a97674c",
                    "name": "Entertainment Pass",
                    "parent_path": "/products/Streaming",
                    "path": "/products/Streaming/Entertainment Pass",
                    "data": {
                      "baseTemplate": "/config/templates/products"
                    }
                  }
                ],
                "segments": [
                  "/segments/regions/UK/UK/GB"
                ],
                "tags": [
                  "/tags/test"
                ],
                "status": "approved",
                "description": "A starter offer which gives access to all Limio content",
                "validFrom": "20190226",
                "validTo": "20190305"
              }
            }
          }
        ]
      }
    }
  ],
  "queryMore": {
    "from": "DnF1ZXJ5VGhlbkZldGNoBQAAAAAAGH_TFnZndVVMaWN4VFZDbnVIbGpRRDFaaUEAAAAAABh_1BZ2Z3VVTGljeFRWQ251 SGxqUUQxWmlBAAAAAAAYf9YWdmd1VUxpY3hUVkNudUhsalFEMVppQQAAAAAAGH_XFnZndVVMaWN4VFZDbnVIbGpRRDFa aUEAAAAAABh_1RZ2Z3VVTGljeFRWQ251SGxqUUQxWmlB",
    "alias": "catalog_test.test0.dev.limio.com"
  }
}

Get Offers

Retrieves all the offers in the Catalog matching the specified queries. It will retrieve an object containing a number for the amount of hits that responded to the query, an array with the details of these offers (limited to the pageSize property, default to 50) and a queryMore object for continuing query if the amount of hits exceeded the retrieved offers and pagination is activated.

Note: this API will return all offers in the catalog, including legacy offers (that contain the path /offers AKA campaigns), and standalone offers (that contain the path /offers2). If you want to retrieve only V2 offers, please use the getOffersV2 endpoint.

GEThttps://your-environment.prod.limio.com/api/offers

Authorization

ApiKeybearerAuth

Query parameters

Response

200401

OK

Body

application/json

hitsnumber

Amount of records found on the catalog in response to the query

Example: 2

itemsarray

Offers retrieved

ElasticOffer (object)ElasticOfferV2 (object)

queryMorequeryMore (object)

query more object used for pagination

commitIdstring

the commitId from the index used to query

Example: "e44d0795e9d0aa78ddea15c3e925cfd581adfb04"

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://your-environment.prod.limio.com/api/offers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "hits": 2,
  "items": [
    {
      "id": "d89c80cd3919a193da90c6a141b0040b3663a8d0.97d170e1550eee4afc0af065b78cda302a97674c",
      "name": "Regular Subscription",
      "parent_path": "/offers/2019 Winter Campaign",
      "path": "/offers/2019 Winter Campaign/Regular Subscription",
      "data": {
        "attributes": {
          "price": [
            {
              "name": "charge_1",
              "label": "Charge 1",
              "currencyCode": "GBP",
              "value": "75",
              "type": "onetime",
              "trigger": "subscription_start",
              "repeat_interval": 1,
              "repeat_interval_type": "months",
              "repeat_count": 12,
              "delay_trigger": null,
              "delay_interval": 1,
              "delay_interval_type": "months",
              "attributes": {}
            }
          ]
        },
        "products": [
          {
            "id": "prod_abc123",
            "name": "Digital"
          }
        ],
        "segments": [
          "/segments/regions/UK/UK/GB"
        ],
        "tags": [
          "/tags/test"
        ]
      }
    },
    {
      "id": "fab052ce94fbfd0d3663ec0cb9d9773676593684",
      "name": "Digital offer",
      "path": "/offers2/Digital offer",
      "created": "2024-02-08T09:54:10+00:00",
      "modified": "2024-03-08T10:53:37+00:00",
      "version": "101d166f7386bb9f1c76354124a4b51bbe393ccc",
      "version_date": "2024-03-11T15:33:12.072Z",
      "record_type": "offer",
      "duplicatedFrom": "/offers2/Delivery offer",
      "baseTemplate": "/config/templates/offers/default",
      "priceReference": "/offers2/Delivery offer",
      "user": "[e-mail]",
      "data": {
        "attributes": {
          "checkout_description__limio": "<p>Description</p>",
          "display_name__limio": "Delivery Offer",
          "allowed_countries__limio": [
            "GB"
          ],
          "checkout__limio": {
            "checkout_type": "external",
            "external_url": "/checkout"
          },
          "label__limio": [
            "offers"
          ],
          "term__limio": {
            "renewal_type": "TERMED",
            "renewal_trigger": "EXTERNAL"
          },
          "push_to_checkout__limio": true,
          "initial_term__limio": {
            "renewal_type": "TERMED",
            "renewal_trigger": "EXTERNAL"
          }
        },
        "price": [
          {
            "delay_interval_type": "months",
            "delay_interval": null,
            "label": "Charge 1",
            "trigger": "order_date",
            "repeat_count": 1,
            "type": "onetime",
            "name": "charge_1",
            "repeat_interval": 1,
            "attributes": {},
            "repeat_interval_type": "months",
            "value": "1.00",
            "currencyCode": "GBP"
          }
        ],
        "productBundles": [
          {
            "product_path": "/products/Digital",
            "revenue_split": "100",
            "rate_plan": "Canada Annual"
          }
        ],
        "products": [
          {
            "baseTemplate": "/config/templates/products/default",
            "path": "/products/Digital",
            "lastSynced": "2024-03-07T15:03:10.427Z",
            "synced": true,
            "created": "2024-02-01T10:09:30+00:00",
            "syncedFrom": "2c92c0f9778c090d0177aa4f357d043b",
            "modified": "2024-03-07T15:03:10+00:00",
            "attributes": {
              "display_name__limio": "Digital",
              "has_delivery__limio": false,
              "product_code__limio": "LI.DIGITAL"
            },
            "record_type": "product"
          }
        ]
      }
    }
  ],
  "queryMore": {
    "from": "DnF1ZXJ5VGhlbkZldGNoBQAAAAAAGH_TFnZndVVMaWN4VFZDbnVIbGpRRDFaaUEAAAAAABh_1BZ2Z3VVTGljeFRWQ251 SGxqUUQxWmlBAAAAAAAYf9YWdmd1VUxpY3hUVkNudUhsalFEMVppQQAAAAAAGH_XFnZndVVMaWN4VFZDbnVIbGpRRDFa aUEAAAAAABh_1RZ2Z3VVTGljeFRWQ251SGxqUUQxWmlB",
    "alias": "catalog_test.test0.dev.limio.com"
  },
  "commitId": "e44d0795e9d0aa78ddea15c3e925cfd581adfb04"
}

Get Offers V2

Retrieves all the standalone offers in the Catalog matching the specified queries. It will retrieve an object containing a number for the amount of hits that responded to the query, an array with the details of these offers (limited to the pageSize property, default to 50) and a queryMore object for continuing query if the amount of hits exceeded the retrieved offers and pagination is activated.

Note: this API will return only standalone offers (that contain the path /offers2). If you want to retrieve all offers in the catalog, including legacy offers (that contain the path /offers AKA campaigns), please use the getOffers endpoint.

V2 offers are offers that are created using the new offer creation flow. They are standalone offers that are not part of a campaign, but can be attached to campaigns / pages using labels. They are created using the new offer creation flow and are more flexible than legacy offers.

V2 offers can also be versioned - you can find out more about offer versioning at the following resources:

• Published Offers API and Versioned Offers v2
• Set or Update an Offer Version

GEThttps://your-environment.prod.limio.com/api/offers/v2

Authorization

ApiKeybearerAuth

Query parameters

Response

200401

OK

Body

application/json

hitsnumber

Amount of records found on the catalog in response to the query

Example: 1

itemsarray of ElasticOfferV2 (object)

Offers retrieved

queryMorequeryMore (object)

query more object used for pagination

commitIdstring

the commitId from the index used to query

Example: "e44d0795e9d0aa78ddea15c3e925cfd581adfb04"

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://your-environment.prod.limio.com/api/offers/v2', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "hits": 1,
  "items": [
    {
      "id": "fab052ce94fbfd0d3663ec0cb9d977367a593684",
      "name": "Offer Digital",
      "path": "/offers2/Offer Digital",
      "created": "2024-02-08T09:54:10+00:00",
      "modified": "2024-03-08T10:53:37+00:00",
      "version": "101d166f7386bb9f1c7635412424b51bbe393ccc",
      "version_date": "2024-03-11T15:33:12.072Z",
      "record_type": "offer",
      "duplicatedFrom": "/offers2/Offer Delivery",
      "baseTemplate": "/config/templates/offers/default",
      "priceReference": "/offers2/Offer Delivery",
      "user": "[e-mail]",
      "data": {
        "attributes": {
          "checkout_description__limio": "<p>Description</p>",
          "display_name__limio": "Delivery Offer",
          "allowed_countries__limio": [
            "GB"
          ],
          "checkout__limio": {
            "checkout_type": "external",
            "external_url": "/checkout"
          },
          "label__limio": [
            "offers"
          ],
          "term__limio": {
            "renewal_type": "TERMED",
            "renewal_trigger": "EXTERNAL"
          },
          "push_to_checkout__limio": true,
          "initial_term__limio": {
            "renewal_type": "TERMED",
            "renewal_trigger": "EXTERNAL"
          }
        },
        "price": [
          {
            "name": "charge_1",
            "label": "Charge 1",
            "currencyCode": "GBP",
            "value": "1.00",
            "type": "onetime",
            "trigger": "order_date",
            "repeat_interval": 1,
            "repeat_interval_type": "months",
            "repeat_count": 1,
            "delay_interval": null,
            "delay_interval_type": "months"
          }
        ],
        "productBundles": [
          {
            "product_path": "/products/Digital",
            "revenue_split": "100",
            "rate_plan": "Annual"
          }
        ],
        "products": [
          {
            "baseTemplate": "/config/templates/products/default",
            "path": "/products/Digital",
            "lastSynced": "2024-03-07T15:03:10.427Z",
            "synced": true,
            "created": "2024-02-01T10:09:30+00:00",
            "syncedFrom": "2c92c0f9778c090d0177aa4f357d043b",
            "modified": "2024-03-07T15:03:10+00:00",
            "attributes": {
              "display_name__limio": "Digital",
              "has_delivery__limio": false,
              "product_code__limio": "LI.DIGITAL"
            },
            "record_type": "product"
          }
        ]
      }
    }
  ],
  "queryMore": {
    "from": "DnF1ZXJ5VGhlbkZldGNoBQAAAAAAGH_TFnZndVVMaWN4VFZDbnVIbGpRRDFaaUEAAAAAABh_1BZ2Z3VVTGljeFRWQ251 SGxqUUQxWmlBAAAAAAAYf9YWdmd1VUxpY3hUVkNudUhsalFEMVppQQAAAAAAGH_XFnZndVVMaWN4VFZDbnVIbGpRRDFa aUEAAAAAABh_1RZ2Z3VVTGljeFRWQ251SGxqUUQxWmlB",
    "alias": "catalog_test.test0.dev.limio.com"
  },
  "commitId": "e44d0795e9d0aa78ddea15c3e925cfd581adfb04"
}

Get Assets

Retrieves all the assets in the Catalog matching the specified queries. It will retrieve an object containing a number for the amount of hits that responded to the query, an array with the details of these assets (limited to the pageSize property, default to 50) and a queryMore object for continuing query if the amount of hits exceeded the retrieved assets and pagination is activated.

GEThttps://your-environment.prod.limio.com/api/assets

Authorization

ApiKeybearerAuth

Query parameters

Response

200401

OK

Body

application/json

hitsnumber

Amount of records found on the catalog in response to the query

Example: 1

itemsarray of ElasticAsset (object)

Assets retrieved

queryMorequeryMore (object)

query more object used for pagination

commitIdstring

the commitId from the index used to query

Example: "e44d0795e9d0aa78ddea15c3e925cfd581adfb04"

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://your-environment.prod.limio.com/api/assets', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "hits": 1,
  "items": [
    {
      "id": "d89c80cd3919a193da90c6a141b0040b3663a8d0.97d170e1550eee4afc0af065b78cda302a97674c",
      "name": "MyImage",
      "parent_path": "/assets/image",
      "path": "/assets/image/MyImage",
      "data": {
        "baseTemplate": "/config/templates/assets",
        "key": "1e1f1dd8-7609-4bb5-8ec0-7e0ec83abadd.png"
      }
    }
  ],
  "queryMore": {
    "from": "DnF1ZXJ5VGhlbkZldGNoBQAAAAAAGH_TFnZndVVMaWN4VFZDbnVIbGpRRDFaaUEAAAAAABh_1BZ2Z3VVTGljeFRWQ251 SGxqUUQxWmlBAAAAAAAYf9YWdmd1VUxpY3hUVkNudUhsalFEMVppQQAAAAAAGH_XFnZndVVMaWN4VFZDbnVIbGpRRDFa aUEAAAAAABh_1RZ2Z3VVTGljeFRWQ251SGxqUUQxWmlB",
    "alias": "catalog_test.test0.dev.limio.com"
  },
  "commitId": "e44d0795e9d0aa78ddea15c3e925cfd581adfb04"
}

Get Products

Retrieves all the products in the Catalog matching the specified queries. It will retrieve an object containing a number for the amount of hits that responded to the query, an array with the details of these products (limited to the pageSize property, default to 50) and a queryMore object for continuing query if the amount of hits exceeded the retrieved products and pagination is activated.

GEThttps://your-environment.prod.limio.com/api/products

Authorization

ApiKeybearerAuth

Query parameters

Response

200401

OK

Body

application/json

hitsnumber

Amount of records found on the catalog responding the query

Example: 1

itemsarray of ElasticProduct (object)

Products retrieved

queryMorequeryMore (object)

query more object used for pagination

commitIdstring

the commitId from the index used to query

Example: "e44d0795e9d0aa78ddea15c3e925cfd581adfb04"

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://your-environment.prod.limio.com/api/products', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "hits": 1,
  "items": [
    {
      "id": "d89c80cd3919a193da90c6a141b0040b3663a8d0.97d170e1550eee4afc0af065b78cda302a97674c",
      "name": "Entertainment Pass",
      "parent_path": "/products/Streaming",
      "path": "/products/Streaming/Entertainment Pass",
      "data": {
        "baseTemplate": "/config/templates/products"
      }
    }
  ],
  "queryMore": {
    "from": "DnF1ZXJ5VGhlbkZldGNoBQAAAAAAGH_TFnZndVVMaWN4VFZDbnVIbGpRRDFaaUEAAAAAABh_1BZ2Z3VVTGljeFRWQ251 SGxqUUQxWmlBAAAAAAAYf9YWdmd1VUxpY3hUVkNudUhsalFEMVppQQAAAAAAGH_XFnZndVVMaWN4VFZDbnVIbGpRRDFa aUEAAAAAABh_1RZ2Z3VVTGljeFRWQ251SGxqUUQxWmlB",
    "alias": "catalog_test.test0.dev.limio.com"
  },
  "commitId": "e44d0795e9d0aa78ddea15c3e925cfd581adfb04"
}

Get Segments

Retrieves all the segments in the Catalog matching the specified queries. It will retrieve an object containing a number for the amount of hits that responded to the query, an array with the details of these segments (limited to the pageSize property, default to 50) and a queryMore object for continuing query if the amount of hits exceeded the retrieved segments and pagination is activated.

GEThttps://your-environment.prod.limio.com/api/segments

Authorization

ApiKeybearerAuth

Query parameters

Response

200401

OK

Body

application/json

hitsnumber

Amount of records found on the catalog responding the query

Example: 1

itemsarray of ElasticSegment (object)

Segments retrieved

queryMorequeryMore (object)

query more object used for pagination

commitIdstring

the commitId from the index used to query

Example: "e44d0795e9d0aa78ddea15c3e925cfd581adfb04"

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://your-environment.prod.limio.com/api/segments', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "hits": 1,
  "items": [
    {
      "id": "d89c80cd3919a193da90c6a141b0040b3663a8d0.97d170e1550eee4afc0af065b78cda302a97674c",
      "name": "Finance",
      "parent_path": "/segments/Interest",
      "path": "/segments/Interest/Finance",
      "data": {
        "baseTemplate": "/config/templates/segments"
      }
    }
  ],
  "queryMore": {
    "from": "DnF1ZXJ5VGhlbkZldGNoBQAAAAAAGH_TFnZndVVMaWN4VFZDbnVIbGpRRDFaaUEAAAAAABh_1BZ2Z3VVTGljeFRWQ251 SGxqUUQxWmlBAAAAAAAYf9YWdmd1VUxpY3hUVkNudUhsalFEMVppQQAAAAAAGH_XFnZndVVMaWN4VFZDbnVIbGpRRDFa aUEAAAAAABh_1RZ2Z3VVTGljeFRWQ251SGxqUUQxWmlB",
    "alias": "catalog_test.test0.dev.limio.com"
  },
  "commitId": "e44d0795e9d0aa78ddea15c3e925cfd581adfb04"
}

Get Journeys

Retrieves all the journeys in the Catalog

GEThttps://your-environment.prod.limio.com/api/journeys

Authorization

ApiKeybearerAuth

Response

200401

OK

Body

application/json

starting_pointstring

The starting point of the journey

Example: "/cancel-now/"

fallback_tagstring

The fallback tag for the journey

Example: "/cancel/"

journeysarray of object

The list of journeys

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://your-environment.prod.limio.com/api/journeys', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "starting_point": "/cancel-now/",
  "fallback_tag": "/cancel/",
  "journeys": [
    {
      "id": "0dd1b0b0-22b1-400e-8590-301aabd50a69",
      "conditions": [
        {
          "id": "c10cb349-e06a-4a13-bd87-edb40aae77dc",
          "type": "segment",
          "value": "/segments/123abc"
        }
      ],
      "actions": [
        {
          "id": "a9e2204a-8fa0-4d17-83cc-1f6c0838daaf",
          "type": "destination",
          "values": [
            {
              "id": "a5113403-7e7d-4c46-9d08-13d79e9df9d1",
              "tag": "/tags/cancel-discount",
              "split": "100"
            }
          ]
        }
      ]
    }
  ]
}

Bulk Update

This API allows you to perform bulk update operations on Limio catalog items (such as offers, add-ons etc.). This can be useful for updating multiple items at once, for example, when you want to update the price of multiple offers at the same time.

PUThttps://your-environment.prod.limio.com/api/limio/catalogs/1/bulk-update

Authorization

bearerAuth

Body

application/json

diffsarray of object

Response

200401404

OK

Body

application/json

successstring

failedarray

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://your-environment.prod.limio.com/api/limio/catalogs/1/bulk-update', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200401

{
  "success": "text",
  "failed": []
}