Get Catalog Items

APIs related to retrieving Limio Catalog Items

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.

SecurityApiKey

Request

query Parameters

path	string Exact path to the object
tags	string To filter by associated tag to the object
reducedData	boolean Indicate true to receive a response with less attributes in the offer object (ideal to reduce payloads size)
opt.pageSize	number Set the page size for the array response (default is 50 records). Bear in mind that response size limit is 6Mb so if you need to retrieve lots of data is probably best practice to use the queryMore functionality
opt.modifiedAfter	string <date-time> 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: opt.modifiedAfter=2020-12-01T16:00:00Z
opt.all	boolean Indicate true to activate the pagination
opt.queryMoreFrom	string 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.queryMoreAlias	string 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_HERE	string To query with attributes, replace 'YOUR_ATTRIBUTE_HERE' with your attribute. Attributes are defined by your templates. Example: attributes.YOUR_ATTRIBUTE_HERE=Due Upon Receipt

Responses

200

401

Unauthorized

get/campaigns

Request samples

curl
JavaScript
Python

Response samples

application/json

{"hits": 1,
"header": {"commitId": "e44d0795e9d0aa78ddea15c3e925cfd581adfb04"
},
"items": [{"id": "d89c80cd3919a193da90c6a141b0040b3663a8d0.97d170e1550eee4afc0af065b78cda302a97674c",
"parent_path": "/offers",
"path": "/offers/2019 Winter Campaign",
"attributes": { },
"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": {"attributes": { },
"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": {"attributes": { },
"price": [ ],
"products": [ ],
"segments": [ ],
"tags": [ ],
"status": null,
"description": null,
"validFrom": null,
"validTo": null
}
}
}
]
}
}
],
"queryMore": {"from": "DnF1ZXJ5VGhlbkZldGNoBQAAAAAAGH_TFnZndVVMaWN4VFZDbnVIbGpRRDFaaUEAAAAAABh_1BZ2Z3VVTGljeFRWQ251 SGxqUUQxWmlBAAAAAAAYf9YWdmd1VUxpY3hUVkNudUhsalFEMVppQQAAAAAAGH_XFnZndVVMaWN4VFZDbnVIbGpRRDFa aUEAAAAAABh_1RZ2Z3VVTGljeFRWQ251SGxqUUQxWmlB",
"alias": "catalog_test.test0.dev.limio.com"
}
}

Get Pages

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

SecurityApiKey

Request

query Parameters

path	string Exact path to the object
tags	string To filter by associated tag to the object
opt.pageSize	number Set the page size for the array response (default is 50 records). Bear in mind that response size limit is 6Mb so if you need to retrieve lots of data is probably best practice to use the queryMore functionality
opt.modifiedAfter	string <date-time> 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: opt.modifiedAfter=2020-12-01T16:00:00Z
opt.all	boolean Indicate true to activate the pagination
opt.queryMoreFrom	string 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.queryMoreAlias	string 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_HERE	string To query with attributes, replace 'YOUR_ATTRIBUTE_HERE' with your attribute. Attributes are defined by your templates. Example: attributes.YOUR_ATTRIBUTE_HERE=Due Upon Receipt

Responses

200

401

Unauthorized

get/pages

Request samples

curl
JavaScript
Python

Response samples

application/json

{"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

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.

SecurityApiKey or bearerAuth

Request

query Parameters

path	string Exact path to the object
tags	string To filter by associated tag to the object
reducedData	boolean Indicate true to receive a response with less attributes in the offer object (ideal to reduce payloads size)
opt.pageSize	number Set the page size for the array response (default is 50 records). Bear in mind that response size limit is 6Mb so if you need to retrieve lots of data is probably best practice to use the queryMore functionality
opt.modifiedAfter	string <date-time> 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: opt.modifiedAfter=2020-12-01T16:00:00Z
opt.all	boolean Indicate true to activate the pagination
opt.queryMoreFrom	string 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.queryMoreAlias	string 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_HERE	string To query with attributes, replace 'YOUR_ATTRIBUTE_HERE' with your attribute. Attributes are defined by your templates. Example: attributes.YOUR_ATTRIBUTE_HERE=Due Upon Receipt

Responses

200

401

Unauthorized

get/offers

Request samples

curl
JavaScript
Python

Response samples

application/json

{"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": "user@limio.com",
"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:

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.

SecuritybearerAuth

Request

query Parameters

offersSource	string Specifies the source for fetching offers. `catalog` Retrieves all offersV2 from your catalog. `published` Retrieves only published offers. Enum: "catalog" "published"
path	string Exact path to the object
tags	string To filter by associated tag to the object
reducedData	boolean Indicate true to receive a response with less attributes in the offer object (ideal to reduce payloads size)
opt.pageSize	number Set the page size for the array response (default is 50 records). Bear in mind that response size limit is 6Mb so if you need to retrieve lots of data is probably best practice to use the queryMore functionality
opt.modifiedAfter	string <date-time> 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: opt.modifiedAfter=2020-12-01T16:00:00Z
opt.all	boolean Indicate true to activate the pagination
opt.queryMoreFrom	string 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.queryMoreAlias	string 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_HERE	string To query with attributes, replace 'YOUR_ATTRIBUTE_HERE' with your attribute. Attributes are defined by your templates. Example: attributes.YOUR_ATTRIBUTE_HERE=Due Upon Receipt

Responses

200

401

Unauthorized

get/offers/v2

Request samples

curl
JavaScript
Python

Response samples

application/json

{"hits": 1,
"items": [{"id": "fab052ce94fbfd0d3663ec0cb9d977367a593684",
"name": "SaaS Basic Plan",
"path": "/offers2/SaaS Basic Plan",
"created": "2025-01-10T09:00:00+00:00",
"modified": "2025-03-10T10:00:00+00:00",
"version": "3f5a2a4b9de911c8f73e876d2c44a2f7f739acb2",
"version_date": "2025-03-11T15:33:12.072Z",
"record_type": "offer",
"duplicatedFrom": "/offers2/SaaS Starter Plan",
"baseTemplate": "/config/templates/offers/default",
"priceReference": "/offers2/SaaS Basic Plan",
"user": "user@domain.com",
"data": {"attributes": {"display_name__limio": "SaaS Basic Plan",
"checkout_description__limio": "<p>Annual subscription to the Basic SaaS tier</p>",
"allowed_countries__limio": ["US",
"GB",
"CA"
],
"checkout__limio": {"checkout_type": "external",
"external_url": "/checkout"
},
"allow_multibuy__limio": true,
"label__limio": ["saas",
"annual",
"basic"
],
"term__limio": {"renewal_type": "TERMED",
"renewal_trigger": "AUTO"
},
"push_to_checkout__limio": true,
"initial_term__limio": {"renewal_type": "TERMED",
"renewal_trigger": "AUTO"
},
"cross_sell_addons__limio": {"items": [{"id": null,
"path": null
}
],
"item_label": "basic_addons",
"item_type": "add_on"
},
"upsell_offers__limio": {"items": [{"id": null,
"path": null
}
],
"item_label": "upsell_saas",
"item_type": "offer"
},
"cross_sell_offers__limio": {"items": [{"id": null,
"path": null
}
],
"item_label": "saas_cross",
"item_type": "offer"
},
"upsell_display_name__limio": "<p><strong>Pro Plan</strong></p>",
"upsell_display_description__limio": "<p>$1,499 / year</p>",
"cross_sell_display_description__limio": "<p>Add SMS Texting, Email Campaigns or AI Usage</p>",
"cross_sell_display_name__limio": "<p>Enhance your plan with add-ons</p>"
},
"price": [{"name": "charge_1",
"label": "Charge 1",
"value": "999.00",
"currencyCode": "USD",
"type": "recurring",
"trigger": "subscription_start",
"repeat_interval": 1,
"repeat_interval_type": "years",
"repeat_count": 1,
"delay_interval": 1,
"attributes": [ ],
"delay_interval_type": "years",
"subscription_start_day": "asap"
}
],
"productBundles": [{"product_path": "/products/SaaS",
"revenue_split": "100",
"rate_plan": "Annual"
}
],
"products": [{"baseTemplate": "/config/templates/products/default",
"path": "/products/SaaS",
"lastSynced": "2025-03-10T15:03:10.427Z",
"synced": true,
"created": "2025-01-01T10:09:30+00:00",
"syncedFrom": "2c92c0f9778c090d0177aa4f357d043b",
"modified": "2025-03-10T15:03:10+00:00",
"attributes": {"display_name__limio": "SaaS Product",
"has_delivery__limio": false,
"product_code__limio": "SAAS.BASIC"
},
"record_type": "product"
}
]
}
}
],
"queryMore": {"from": "DnF1ZXJ5VGhlbkZldGNoBQAAAAAAGH_TFnZndVVMaWN4VFZDbnVIbGpRRDFaaUEAAAAAABh_1BZ2Z3VVTGljeFRWQ251 SGxqUUQxWmlBAAAAAAAYf9YWdmd1VUxpY3hUVkNudUhsalFEMVppQQAAAAAAGH_XFnZndVVMaWN4VFZDbnVIbGpRRDFa aUEAAAAAABh_1RZ2Z3VVTGljeFRWQ251SGxqUUQxWmlB",
"alias": "catalog_test.test0.dev.limio.com"
},
"commitId": "e44d0795e9d0aa78ddea15c3e925cfd581adfb04"
}

Get Add Ons

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.

SecuritybearerAuth

Request

query Parameters

path	string Exact path to the object
addOnsSource	string Specifies the source for fetching Add Ons. `catalog` Retrieves all add ons from your catalog. `published` Retrieves only published add ons. Enum: "catalog" "published"
reducedData	boolean Indicate true to receive a response with less attributes in the offer object (ideal to reduce payloads size)
opt.pageSize	number Set the page size for the array response (default is 50 records). Bear in mind that response size limit is 6Mb so if you need to retrieve lots of data is probably best practice to use the queryMore functionality
opt.modifiedAfter	string <date-time> 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: opt.modifiedAfter=2020-12-01T16:00:00Z
opt.all	boolean Indicate true to activate the pagination
opt.queryMoreFrom	string 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.queryMoreAlias	string 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_HERE	string To query with attributes, replace 'YOUR_ATTRIBUTE_HERE' with your attribute. Attributes are defined by your templates. Example: attributes.YOUR_ATTRIBUTE_HERE=Due Upon Receipt

Responses

200

401

Unauthorized

get/add_ons

Request samples

curl
JavaScript
Python

Response samples

application/json

{"hits": 1,
"items": [{"id": "fab052ce94fbfd0d3663ec0cb9d977367a593684",
"name": "Add On Digital",
"path": "/add_ons/Add On 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": "add_on",
"duplicatedFrom": "/add_ons/Add On Digital",
"baseTemplate": "/config/templates/add_ons/default",
"user": "user@domain.com",
"data": {"attributes": {"display_name__limio": "Delivery Add On",
"label__limio": ["Add Ons"
]
},
"price": [{"attributes": { },
"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": 1,
"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.

SecurityApiKey or bearerAuth

Request

query Parameters

path	string Exact path to the object
opt.pageSize	number Set the page size for the array response (default is 50 records). Bear in mind that response size limit is 6Mb so if you need to retrieve lots of data is probably best practice to use the queryMore functionality
opt.modifiedAfter	string <date-time> 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: opt.modifiedAfter=2020-12-01T16:00:00Z
opt.all	boolean Indicate true to activate the pagination
opt.queryMoreFrom	string 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.queryMoreAlias	string 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_HERE	string To query with attributes, replace 'YOUR_ATTRIBUTE_HERE' with your attribute. Attributes are defined by your templates. Example: attributes.YOUR_ATTRIBUTE_HERE=Due Upon Receipt

Responses

200

401

Unauthorized

get/assets

Request samples

curl
JavaScript
Python

Response samples

application/json

{"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

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.

SecurityApiKey or bearerAuth

Request

query Parameters

path	string Exact path to the object
opt.pageSize	number Set the page size for the array response (default is 50 records). Bear in mind that response size limit is 6Mb so if you need to retrieve lots of data is probably best practice to use the queryMore functionality
opt.modifiedAfter	string <date-time> 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: opt.modifiedAfter=2020-12-01T16:00:00Z
opt.all	boolean Indicate true to activate the pagination
opt.queryMoreFrom	string 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.queryMoreAlias	string 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_HERE	string To query with attributes, replace 'YOUR_ATTRIBUTE_HERE' with your attribute. Attributes are defined by your templates. Example: attributes.YOUR_ATTRIBUTE_HERE=Due Upon Receipt

Responses

200

401

Unauthorized

get/products

Request samples

curl
JavaScript
Python

Response samples

application/json

{"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

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.

SecurityApiKey or bearerAuth

Request

query Parameters

path	string Exact path to the object
opt.pageSize	number Set the page size for the array response (default is 50 records). Bear in mind that response size limit is 6Mb so if you need to retrieve lots of data is probably best practice to use the queryMore functionality
opt.modifiedAfter	string <date-time> 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: opt.modifiedAfter=2020-12-01T16:00:00Z
opt.all	boolean Indicate true to activate the pagination
opt.queryMoreFrom	string 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.queryMoreAlias	string 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_HERE	string To query with attributes, replace 'YOUR_ATTRIBUTE_HERE' with your attribute. Attributes are defined by your templates. Example: attributes.YOUR_ATTRIBUTE_HERE=Due Upon Receipt

Responses

200

401

Unauthorized

get/segments

Request samples

curl
JavaScript
Python

Response samples

application/json

{"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"
}

Get Journeys

Retrieves all the journeys in the Catalog

SecurityApiKey or bearerAuth

Responses

200

401

Unauthorized

get/journeys

Request samples

curl
JavaScript
Python

Response samples

application/json

{"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"
}
]
}
]
}
]
}

➔ Next to Update Catalog Items