List operations

Use the list prompt to retrieve a paginated list of catalogs or published APIs or products, gateways, consumer organizations, and applications within a provider organization.

List resources

This operation executes immediately without requiring user confirmation and returns the requested data directly in the response. Use the limit and offset parameters to control pagination.

Table 1. Parameters
Parameter Type Description Default value
limit integer Maximum number of catalogs to return in the response. Controls pagination by specifying the page size. 100
offset integer Number of catalogs to skip before starting to return results. Used for pagination to navigate through large datasets. 0
You can use following prompts:
Table 2. List resources
Action Prompt Commands
List catalogs 
list catalogs
list catalogs with limit 5
list catalogs with offset 4
list catalogs with limit 5 and offset 5
Note: For prompts such as list catalogs and use the selected catalog to list published products, a table might not appear. To select a catalog, enter the catalog name directly in the chat to select it.
 
/list_catalogs
/list_catalogs limit:5
/list_catalogs offset:4
/list_catalogs limit:5 offset:5
List gateways 
list gateways in catalog
list gateways in catalog with limit 5
list gateways in catalog with offset 4
list gateways in catalog with limit 5 and offset 5
list gateways in catalog CATALOG_NAME and limit 5
list gateways in catalog CATALOG_NAME and limit 5 and offset 3
 
/list_gateways_in_catalog
/list_gateways_in_catalog catalog:CATALOG_NAME
List consumer organizations 
list consumer orgs
list consumer orgs with limit 5
list consumer orgs with offset 4
list consumer orgs with limit 5 and offset 5
list consumer orgs in catalog CATALOG_NAME with limit 5
list consumer orgs in catalog CATALOG_NAME with limit 5 and offset 3
 
/list_consumer_orgs
/list_consumer_orgs limit:5
/list_consumer_orgs offset:4
/list_consumer_orgs limit:5 offset:5
/list_consumer_orgs limit:5 catalog:CATALOG_NAME
/list_consumer_orgs catalog:CATALOG_NAME limit:5 offset:3
List published products 
list published products
list published products with limit 5
list published products with offset 4
list published products with limit 5 and offset 5
list published products in catalog CATALOG_NAME with limit 5
list published products in catalog CATALOG_NAME with limit 5 and offset 3
 
/list_published_products
/list_published_products limit:5
/list_published_products offset:4
/list_published_products limit:5 offset:5
/list_published_products limit:5 catalog:CATALOG_NAME
/list_published_products catalog:CATALOG_NAME limit:5 offset:3
List published APIs 
list published APIs
list published apis with limit 5
list published apis with offset 4
list published apis with limit 5 and offset 5
list published apis in catalog CATALOG_NAME with limit 5
list published apis in catalog CATALOG_NAME with limit 5 and offset 3
 
/list_published_apis
/list_published_apis limit:5
/list_published_apis offset:4
/list_published_apis limit:5 offset:5
/list_published_apis limit:5 catalog:CATALOG_NAME
/list_published_apis catalog:CATALOG_NAME limit:5 offset:3
List apps 
list apps in catalog
list apps in catalog with limit 5
list apps in catalog with offset 4
list apps in catalog with limit 5 and offset 5
list apps in catalog CATALOG_NAME with limit 5
list apps in catalog CATALOG_NAME with limit 5 and offset 3
list apps in catalog for consumer org corg1
list apps in catalog CATALOG_NAME with limit 5 and consumer org corg1
list apps in catalog CATALOG_NAME with limit 5 and offset 3 and consumer org corg1
 
/list_consumer_apps
/list_consumer_apps limit:5
/list_consumer_apps offset:4
/list_consumer_apps limit:5 offset:5
/list_consumer_apps limit:5 catalog:CATALOG_NAME
/list_consumer_apps catalog:CATALOG_NAME limit:5 offset:3
/list_consumer_apps consumer_org:CONSUMER_ORG_NAME
/list_consumer_apps catalog:CATALOG_NAME limit:5 consumer_org:CONSUMER_ORG_NAME
/list_consumer_apps catalog:CATALOG_NAME limit:15 offset:5 consumer_org:CONSUMER_ORG_NAME