AdminGetBatchParams
Parameters used to filter and configure pagination of the retrieved batch jobs.
Properties
limitnumberRequiredLimit the number of items returned in the list.
Default: 10
offsetnumberRequiredThe number of items to skip when retrieving a list.
Default: 0
expandstringComma-separated relations that should be expanded in the returned data.
fieldsstringComma-separated fields that should be included in the returned data.
orderstringThe field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with
-.idstring | string[]IDs to filter batch jobs by.
typestring[]Types to filter batch jobs by.
confirmed_atnull | DateComparisonOperatorDate filters to apply on the batch jobs'
confirmed_at date.pre_processed_atnull | DateComparisonOperatorDate filters to apply on the batch jobs'
pre_processed_at date.completed_atnull | DateComparisonOperatorDate filters to apply on the batch jobs'
completed_at date.failed_atnull | DateComparisonOperatorDate filters to apply on the batch jobs'
failed_at date.canceled_atnull | DateComparisonOperatorDate filters to apply on the batch jobs'
canceled_at date.created_atDateComparisonOperatorDate filters to apply on the batch jobs' created_at date.
created_atDateComparisonOperatorcreated_at date.updated_atDateComparisonOperatorDate filters to apply on the batch jobs' updated_at date.
updated_atDateComparisonOperatorupdated_at date.Was this section helpful?