> ## Documentation Index > Fetch the complete documentation index at: https://higginsgraferinc.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve list of ingredients > Retrieve a list of ingredients and the associated details. The `in_stock_qty` value is most commonly used to for tracking ingredient inventory and determining if a dish is available to order in the client app. A 0 or other non-positive value tells the client app to make a dish unavailable to order if that ingredient is considered essential. ## OpenAPI ````yaml openapi.yaml get /ingredients openapi: 3.0.3 info: title: Point of Service (POS) API version: '1.0' description: > An example of a restaurant point of sale API, used to learn how to make API calls using Swagger, Github codespaces, and Postman, and to learn API documentation best practices. contact: name: Course Discord server url: https://discord.gg/dPsnz5u9 email: mark.wentowski@docsgeek.io license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html servers: - url: https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev description: The server URL used for the point of service API variables: gh-codespaces-server-url: default: https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev description: >- Codespace URL used by Sarah Holdgrafer for Mastering API Documentation course. - url: http://localhost:80/ description: Local URL for testing security: [] tags: - name: Orders description: Methods for creating and managing orders in the client app. - name: Dishes description: Methods for creating and managing dishes in the client app. - name: Ingredients description: Methods used for creating and managing ingredients in the client app . - name: Users description: >- Methods for creating and managing the user accounts allowed to access the client app. - name: Auth description: Authentication endpoints for the client app (all methods use Basic auth). paths: /ingredients: get: tags: - Ingredients summary: Retrieve list of ingredients description: > Retrieve a list of ingredients and the associated details. The `in_stock_qty` value is most commonly used to for tracking ingredient inventory and determining if a dish is available to order in the client app. A 0 or other non-positive value tells the client app to make a dish unavailable to order if that ingredient is considered essential. operationId: getIngredientList parameters: - name: sort in: query description: >- Sort the list in the response by a specific property. Used with the `order` parameter. schema: type: string example: name - name: order in: query description: >- Set the sort order to `asc` for ascending or `desc` for descending. Must be used with the `sort` parameter. schema: type: string example: asc - name: fields in: query description: Restrict which properties are returned in the response. schema: type: string example: name|in_stock_qty - name: filter in: query description: >- Filter the response to include only items that have properties equal to the specified value. schema: type: string example: created_at.gt~2024-05-07|in_stock_qty.lt~5 - name: limit in: query description: Limit the number of objects in the response. schema: type: integer maximum: 30 example: 10 - name: offset in: query description: Offsets the start of the list by the set value. Defaults to 0. schema: type: integer example: 0 responses: '200': description: Request successful content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/Ingredient' total_results: type: integer example: 1 '400': description: Invalid request '401': description: Unauthorized '403': description: Access denied '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Problem' components: schemas: Ingredient: type: object properties: id: $ref: '#/components/schemas/Id' created_at: $ref: '#/components/schemas/CreatedAt' updated_at: $ref: '#/components/schemas/UpdatedAt' name: type: string example: Carrot description: The name of the ingredient that will appear in the client app. in_stock_qty: $ref: '#/components/schemas/InStockQty' price: $ref: '#/components/schemas/Price' Problem: type: object properties: title: type: string description: >- A short summary of the error or problem encountered with the request. example: Human-readable error title. detail: type: string description: >- A more detailed description of the error or problem to indicate the source and the solution, if possible. example: Human-readable error details. required: - title - detail Id: type: string example: 674d0bf5c28b69001f8e03a1 readOnly: true description: > A unique alpha-numeric string generated by the system when creating a resource (e.g., dishes, ingredients, etc). Ids are required for retrieving the properties of a specific resource. CreatedAt: type: string format: date-time example: '2024-04-22T10:00:00Z' readOnly: true description: > The date and time the resource was created. Timestamp uses ISO 8601 format, Ex: `2025-04-05T14:55:03.824Z` UpdatedAt: type: string format: date-time example: '2024-04-22T10:00:00Z' readOnly: true description: | The date and time the resource was last updated. Timestamp uses ISO 8601 format, Ex: `2025-04-05T14:55:03.824Z` InStockQty: type: integer description: > The quantity of the ingredient currently in stock. This field is used to track the ingredient inventory. If the ingredient is essential and has a value of 0, the associated dish cannot be ordered via the client app. example: 3 Price: type: number format: float example: 999 description: The price used by the client app to calculate order cost. ````