AdminGetRegionsParams
Parameters used to filter and configure the pagination of the retrieved regions.
Properties
qstringSearch parameter for regions.
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
-.created_atDateComparisonOperatorDate filters to apply on the regions' created_at date.
created_atDateComparisonOperatorcreated_at date.updated_atDateComparisonOperatorDate filters to apply on the regions' updated_at date.
updated_atDateComparisonOperatorupdated_at date.deleted_atDateComparisonOperatorDate filters to apply on the regions' deleted_at date.
deleted_atDateComparisonOperatordeleted_at date.expandstringComma-separated relations that should be expanded in the returned data.
fieldsstringComma-separated fields that should be included in the returned data.
if a field is prefixed with
+ it will be added to the default fields, using - will remove it from the default fields.
without prefix it will replace the entire default fields.offsetnumberThe number of items to skip when retrieving a list.
Default: 0
limitnumberLimit the number of items returned in the list.
Default: 20
Was this section helpful?