Catalog

Retrieve published catalog content — campaigns, offers, pages, products, segments, assets, and add-ons. Supports filtering by path, tags, attributes, and pagination.

Get Catalog Items

get

Returns all catalog items, including unpublished working copies. Replaces the individual getAddOns, getOffers, getOffers2, getProducts, getPages, getCampaigns, and getSegments endpoints with a single entry point.

The record_type parameter determines which type of item is returned. All record types are available. For only published (live) items, use the /published_catalog_items endpoint instead.

Authorizations

bearerAuth

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Query parameters

record_typestring · enumRequired

The type of catalog item to retrieve.

Possible values:

idstringOptional

Filter items by Elasticsearch document ID.

pathstringOptional

Filter by the exact catalog path of the item, e.g. /offers/2024 Summer Campaign or /pages/Homepage.

Example: /offers/2024 Summer Campaign

referencedLabelstringOptional

Filter items by referenced label.

reducedDatabooleanOptional

Indicate true to receive a response with less attributes in the offer object (ideal to reduce payloads size)

opt.pageSizeintegerOptional

Number of items per page (default 50, maximum 160). The response size limit is 6 MB, so use smaller page sizes with queryMore pagination when retrieving large datasets. Note: this parameter cannot be used in combination with opt.all=true — once opt.all is set, the page size cannot be increased.

Default: 50Example: 50

opt.modifiedAfterstring · date-timeOptional

Filter items modified after the indicated date or date-time (ISO-date format, i.e '2020-12-01' or '2020-12-01T16:00:00Z')

Example: 2020-12-01T16:00:00Z

opt.allbooleanOptional

Set to true to enable cursor-based pagination. When enabled, the response includes a queryMore object with from and alias fields that can be passed to subsequent requests to retrieve the next page. A maximum of 100 items will be returned per page when active.

Default: false

opt.queryMoreFromstringOptional

The From Hash for the query more functionality. Use it to fetch next page of the query (obtained from queryMore.from in the response)

opt.queryMoreAliasstringOptional

The Alias for the query more functionality. Use it to fetch next page of the query (obtained from queryMore.alias in the response)

attributes.YOUR_ATTRIBUTE_HEREstringOptional

To query with attributes, replace 'YOUR_ATTRIBUTE_HERE' with your attribute. Attributes are defined by your templates.

Example: Due Upon Receipt

Responses

200

OK

application/json

hitsnumberOptional

Total number of matching records in the index.

Example: 3

commitIdstringOptional

The commit ID of the index that was queried.

400

Bad request. Returned when query parameters fail validation, e.g. missing record_type.

401

Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

get/catalog_items

HTTPcURLJavaScriptPython

GET /api/catalog_items?record_type=add_on HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "hits": 3,
  "items": [],
  "queryMore": {
    "from": "text",
    "alias": "text"
  },
  "commitId": "text"
}

Get Published Catalog Items

get

Returns only published (live) catalog items. Only publishable record types (add_on, offers2, discount) are available from this endpoint.

For all catalog items including unpublished working copies, use the /catalog_items endpoint instead.

Authorizations

bearerAuth

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Query parameters

record_typestring · enumRequired

The type of published item to retrieve. Only publishable types are accepted.

Possible values:

idstringOptional

Filter items by Elasticsearch document ID.

pathstringOptional

Filter by the exact catalog path of the item, e.g. /offers/2024 Summer Campaign or /pages/Homepage.

Example: /offers/2024 Summer Campaign

referencedLabelstringOptional

Filter items by referenced label.

reducedDatabooleanOptional

Indicate true to receive a response with less attributes in the offer object (ideal to reduce payloads size)

opt.pageSizeintegerOptional

Number of items per page (default 50, maximum 160). The response size limit is 6 MB, so use smaller page sizes with queryMore pagination when retrieving large datasets. Note: this parameter cannot be used in combination with opt.all=true — once opt.all is set, the page size cannot be increased.

Default: 50Example: 50

opt.modifiedAfterstring · date-timeOptional

Filter items modified after the indicated date or date-time (ISO-date format, i.e '2020-12-01' or '2020-12-01T16:00:00Z')

Example: 2020-12-01T16:00:00Z

opt.allbooleanOptional

Set to true to enable cursor-based pagination. When enabled, the response includes a queryMore object with from and alias fields that can be passed to subsequent requests to retrieve the next page. A maximum of 100 items will be returned per page when active.

Default: false

opt.queryMoreFromstringOptional

The From Hash for the query more functionality. Use it to fetch next page of the query (obtained from queryMore.from in the response)

opt.queryMoreAliasstringOptional

The Alias for the query more functionality. Use it to fetch next page of the query (obtained from queryMore.alias in the response)

attributes.YOUR_ATTRIBUTE_HEREstringOptional

To query with attributes, replace 'YOUR_ATTRIBUTE_HERE' with your attribute. Attributes are defined by your templates.

Example: Due Upon Receipt

Responses

200

OK

application/json

hitsnumberOptional

Total number of matching records in the index.

Example: 3

commitIdstringOptional

The commit ID of the index that was queried.

400

Bad request. Returned when query parameters fail validation, e.g. non-publishable record_type or missing required parameters.

401

Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

get/published_catalog_items

HTTPcURLJavaScriptPython

GET /api/published_catalog_items?record_type=add_on HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "hits": 3,
  "items": [],
  "queryMore": {
    "from": "text",
    "alias": "text"
  },
  "commitId": "text"
}

Get Campaigns

get

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.

Authorizations

ApiKey

AuthorizationstringRequired

Publishable API key for read-only catalog access. Suitable for client-side or public-facing integrations where only catalog data (campaigns, offers, products, pages, segments, assets) is needed.

Generate a key in the Limio dashboard. See Authentication for details.

Query parameters

pathstringOptional

Filter by the exact catalog path of the item, e.g. /offers/2024 Summer Campaign or /pages/Homepage.

Example: /offers/2024 Summer Campaign

tagsstringOptional

Filter items by an associated tag path, e.g. /tags/uk-uk/default.

Example: /tags/uk-uk/default

reducedDatabooleanOptional

Indicate true to receive a response with less attributes in the offer object (ideal to reduce payloads size)

opt.pageSizeintegerOptional

Number of items per page (default 50, maximum 160). The response size limit is 6 MB, so use smaller page sizes with queryMore pagination when retrieving large datasets. Note: this parameter cannot be used in combination with opt.all=true — once opt.all is set, the page size cannot be increased.

Default: 50Example: 50

opt.modifiedAfterstring · date-timeOptional

Filter items modified after the indicated date or date-time (ISO-date format, i.e '2020-12-01' or '2020-12-01T16:00:00Z')

Example: 2020-12-01T16:00:00Z

opt.allbooleanOptional

Set to true to enable cursor-based pagination. When enabled, the response includes a queryMore object with from and alias fields that can be passed to subsequent requests to retrieve the next page. A maximum of 100 items will be returned per page when active.

Default: false

opt.queryMoreFromstringOptional

The From Hash for the query more functionality. Use it to fetch next page of the query (obtained from queryMore.from in the response)

opt.queryMoreAliasstringOptional

The Alias for the query more functionality. Use it to fetch next page of the query (obtained from queryMore.alias in the response)

attributes.YOUR_ATTRIBUTE_HEREstringOptional

To query with attributes, replace 'YOUR_ATTRIBUTE_HERE' with your attribute. Attributes are defined by your templates.

Example: Due Upon Receipt

Responses

200

OK

application/json

hitsnumberOptional

Amount of records found on the catalog responding the query

Example: 1

401

Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

get/campaigns

HTTPcURLJavaScriptPython

GET /api/campaigns HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "hits": 1,
  "header": {
    "commitId": "e44d0795e9d0aa78ddea15c3e925cfd581adfb04"
  },
  "items": [],
  "queryMore": {
    "from": "DnF1ZXJ5VGhlbkZldGNoBQAAAAAAGH_TFnZndVVMaWN4VFZDbnVIbGpRRDFaaUEAAAAAABh_1BZ2Z3VVTGljeFRWQ251 SGxqUUQxWmlBAAAAAAAYf9YWdmd1VUxpY3hUVkNudUhsalFEMVppQQAAAAAAGH_XFnZndVVMaWN4VFZDbnVIbGpRRDFa aUEAAAAAABh_1RZ2Z3VVTGljeFRWQ251SGxqUUQxWmlB",
    "alias": "catalog_test.test0.dev.limio.com"
  }
}

Get Pages

get

Retrieves published pages that match the supplied query parameters. The response includes metadata about the total matches, paging details, and the matching page definitions.

Authorizations

ApiKey

AuthorizationstringRequired

Publishable API key for read-only catalog access. Suitable for client-side or public-facing integrations where only catalog data (campaigns, offers, products, pages, segments, assets) is needed.

Generate a key in the Limio dashboard. See Authentication for details.

Query parameters

pathstringOptional

Filter by the exact catalog path of the item, e.g. /offers/2024 Summer Campaign or /pages/Homepage.

Example: /offers/2024 Summer Campaign

tagsstringOptional

Filter items by an associated tag path, e.g. /tags/uk-uk/default.

Example: /tags/uk-uk/default

opt.pageSizeintegerOptional

Number of items per page (default 50, maximum 160). The response size limit is 6 MB, so use smaller page sizes with queryMore pagination when retrieving large datasets. Note: this parameter cannot be used in combination with opt.all=true — once opt.all is set, the page size cannot be increased.

Default: 50Example: 50

opt.modifiedAfterstring · date-timeOptional

Filter items modified after the indicated date or date-time (ISO-date format, i.e '2020-12-01' or '2020-12-01T16:00:00Z')

Example: 2020-12-01T16:00:00Z

opt.allbooleanOptional

Set to true to enable cursor-based pagination. When enabled, the response includes a queryMore object with from and alias fields that can be passed to subsequent requests to retrieve the next page. A maximum of 100 items will be returned per page when active.

Default: false

opt.queryMoreFromstringOptional

The From Hash for the query more functionality. Use it to fetch next page of the query (obtained from queryMore.from in the response)

opt.queryMoreAliasstringOptional

The Alias for the query more functionality. Use it to fetch next page of the query (obtained from queryMore.alias in the response)

attributes.YOUR_ATTRIBUTE_HEREstringOptional

To query with attributes, replace 'YOUR_ATTRIBUTE_HERE' with your attribute. Attributes are defined by your templates.

Example: Due Upon Receipt

Responses

200

OK

application/json

Paginated list of published pages.

hitsintegerOptional

Total number of pages that matched the query.

Example: 42

commitIdstringOptional

Commit identifier for the source index.

Example: e44d0795e9d0aa78ddea15c3e925cfd581adfb04

buildIdstringOptional

Build identifier of the index queried.

Example: build-20240501010101

indexNamestringOptional

Name of the Elastic index queried.

Example: catalog_example_default

401

Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

get/pages

HTTPcURLJavaScriptPython

GET /api/pages HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "items": [
    {
      "id": "4b4f1a8457f4fb4a9c7c2a8da2c9b8f4a1b2c3d4.Default",
      "parent_path": "/pages",
      "path": "/pages/default",
      "name": "Default Page",
      "type": "page",
      "version": "1.0.0",
      "attributes": {},
      "data": {}
    }
  ],
  "hits": 42,
  "queryMore": {
    "from": "DnF1ZXJ5VGhlbkZldGNoBQAAAAAAABCD",
    "alias": "catalog_example.example.dev.limio.com"
  },
  "commitId": "e44d0795e9d0aa78ddea15c3e925cfd581adfb04",
  "buildId": "build-20240501010101",
  "indexName": "catalog_example_default"
}

Get Offers V2

get

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, a maximum of 160 items will be returned) and a queryMore object for continuing query if the amount of hits exceeded the retrieved offers and pagination is activated.

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

If you have the Published Offers API enabled, the API will, by default, return only the published offersV2. To retrieve all offersV2 in your catalog, including both published and unpublished, you can use the offersSource query parameter.

Authorizations

bearerAuth

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Query parameters

offersSourcestring · enumOptional

Specifies the source for fetching offers. catalog Retrieves all offersV2 from your catalog. published Retrieves only published offers.

Possible values:

pathstringOptional

Filter by the exact catalog path of the item, e.g. /offers/2024 Summer Campaign or /pages/Homepage.

Example: /offers/2024 Summer Campaign

tagsstringOptional

Filter items by an associated tag path, e.g. /tags/uk-uk/default.

Example: /tags/uk-uk/default

reducedDatabooleanOptional

Indicate true to receive a response with less attributes in the offer object (ideal to reduce payloads size)

opt.pageSizeintegerOptional

Number of items per page (default 50, maximum 160). The response size limit is 6 MB, so use smaller page sizes with queryMore pagination when retrieving large datasets. Note: this parameter cannot be used in combination with opt.all=true — once opt.all is set, the page size cannot be increased.

Default: 50Example: 50

opt.modifiedAfterstring · date-timeOptional

Filter items modified after the indicated date or date-time (ISO-date format, i.e '2020-12-01' or '2020-12-01T16:00:00Z')

Example: 2020-12-01T16:00:00Z

opt.allbooleanOptional

Set to true to enable cursor-based pagination. When enabled, the response includes a queryMore object with from and alias fields that can be passed to subsequent requests to retrieve the next page. A maximum of 100 items will be returned per page when active.

Default: false

opt.queryMoreFromstringOptional

The From Hash for the query more functionality. Use it to fetch next page of the query (obtained from queryMore.from in the response)

opt.queryMoreAliasstringOptional

The Alias for the query more functionality. Use it to fetch next page of the query (obtained from queryMore.alias in the response)

attributes.YOUR_ATTRIBUTE_HEREstringOptional

To query with attributes, replace 'YOUR_ATTRIBUTE_HERE' with your attribute. Attributes are defined by your templates.

Example: Due Upon Receipt

Responses

200

OK

application/json

hitsnumberOptional

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

Example: 1

commitIdstringOptional

the commitId from the index used to query

Example: e44d0795e9d0aa78ddea15c3e925cfd581adfb04

401

Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

get/offers/v2

HTTPcURLJavaScriptPython

GET /api/offers/v2 HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "hits": 1,
  "items": [
    {
      "id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2",
      "name": "SaaS Premium Annual",
      "path": "/offers2/SaaS Premium Annual",
      "version": "f6e5d4c3b2a1f6e5d4c3b2a1f6e5d4c3b2a1f6e5",
      "record_type": "offer",
      "data": {
        "name": "SaaS Premium Annual",
        "path": "/offers2/SaaS Premium Annual",
        "attributes": {
          "display_name__limio": "SaaS Premium Annual",
          "price__limio": [
            {
              "name": "charge_1",
              "value": "999",
              "currencyCode": "USD",
              "type": "recurring",
              "trigger": "subscription_start",
              "repeat_interval": 1,
              "repeat_interval_type": "years",
              "repeat_count": 1
            }
          ],
          "label__limio": [
            "saas"
          ],
          "term__limio": {
            "renewal_type": "TERMED",
            "length": 1,
            "type": "years"
          },
          "cross_sell_addons__limio": {
            "item_label": "saas",
            "item_type": "add_on",
            "items": [
              {
                "path": "/add_ons/AI Credit Add-On",
                "id": "b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3"
              }
            ]
          },
          "payment_types__limio": [
            "zuora_card",
            "invoice"
          ],
          "push_to_checkout__limio": true,
          "autoRenew__limio": true
        },
        "products": [
          {
            "path": "/products/SaaS Platform",
            "record_type": "product",
            "attributes": {
              "display_name__limio": "SaaS Platform"
            }
          }
        ],
        "productBundles": [
          {
            "product_path": "/products/SaaS Platform",
            "revenue_split": "100",
            "rate_plan": "Premium Annual"
          }
        ]
      }
    }
  ],
  "commitId": "e44d0795e9d0aa78ddea15c3e925cfd581adfb04"
}

Get Add Ons

get

Retrieves all the standalone add ons 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 add ons (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.

Authorizations

bearerAuth

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Query parameters

pathstringOptional

Filter by the exact catalog path of the item, e.g. /offers/2024 Summer Campaign or /pages/Homepage.

Example: /offers/2024 Summer Campaign

addOnsSourcestring · enumOptional

Specifies the source for fetching Add Ons. catalog Retrieves all add ons from your catalog. published Retrieves only published add ons.

Possible values:

reducedDatabooleanOptional

Indicate true to receive a response with less attributes in the offer object (ideal to reduce payloads size)

opt.pageSizeintegerOptional

Number of items per page (default 50, maximum 160). The response size limit is 6 MB, so use smaller page sizes with queryMore pagination when retrieving large datasets. Note: this parameter cannot be used in combination with opt.all=true — once opt.all is set, the page size cannot be increased.

Default: 50Example: 50

opt.modifiedAfterstring · date-timeOptional

Filter items modified after the indicated date or date-time (ISO-date format, i.e '2020-12-01' or '2020-12-01T16:00:00Z')

Example: 2020-12-01T16:00:00Z

opt.allbooleanOptional

Set to true to enable cursor-based pagination. When enabled, the response includes a queryMore object with from and alias fields that can be passed to subsequent requests to retrieve the next page. A maximum of 100 items will be returned per page when active.

Default: false

opt.queryMoreFromstringOptional

The From Hash for the query more functionality. Use it to fetch next page of the query (obtained from queryMore.from in the response)

opt.queryMoreAliasstringOptional

The Alias for the query more functionality. Use it to fetch next page of the query (obtained from queryMore.alias in the response)

attributes.YOUR_ATTRIBUTE_HEREstringOptional

To query with attributes, replace 'YOUR_ATTRIBUTE_HERE' with your attribute. Attributes are defined by your templates.

Example: Due Upon Receipt

Responses

200

OK

application/json

hitsnumberOptional

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

Example: 1

commitIdstringOptional

the commitId from the index used to query

Example: e44d0795e9d0aa78ddea15c3e925cfd581adfb04

401

Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

get/add_ons

HTTPcURLJavaScriptPython

GET /api/add_ons HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "hits": 1,
  "items": [
    {
      "id": "b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3",
      "name": "AI Credit Add-On",
      "path": "/add_ons/AI Credit Add-On",
      "version": "e5d4c3b2a1f6e5d4c3b2a1f6e5d4c3b2a1f6e5d4",
      "record_type": "add_on",
      "data": {
        "name": "AI Credit Add-On",
        "path": "/add_ons/AI Credit Add-On",
        "attributes": {
          "display_name__limio": "AI Credit Add-On",
          "price__limio": [
            {
              "name": "charge_1",
              "value": "499",
              "currencyCode": "USD",
              "type": "recurring",
              "trigger": "subscription_start",
              "repeat_interval": 1,
              "repeat_interval_type": "years",
              "repeat_count": 1
            }
          ],
          "label__limio": [
            "saas"
          ],
          "term__limio": {
            "renewal_type": "TERMED",
            "length": 1,
            "type": "years"
          }
        },
        "products": [
          {
            "path": "/products/AI Credits",
            "record_type": "product",
            "attributes": {
              "display_name__limio": "AI Credits"
            }
          }
        ],
        "productBundles": [
          {
            "product_path": "/products/AI Credits",
            "revenue_split": "100",
            "rate_plan": "Annual Add-On"
          }
        ]
      }
    }
  ],
  "commitId": "e44d0795e9d0aa78ddea15c3e925cfd581adfb04"
}

Get Assets

get

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.

Authorizations

ApiKeybearerAuth

AuthorizationstringRequired

Publishable API key for read-only catalog access. Suitable for client-side or public-facing integrations where only catalog data (campaigns, offers, products, pages, segments, assets) is needed.

Generate a key in the Limio dashboard. See Authentication for details.

Query parameters

pathstringOptional

Filter by the exact catalog path of the item, e.g. /offers/2024 Summer Campaign or /pages/Homepage.

Example: /offers/2024 Summer Campaign

opt.pageSizeintegerOptional

Number of items per page (default 50, maximum 160). The response size limit is 6 MB, so use smaller page sizes with queryMore pagination when retrieving large datasets. Note: this parameter cannot be used in combination with opt.all=true — once opt.all is set, the page size cannot be increased.

Default: 50Example: 50

opt.modifiedAfterstring · date-timeOptional

Filter items modified after the indicated date or date-time (ISO-date format, i.e '2020-12-01' or '2020-12-01T16:00:00Z')

Example: 2020-12-01T16:00:00Z

opt.allbooleanOptional

Set to true to enable cursor-based pagination. When enabled, the response includes a queryMore object with from and alias fields that can be passed to subsequent requests to retrieve the next page. A maximum of 100 items will be returned per page when active.

Default: false

opt.queryMoreFromstringOptional

The From Hash for the query more functionality. Use it to fetch next page of the query (obtained from queryMore.from in the response)

opt.queryMoreAliasstringOptional

The Alias for the query more functionality. Use it to fetch next page of the query (obtained from queryMore.alias in the response)

attributes.YOUR_ATTRIBUTE_HEREstringOptional

To query with attributes, replace 'YOUR_ATTRIBUTE_HERE' with your attribute. Attributes are defined by your templates.

Example: Due Upon Receipt

Responses

200

OK

application/json

hitsnumberOptional

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

Example: 1

commitIdstringOptional

the commitId from the index used to query

Example: e44d0795e9d0aa78ddea15c3e925cfd581adfb04

401

Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

get/assets

HTTPcURLJavaScriptPython

GET /api/assets HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "hits": 1,
  "items": [
    {
      "id": "d89c80cd3919a193da90c6a141b0040b3663a8d0.97d170e1550eee4afc0af065b78cda302a97674c",
      "name": "MyImage",
      "parent_path": "/assets/image",
      "path": "/assets/image/MyImage",
      "data": {
        "attributes": {},
        "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

get

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.

Authorizations

ApiKeybearerAuth

AuthorizationstringRequired

Publishable API key for read-only catalog access. Suitable for client-side or public-facing integrations where only catalog data (campaigns, offers, products, pages, segments, assets) is needed.

Generate a key in the Limio dashboard. See Authentication for details.

Query parameters

pathstringOptional

Filter by the exact catalog path of the item, e.g. /offers/2024 Summer Campaign or /pages/Homepage.

Example: /offers/2024 Summer Campaign

opt.pageSizeintegerOptional

Number of items per page (default 50, maximum 160). The response size limit is 6 MB, so use smaller page sizes with queryMore pagination when retrieving large datasets. Note: this parameter cannot be used in combination with opt.all=true — once opt.all is set, the page size cannot be increased.

Default: 50Example: 50

opt.modifiedAfterstring · date-timeOptional

Filter items modified after the indicated date or date-time (ISO-date format, i.e '2020-12-01' or '2020-12-01T16:00:00Z')

Example: 2020-12-01T16:00:00Z

opt.allbooleanOptional

Set to true to enable cursor-based pagination. When enabled, the response includes a queryMore object with from and alias fields that can be passed to subsequent requests to retrieve the next page. A maximum of 100 items will be returned per page when active.

Default: false

opt.queryMoreFromstringOptional

The From Hash for the query more functionality. Use it to fetch next page of the query (obtained from queryMore.from in the response)

opt.queryMoreAliasstringOptional

The Alias for the query more functionality. Use it to fetch next page of the query (obtained from queryMore.alias in the response)

attributes.YOUR_ATTRIBUTE_HEREstringOptional

To query with attributes, replace 'YOUR_ATTRIBUTE_HERE' with your attribute. Attributes are defined by your templates.

Example: Due Upon Receipt

Responses

200

OK

application/json

hitsnumberOptional

Amount of records found on the catalog responding the query

Example: 1

commitIdstringOptional

the commitId from the index used to query

Example: e44d0795e9d0aa78ddea15c3e925cfd581adfb04

401

Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

get/products

HTTPcURLJavaScriptPython

GET /api/products HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: YOUR_API_KEY
Accept: */*

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

Get Segments

get

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.

Authorizations

ApiKeybearerAuth

AuthorizationstringRequired

Publishable API key for read-only catalog access. Suitable for client-side or public-facing integrations where only catalog data (campaigns, offers, products, pages, segments, assets) is needed.

Generate a key in the Limio dashboard. See Authentication for details.

Query parameters

pathstringOptional

Filter by the exact catalog path of the item, e.g. /offers/2024 Summer Campaign or /pages/Homepage.

Example: /offers/2024 Summer Campaign

opt.pageSizeintegerOptional

Number of items per page (default 50, maximum 160). The response size limit is 6 MB, so use smaller page sizes with queryMore pagination when retrieving large datasets. Note: this parameter cannot be used in combination with opt.all=true — once opt.all is set, the page size cannot be increased.

Default: 50Example: 50

opt.modifiedAfterstring · date-timeOptional

Filter items modified after the indicated date or date-time (ISO-date format, i.e '2020-12-01' or '2020-12-01T16:00:00Z')

Example: 2020-12-01T16:00:00Z

opt.allbooleanOptional

Set to true to enable cursor-based pagination. When enabled, the response includes a queryMore object with from and alias fields that can be passed to subsequent requests to retrieve the next page. A maximum of 100 items will be returned per page when active.

Default: false

opt.queryMoreFromstringOptional

The From Hash for the query more functionality. Use it to fetch next page of the query (obtained from queryMore.from in the response)

opt.queryMoreAliasstringOptional

The Alias for the query more functionality. Use it to fetch next page of the query (obtained from queryMore.alias in the response)

attributes.YOUR_ATTRIBUTE_HEREstringOptional

To query with attributes, replace 'YOUR_ATTRIBUTE_HERE' with your attribute. Attributes are defined by your templates.

Example: Due Upon Receipt

Responses

200

OK

application/json

hitsnumberOptional

Amount of records found on the catalog responding the query

Example: 1

commitIdstringOptional

the commitId from the index used to query

Example: e44d0795e9d0aa78ddea15c3e925cfd581adfb04

401

Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

get/segments

HTTPcURLJavaScriptPython

GET /api/segments HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: YOUR_API_KEY
Accept: */*

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