---
displayed_sidebar: homepage
---

import TypeList from "@site/src/components/TypeList"

# AdminGetBatchParams

Parameters used to filter and configure pagination of the retrieved batch jobs.

## Properties

<TypeList types={[{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":false,"defaultValue":"10","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"IDs to filter batch jobs by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`[]","description":"Types to filter batch jobs by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`null` \\| [DateComparisonOperator](medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the batch jobs' `confirmed_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pre_processed_at","type":"`null` \\| [DateComparisonOperator](medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the batch jobs' `pre_processed_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`null` \\| [DateComparisonOperator](medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the batch jobs' `completed_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"failed_at","type":"`null` \\| [DateComparisonOperator](medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the batch jobs' `failed_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| [DateComparisonOperator](medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the batch jobs' `canceled_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[DateComparisonOperator](medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the batch jobs' `created_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"[DateComparisonOperator](medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the batch jobs' `updated_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="AdminGetBatchParams"/>