Skip to main content
Get Collection API

Retrieve collection details using a specific collection_id.

Updated over a year ago

Overview

Retrieve collection details using a specific collection_id. In the Stellar Menus platform, a collection represents a service period such as "breakfast" or "dinner" and defines what menus are available during that service period.

Request

Endpoint:

/v1/collection

Method:

GET

Headers:

Authorization: <Your-API-Key>

When forming your request, include a JSON payload with the specific collection_id you're interested in:

{
"collection_id": "your_collection_id"
}

Replace your_collection_id with the actual ID of the collection you're inquiring about.

Response

Upon submitting the request, the API will provide details related to the given collection.

Example Request Body

{
"collection_id": "63250dafda6e4c02847e4296"
}

Expected Response

{
"display_name": "Lunch",
"menu_links":
[
"645ed94355ef4a74c854fc92",
"988ed94365aa4a74c30cd832"
]
}
Did this answer your question?