Skip to documentation
Docs
Sign in Get an API key API key
Browse documentation
For AI agents

Connect your agent to live platform data.

Open in
JioMart API Capability

Collections

Browse JioMart collection-directory records and discover slugs for collection-product requests.

Capability ID jiomart.collections.list
Maximum runtime 30 seconds
View raw

POST /execute Shared execution endpoint

Input parameters

page starts at 1 when supplied. page_size must be a positive integer; the current schema does not declare a maximum.

page integer optional

One-based result page to fetch. At least 1.

page_size integer optional

Number of results per page. At least 1.

Example 5

Response

Successful output is returned in results[0].data.

Collection records can include slug, name, status, query metadata, filters and page information.

Use a returned collection slug with jiomart.collection.products.list. Do not infer a fixed collection count from one directory response.

Illustrative sample The example response is shown in the response panel.

Illustrative output fields

Values illustrate one response. Read the guidance above for missing values and limits; fields can vary with the requested operation and the data available.

PathObserved typeExample
items array 3 items
items array 3 items
page object 6 fields
page.current integer 1
page.has_next boolean true
page.has_previous boolean false
page.item_total integer 26924
page.total integer 5385
page.type string number
raw object 3 fields
raw.filters object 2 fields
raw.items array 3 items
raw.page object 6 fields

Execution behavior

A 200 response completed inline. A 202 response was queued; poll GET /jobs/:id until the job reaches completed or failed.

Overview, pricing and sample data for every endpoint: JioMart API