Sign in

v1

latestOpenAPI 3.0.32026-07-132612241.2 MB
task_exports

This view has multiple renderer classes available: json and xlsx. In order to export the data as an excel file, just set query argument format to xlsx.When downloading xlsx format, use Accept header application/vnd.openxmlformats-officedocument.spreadsheetml.sheet; version=...

The user can request what fields and in what order will be rendered using query argument fields. This is a comma separated list of field names used in the API. Available fields are visible in the example. Also metafields can be added to the response. For this just add them as fields, using structure metafields__{metafield.namespace}:{metafield.key}.

When exporting to excel, the column names may be changed based on account metafield names or pre-defined field name and width mapping.

Changes in version 2.2.1:

  • field names have been updated to reflect the Task fields schema and filters.
  • Invalid fields in fields request will return a ValidationError.
  • Account filter is required.
  • AccountRole display name is annotated to user objects.
  • 'task_event_notes' is dropped.
  • 'contact_phone' and 'contact_email' is replaced with 'contact_phones' and 'contact_emails'.
get/task_exports/

Query parameters

accountstring uuid
account__instring

comma separated value

address__apartment_numberstring

address__apartment_number

address__apartment_number__icontainsstring

address__apartment_number__icontains

address__apartment_number__instring

address__apartment_number__in

address__apartment_number__iregexstring

address__apartment_number__iregex

address__apartment_number__istartswithstring

address__apartment_number__istartswith

address__apartment_number__searchstring

address__apartment_number__search

address__citystring

address__city

address__city__icontainsstring

address__city__icontains

address__city__instring

address__city__in

address__city__iregexstring

address__city__iregex

address__city__istartswithstring

address__city__istartswith

address__city__searchstring

address__city__search

address__countrystring

address__country

address__country__icontainsstring

address__country__icontains

address__country__instring

address__country__in

address__country__iregexstring

address__country__iregex

address__country__istartswithstring

address__country__istartswith

address__country__searchstring

address__country__search

address__country_codestring

address__country_code

address__country_code__icontainsstring

address__country_code__icontains

address__country_code__instring

address__country_code__in

address__country_code__iregexstring

address__country_code__iregex

address__country_code__istartswithstring

address__country_code__istartswith

address__country_code__searchstring

address__country_code__search

address__formatted_addressstring

address__formatted_address

address__formatted_address__icontainsstring

address__formatted_address__icontains

address__formatted_address__instring

address__formatted_address__in

address__formatted_address__iregexstring

address__formatted_address__iregex

address__formatted_address__istartswithstring

address__formatted_address__istartswith

address__formatted_address__searchstring

address__formatted_address__search

address__geocode_failed_at__datestring date
address__geocode_failed_at__date_or_isnullstring date
address__geocode_failed_at__gtstring datetime
address__geocode_failed_at__gt_or_isnullstring datetime
address__geocode_failed_at__gtestring datetime
address__geocode_failed_at__gte_or_isnullstring datetime
address__geocode_failed_at__ltstring datetime
address__geocode_failed_at__lt_or_isnullstring datetime
address__geocode_failed_at__ltestring datetime
address__geocode_failed_at__lte_or_isnullstring datetime
address__geocoded_at__datestring date
address__geocoded_at__date_or_isnullstring date
address__geocoded_at__gtstring datetime
address__geocoded_at__gt_or_isnullstring datetime
address__geocoded_at__gtestring datetime
address__geocoded_at__gte_or_isnullstring datetime
address__geocoded_at__ltstring datetime
address__geocoded_at__lt_or_isnullstring datetime
address__geocoded_at__ltestring datetime
address__geocoded_at__lte_or_isnullstring datetime
address__google_place_idstring

address__google_place_id

address__google_place_id__icontainsstring

address__google_place_id__icontains

address__google_place_id__instring

address__google_place_id__in

address__google_place_id__iregexstring

address__google_place_id__iregex

address__google_place_id__istartswithstring

address__google_place_id__istartswith

address__google_place_id__searchstring

address__google_place_id__search

address__house_numberstring

address__house_number

address__house_number__icontainsstring

address__house_number__icontains

address__house_number__instring

address__house_number__in

address__house_number__iregexstring

address__house_number__iregex

address__house_number__istartswithstring

address__house_number__istartswith

address__house_number__searchstring

address__house_number__search

address__point_of_intereststring

address__point_of_interest

address__point_of_interest__icontainsstring

address__point_of_interest__icontains

address__point_of_interest__instring

address__point_of_interest__in

address__point_of_interest__iregexstring

address__point_of_interest__iregex

address__point_of_interest__istartswithstring

address__point_of_interest__istartswith

address__point_of_interest__searchstring

address__point_of_interest__search

address__postal_codestring

address__postal_code

address__postal_code__icontainsstring

address__postal_code__icontains

address__postal_code__instring

address__postal_code__in

address__postal_code__iregexstring

address__postal_code__iregex

address__postal_code__istartswithstring

address__postal_code__istartswith

address__postal_code__searchstring

address__postal_code__search

address__raw_addressstring

address__raw_address

address__raw_address__icontainsstring

address__raw_address__icontains

address__raw_address__instring

address__raw_address__in

address__raw_address__iregexstring

address__raw_address__iregex

address__raw_address__istartswithstring

address__raw_address__istartswith

address__raw_address__searchstring

address__raw_address__search

address__statestring

address__state

address__state__icontainsstring

address__state__icontains

address__state__instring

address__state__in

address__state__iregexstring

address__state__iregex

address__state__istartswithstring

address__state__istartswith

address__state__searchstring

address__state__search

address__streetstring

address__street

address__street__icontainsstring

address__street__icontains

address__street__instring

address__street__in

address__street__iregexstring

address__street__iregex

address__street__istartswithstring

address__street__istartswith

address__street__searchstring

address__street__search

address_datastring

Django ORM lookups can be used. Metafield is_searchable must be True.

address_idstring

address_id

address_id__instring

address_id__in

address_id__isnullstring

address_id__isnull

assigneestring uuid
assignee__emailstring

assignee__email

assignee__email__icontainsstring

assignee__email__icontains

assignee__email__iregexstring

assignee__email__iregex

assignee__email__isnullstring

assignee__email__isnull

assignee__email__istartswithstring

assignee__email__istartswith

assignee__email__searchstring

assignee__email__search

assignee__first_namestring

assignee__first_name

assignee__first_name__icontainsstring

assignee__first_name__icontains

assignee__first_name__iregexstring

assignee__first_name__iregex

assignee__first_name__isnullstring

assignee__first_name__isnull

assignee__first_name__istartswithstring

assignee__first_name__istartswith

assignee__first_name__searchstring

assignee__first_name__search

assignee__instring

comma separated value

assignee__last_namestring

assignee__last_name

assignee__last_name__icontainsstring

assignee__last_name__icontains

assignee__last_name__iregexstring

assignee__last_name__iregex

assignee__last_name__isnullstring

assignee__last_name__isnull

assignee__last_name__istartswithstring

assignee__last_name__istartswith

assignee__last_name__searchstring

assignee__last_name__search

assignee__phonestring

assignee__phone

assignee__phone__icontainsstring

assignee__phone__icontains

assignee__phone__iregexstring

assignee__phone__iregex

assignee__phone__isnullstring

assignee__phone__isnull

assignee__phone__istartswithstring

assignee__phone__istartswith

assignee__phone__searchstring

assignee__phone__search

assignee_idstring

assignee_id

assignee_id__instring

assignee_id__in

assignee_id__isnullstring

assignee_id__isnull

assignee_proximity'away' | 'near'

assignee_proximity

assignee_proximity__instring

assignee_proximity__in

barcodes__contained_bystring

Filter the returned list where all target array values contained in filter values. Comma separated values supported

barcodes__containsstring

Filter the returned list where filter_value in field values. Comma separated values supported

barcodes__isnullboolean

Filter the returned list where the array is null

barcodes__overlapstring

Filter the returned list where at least one filter value in target array. Comma separated values supported

cancelled_at__datestring date
cancelled_at__date_or_isnullstring date
cancelled_at__gtstring datetime
cancelled_at__gt_or_isnullstring datetime
cancelled_at__gtestring datetime
cancelled_at__gte_or_isnullstring datetime
cancelled_at__ltstring datetime
cancelled_at__lt_or_isnullstring datetime
cancelled_at__ltestring datetime
cancelled_at__lte_or_isnullstring datetime
category'assignment' | 'pick_up' | 'drop_off' | 'warehouse'

category

category__instring

category__in

complete_after__datestring date
complete_after__date_or_isnullstring date
complete_after__gtstring datetime
complete_after__gt_or_isnullstring datetime
complete_after__gtestring datetime
complete_after__gte_or_isnullstring datetime
complete_after__ltstring datetime
complete_after__lt_or_isnullstring datetime
complete_after__ltestring datetime
complete_after__lte_or_isnullstring datetime
complete_before__datestring date
complete_before__date_or_isnullstring date
complete_before__gtstring datetime
complete_before__gt_or_isnullstring datetime
complete_before__gtestring datetime
complete_before__gte_or_isnullstring datetime
complete_before__ltstring datetime
complete_before__lt_or_isnullstring datetime
complete_before__ltestring datetime
complete_before__lte_or_isnullstring datetime
completed_at__datestring date
completed_at__date_or_isnullstring date
completed_at__gtstring datetime
completed_at__gt_or_isnullstring datetime
completed_at__gtestring datetime
completed_at__gte_or_isnullstring datetime
completed_at__ltstring datetime
completed_at__lt_or_isnullstring datetime
completed_at__ltestring datetime
completed_at__lte_or_isnullstring datetime
contact__company__icontainsstring

contact__company__icontains

contact__company__instring

contact__company__in

contact__company__iregexstring

contact__company__iregex

contact__company__istartswithstring

contact__company__istartswith

contact__company__searchstring

contact__company__search

contact__emailstring

contact__email

contact__email__icontainsstring

contact__email__icontains

contact__email__instring

contact__email__in

contact__email__iregexstring

contact__email__iregex

contact__email__istartswithstring

contact__email__istartswith

contact__email__searchstring

contact__email__search

contact__emails__contained_bystring

Filter the returned list where all target array values contained in filter values. Comma separated emails supported

contact__emails__containsstring

Filter the returned list where filter_value in field values. Comma separated emails supported

contact__emails__isnullboolean

Filter the returned list where the array is null

contact__emails__overlapstring

Filter the returned list where at least one filter value in target array. Comma separated emails supported

contact__namestring

contact__name

contact__name__icontainsstring

contact__name__icontains

contact__name__instring

contact__name__in

contact__name__iregexstring

contact__name__iregex

contact__name__istartswithstring

contact__name__istartswith

contact__name__searchstring

contact__name__search

contact__notesstring

contact__notes

contact__notes__icontainsstring

contact__notes__icontains

contact__notes__instring

contact__notes__in

contact__notes__iregexstring

contact__notes__iregex

contact__notes__istartswithstring

contact__notes__istartswith

contact__notes__searchstring

contact__notes__search

contact__phonestring

contact__phone

contact__phone__icontainsstring

contact__phone__icontains

contact__phone__instring

contact__phone__in

contact__phone__iregexstring

contact__phone__iregex

contact__phone__istartswithstring

contact__phone__istartswith

contact__phone__searchstring

contact__phone__search

contact__phones__contained_bystring

Filter the returned list where all target array values contained in filter values. Comma separated values supported

contact__phones__containsstring

Filter the returned list where filter_value in field values. Comma separated values supported

contact__phones__isnullboolean

Filter the returned list where the array is null

contact__phones__overlapstring

Filter the returned list where at least one filter value in target array. Comma separated values supported

contact_datastring

Django ORM lookups can be used. Metafield is_searchable must be True.

contact_idstring

contact_id

contact_id__instring

contact_id__in

contact_id__isnullstring

contact_id__isnull

created_at__datestring date
created_at__date_or_isnullstring date
created_at__gtstring datetime
created_at__gt_or_isnullstring datetime
created_at__gtestring datetime
created_at__gte_or_isnullstring datetime
created_at__ltstring datetime
created_at__lt_or_isnullstring datetime
created_at__ltestring datetime
created_at__lte_or_isnullstring datetime
created_bystring

created_by

created_by__instring

created_by__in

created_by__isnullstring

created_by__isnull

descriptionstring

description

description__icontainsstring

description__icontains

description__iregexstring

description__iregex

description__istartswithstring

description__istartswith

description__searchstring

description__search

durationstring

duration

duration__gtstring

duration__gt

duration__gtestring

duration__gte

duration__ltstring

duration__lt

duration__ltestring

duration__lte

external_idstring

external_id

external_id__icontainsstring

external_id__icontains

external_id__instring

external_id__in

external_id__iregexstring

external_id__iregex

external_id__isnullstring

external_id__isnull

external_id__istartswithstring

external_id__istartswith

external_id__searchstring

external_id__search

fieldsstring

Select fields to be exported. Selected fields will be returned in the requested order. The value should be a comma separated value. When not used, all the fields in the serializer except metafields will be returned

format'json' | 'xlsx'

Selects response method. xlsx returns Excel file

idstring

id

id__instring

id__in

is_optimalstring

is_optimal

is_optimal__isnullstring

is_optimal__isnull

metadata__accepted_distancestring

metadata__accepted_distance

metadata__accepted_distance__gtstring

metadata__accepted_distance__gt

metadata__accepted_distance__gtestring

metadata__accepted_distance__gte

metadata__accepted_distance__ltstring

metadata__accepted_distance__lt

metadata__accepted_distance__ltestring

metadata__accepted_distance__lte

metadata__accepted_durationstring

metadata__accepted_duration

metadata__accepted_duration__gtstring

metadata__accepted_duration__gt

metadata__accepted_duration__gtestring

metadata__accepted_duration__gte

metadata__accepted_duration__ltstring

metadata__accepted_duration__lt

metadata__accepted_duration__ltestring

metadata__accepted_duration__lte

metadata__active_distancestring

metadata__active_distance

metadata__active_distance__gtstring

metadata__active_distance__gt

metadata__active_distance__gtestring

metadata__active_distance__gte

metadata__active_distance__ltstring

metadata__active_distance__lt

metadata__active_distance__ltestring

metadata__active_distance__lte

metadata__active_durationstring

metadata__active_duration

metadata__active_duration__gtstring

metadata__active_duration__gt

metadata__active_duration__gtestring

metadata__active_duration__gte

metadata__active_duration__ltstring

metadata__active_duration__lt

metadata__active_duration__ltestring

metadata__active_duration__lte

metadata__assigned_distancestring

metadata__assigned_distance

metadata__assigned_distance__gtstring

metadata__assigned_distance__gt

metadata__assigned_distance__gtestring

metadata__assigned_distance__gte

metadata__assigned_distance__ltstring

metadata__assigned_distance__lt

metadata__assigned_distance__ltestring

metadata__assigned_distance__lte

metadata__assigned_durationstring

metadata__assigned_duration

metadata__assigned_duration__gtstring

metadata__assigned_duration__gt

metadata__assigned_duration__gtestring

metadata__assigned_duration__gte

metadata__assigned_duration__ltstring

metadata__assigned_duration__lt

metadata__assigned_duration__ltestring

metadata__assigned_duration__lte

metadata__cancelled_distancestring

metadata__cancelled_distance

metadata__cancelled_distance__gtstring

metadata__cancelled_distance__gt

metadata__cancelled_distance__gtestring

metadata__cancelled_distance__gte

metadata__cancelled_distance__ltstring

metadata__cancelled_distance__lt

metadata__cancelled_distance__ltestring

metadata__cancelled_distance__lte

metadata__cancelled_durationstring

metadata__cancelled_duration

metadata__cancelled_duration__gtstring

metadata__cancelled_duration__gt

metadata__cancelled_duration__gtestring

metadata__cancelled_duration__gte

metadata__cancelled_duration__ltstring

metadata__cancelled_duration__lt

metadata__cancelled_duration__ltestring

metadata__cancelled_duration__lte

metadata__completed_distancestring

metadata__completed_distance

metadata__completed_distance__gtstring

metadata__completed_distance__gt

metadata__completed_distance__gtestring

metadata__completed_distance__gte

metadata__completed_distance__ltstring

metadata__completed_distance__lt

metadata__completed_distance__ltestring

metadata__completed_distance__lte

metadata__completed_durationstring

metadata__completed_duration

metadata__completed_duration__gtstring

metadata__completed_duration__gt

metadata__completed_duration__gtestring

metadata__completed_duration__gte

metadata__completed_duration__ltstring

metadata__completed_duration__lt

metadata__completed_duration__ltestring

metadata__completed_duration__lte

metadata__documents_countstring

metadata__documents_count

metadata__documents_count__gtstring

metadata__documents_count__gt

metadata__documents_count__gtestring

metadata__documents_count__gte

metadata__documents_count__ltstring

metadata__documents_count__lt

metadata__documents_count__ltestring

metadata__documents_count__lte

metadata__events_countstring

metadata__events_count

metadata__events_count__gtstring

metadata__events_count__gt

metadata__events_count__gtestring

metadata__events_count__gte

metadata__events_count__ltstring

metadata__events_count__lt

metadata__events_count__ltestring

metadata__events_count__lte

metadata__failed_distancestring

metadata__failed_distance

metadata__failed_distance__gtstring

metadata__failed_distance__gt

metadata__failed_distance__gtestring

metadata__failed_distance__gte

metadata__failed_distance__ltstring

metadata__failed_distance__lt

metadata__failed_distance__ltestring

metadata__failed_distance__lte

metadata__failed_durationstring

metadata__failed_duration

metadata__failed_duration__gtstring

metadata__failed_duration__gt

metadata__failed_duration__gtestring

metadata__failed_duration__gte

metadata__failed_duration__ltstring

metadata__failed_duration__lt

metadata__failed_duration__ltestring

metadata__failed_duration__lte

metadata__forms_completed_countstring

metadata__forms_completed_count

metadata__forms_completed_count__gtstring

metadata__forms_completed_count__gt

metadata__forms_completed_count__gtestring

metadata__forms_completed_count__gte

metadata__forms_completed_count__ltstring

metadata__forms_completed_count__lt

metadata__forms_completed_count__ltestring

metadata__forms_completed_count__lte

metadata__forms_countstring

metadata__forms_count

metadata__forms_count__gtstring

metadata__forms_count__gt

metadata__forms_count__gtestring

metadata__forms_count__gte

metadata__forms_count__ltstring

metadata__forms_count__lt

metadata__forms_count__ltestring

metadata__forms_count__lte

metadata__last_accepted_at__datestring date
metadata__last_accepted_at__date_or_isnullstring date
metadata__last_accepted_at__gtstring datetime
metadata__last_accepted_at__gt_or_isnullstring datetime
metadata__last_accepted_at__gtestring datetime
metadata__last_accepted_at__gte_or_isnullstring datetime
metadata__last_accepted_at__ltstring datetime
metadata__last_accepted_at__lt_or_isnullstring datetime
metadata__last_accepted_at__ltestring datetime
metadata__last_accepted_at__lte_or_isnullstring datetime
metadata__last_active_at__datestring date
metadata__last_active_at__date_or_isnullstring date
metadata__last_active_at__gtstring datetime
metadata__last_active_at__gt_or_isnullstring datetime
metadata__last_active_at__gtestring datetime
metadata__last_active_at__gte_or_isnullstring datetime
metadata__last_active_at__ltstring datetime
metadata__last_active_at__lt_or_isnullstring datetime
metadata__last_active_at__ltestring datetime
metadata__last_active_at__lte_or_isnullstring datetime
metadata__last_assigned_at__datestring date
metadata__last_assigned_at__date_or_isnullstring date
metadata__last_assigned_at__gtstring datetime
metadata__last_assigned_at__gt_or_isnullstring datetime
metadata__last_assigned_at__gtestring datetime
metadata__last_assigned_at__gte_or_isnullstring datetime
metadata__last_assigned_at__ltstring datetime
metadata__last_assigned_at__lt_or_isnullstring datetime
metadata__last_assigned_at__ltestring datetime
metadata__last_assigned_at__lte_or_isnullstring datetime
metadata__last_cancelled_at__datestring date
metadata__last_cancelled_at__date_or_isnullstring date
metadata__last_cancelled_at__gtstring datetime
metadata__last_cancelled_at__gt_or_isnullstring datetime
metadata__last_cancelled_at__gtestring datetime
metadata__last_cancelled_at__gte_or_isnullstring datetime
metadata__last_cancelled_at__ltstring datetime
metadata__last_cancelled_at__lt_or_isnullstring datetime
metadata__last_cancelled_at__ltestring datetime
metadata__last_cancelled_at__lte_or_isnullstring datetime
metadata__last_completed_at__datestring date
metadata__last_completed_at__date_or_isnullstring date
metadata__last_completed_at__gtstring datetime
metadata__last_completed_at__gt_or_isnullstring datetime
metadata__last_completed_at__gtestring datetime
metadata__last_completed_at__gte_or_isnullstring datetime
metadata__last_completed_at__ltstring datetime
metadata__last_completed_at__lt_or_isnullstring datetime
metadata__last_completed_at__ltestring datetime
metadata__last_completed_at__lte_or_isnullstring datetime
metadata__last_failed_at__datestring date
metadata__last_failed_at__date_or_isnullstring date
metadata__last_failed_at__gtstring datetime
metadata__last_failed_at__gt_or_isnullstring datetime
metadata__last_failed_at__gtestring datetime
metadata__last_failed_at__gte_or_isnullstring datetime
metadata__last_failed_at__ltstring datetime
metadata__last_failed_at__lt_or_isnullstring datetime
metadata__last_failed_at__ltestring datetime
metadata__last_failed_at__lte_or_isnullstring datetime
metadata__last_transit_at__datestring date
metadata__last_transit_at__date_or_isnullstring date
metadata__last_transit_at__gtstring datetime
metadata__last_transit_at__gt_or_isnullstring datetime
metadata__last_transit_at__gtestring datetime
metadata__last_transit_at__gte_or_isnullstring datetime
metadata__last_transit_at__ltstring datetime
metadata__last_transit_at__lt_or_isnullstring datetime
metadata__last_transit_at__ltestring datetime
metadata__last_transit_at__lte_or_isnullstring datetime
metadata__last_unassigned_at__datestring date
metadata__last_unassigned_at__date_or_isnullstring date
metadata__last_unassigned_at__gtstring datetime
metadata__last_unassigned_at__gt_or_isnullstring datetime
metadata__last_unassigned_at__gtestring datetime
metadata__last_unassigned_at__gte_or_isnullstring datetime
metadata__last_unassigned_at__ltstring datetime
metadata__last_unassigned_at__lt_or_isnullstring datetime
metadata__last_unassigned_at__ltestring datetime
metadata__last_unassigned_at__lte_or_isnullstring datetime
metadata__signatures_countstring

metadata__signatures_count

metadata__signatures_count__gtstring

metadata__signatures_count__gt

metadata__signatures_count__gtestring

metadata__signatures_count__gte

metadata__signatures_count__ltstring

metadata__signatures_count__lt

metadata__signatures_count__ltestring

metadata__signatures_count__lte

metadata__task_event_notes_countstring

metadata__task_event_notes_count

metadata__task_event_notes_count__gtstring

metadata__task_event_notes_count__gt

metadata__task_event_notes_count__gtestring

metadata__task_event_notes_count__gte

metadata__task_event_notes_count__ltstring

metadata__task_event_notes_count__lt

metadata__task_event_notes_count__ltestring

metadata__task_event_notes_count__lte

metadata__transit_distancestring

metadata__transit_distance

metadata__transit_distance__gtstring

metadata__transit_distance__gt

metadata__transit_distance__gtestring

metadata__transit_distance__gte

metadata__transit_distance__ltstring

metadata__transit_distance__lt

metadata__transit_distance__ltestring

metadata__transit_distance__lte

metadata__transit_durationstring

metadata__transit_duration

metadata__transit_duration__gtstring

metadata__transit_duration__gt

metadata__transit_duration__gtestring

metadata__transit_duration__gte

metadata__transit_duration__ltstring

metadata__transit_duration__lt

metadata__transit_duration__ltestring

metadata__transit_duration__lte

metadata__unassigned_distancestring

metadata__unassigned_distance

metadata__unassigned_distance__gtstring

metadata__unassigned_distance__gt

metadata__unassigned_distance__gtestring

metadata__unassigned_distance__gte

metadata__unassigned_distance__ltstring

metadata__unassigned_distance__lt

metadata__unassigned_distance__ltestring

metadata__unassigned_distance__lte

metadata__unassigned_durationstring

metadata__unassigned_duration

metadata__unassigned_duration__gtstring

metadata__unassigned_duration__gt

metadata__unassigned_duration__gtestring

metadata__unassigned_duration__gte

metadata__unassigned_duration__ltstring

metadata__unassigned_duration__lt

metadata__unassigned_duration__ltestring

metadata__unassigned_duration__lte

metafields__namespace:keystring

Django ORM lookups can be used. Metafield is_searchable must be True.

orderstring uuid
order__auto_assignstring

order__auto_assign

order__created_at__datestring date
order__created_at__date_or_isnullstring date
order__created_at__gtstring datetime
order__created_at__gt_or_isnullstring datetime
order__created_at__gtestring datetime
order__created_at__gte_or_isnullstring datetime
order__created_at__ltstring datetime
order__created_at__lt_or_isnullstring datetime
order__created_at__ltestring datetime
order__created_at__lte_or_isnullstring datetime
order__created_bystring

order__created_by

order__created_by__instring

order__created_by__in

order__created_by__isnullstring

order__created_by__isnull

order__external_idstring

order__external_id

order__external_id__icontainsstring

order__external_id__icontains

order__external_id__instring

order__external_id__in

order__external_id__iregexstring

order__external_id__iregex

order__external_id__isnullstring

order__external_id__isnull

order__external_id__istartswithstring

order__external_id__istartswith

order__external_id__searchstring

order__external_id__search

order__instring

comma separated value

order__ordererstring

Django ORM lookups can be used. Metafield is_searchable must be True.

order__orderer__companystring
order__orderer__company__icontainsstring
order__orderer__company__iexactstring
order__orderer__company__istartswithstring
order__orderer__emails__contained_bystring

Filter the returned list where all target array values contained in filter values. Comma separated values supported

order__orderer__emails__containsstring

Filter the returned list where all filter_values are present. Comma separated values supported

order__orderer__emails__overlapstring

Filter the returned list where at least one filter value in target array. Comma separated values supported

order__orderer__namestring
order__orderer__name__icontainsstring
order__orderer__name__iexactstring
order__orderer__name__istartswithstring
order__orderer__notesstring
order__orderer__notes__icontainsstring
order__orderer__notes__iexactstring
order__orderer__notes__istartswithstring
order__orderer__phones__contained_bystring

Filter the returned list where all target array values contained in filter values. Comma separated values supported

order__orderer__phones__containsstring

Filter the returned list where all filter_values are present. Comma separated values supported

order__orderer__phones__overlapstring

Filter the returned list where at least one filter value in target array. Comma separated values supported

order__referencestring

order__reference

order__reference__icontainsstring

order__reference__icontains

order__reference__instring

order__reference__in

order__reference__iregexstring

order__reference__iregex

order__reference__istartswithstring

order__reference__istartswith

order__reference__searchstring

order__reference__search

order_idstring

order_id

order_id__instring

order_id__in

order_id__isnullstring

order_id__isnull

ordererstring uuid
orderer__idstring

orderer__id

orderer__id__instring

orderer__id__in

orderer__id__isnullstring

orderer__id__isnull

orderer__instring

comma separated value

orderer__namestring

orderer__name

orderer__name__icontainsstring

orderer__name__icontains

orderer_idstring

orderer_id

orderer_id__instring

orderer_id__in

orderer_id__isnullstring

orderer_id__isnull

orderingstring

Which field to use when ordering the results.

owner_idstring

owner_id

owner_id__instring

owner_id__in

owner_id__isnullstring

owner_id__isnull

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

position__datestring date
position__date_or_isnullstring date
position__gtstring datetime
position__gt_or_isnullstring datetime
position__gtestring datetime
position__gte_or_isnullstring datetime
position__ltstring datetime
position__lt_or_isnullstring datetime
position__ltestring datetime
position__lte_or_isnullstring datetime
previous_assignees__contained_bystring

Filter the returned list where all target array values contained in filter values. Comma separated UUID values supported

previous_assignees__containsstring

Filter the returned list where filter_value in field values. Comma separated UUID values supported

previous_assignees__isnullboolean

Filter the returned list where the array is null

previous_assignees__overlapstring

Filter the returned list where at least one filter value in target array. Comma separated UUID values supported

prioritystring

priority

priority__gtstring

priority__gt

priority__gtestring

priority__gte

priority__instring

priority__in

priority__ltstring

priority__lt

priority__ltestring

priority__lte

receiverstring uuid
receiver__instring

comma separated value

receiver_idstring

receiver_id

receiver_id__instring

receiver_id__in

receiver_id__isnullstring

receiver_id__isnull

referencestring

reference

reference__icontainsstring

reference__icontains

reference__instring

reference__in

reference__iregexstring

reference__iregex

reference__istartswithstring

reference__istartswith

reference__searchstring

reference__search

routestring uuid
route__instring

comma separated value

route_idstring

route_id

route_id__instring

route_id__in

route_id__isnullstring

route_id__isnull

scheduled_time__datestring date
scheduled_time__date_or_isnullstring date
scheduled_time__gtstring datetime
scheduled_time__gt_or_isnullstring datetime
scheduled_time__gtestring datetime
scheduled_time__gte_or_isnullstring datetime
scheduled_time__ltstring datetime
scheduled_time__lt_or_isnullstring datetime
scheduled_time__ltestring datetime
scheduled_time__lte_or_isnullstring datetime
searchstring

A search term.

size__contained_bystring

Filter the returned list where all target array values contained in filter values. Comma separated integer values supported

size__containsstring

Filter the returned list where filter_value in field values. Comma separated integer values supported

size__isnullboolean

Filter the returned list where the array is null

size__overlapstring

Filter the returned list where at least one filter value in target array. Comma separated integer values supported

state'unassigned' | 'assigned' | 'accepted' | 'transit' | 'active' | 'completed' | 'failed' | 'cancelled'

state

state__instring
state__in_or_isnullstring
state__not_instring
state__not_in_or_isnullstring
task_importstring uuid
task_import__instring

comma separated value

unassignee_idstring

unassignee_id

unassignee_id__instring

unassignee_id__in

unassignee_id__isnullstring

unassignee_id__isnull

updated_at__datestring date
updated_at__date_or_isnullstring date
updated_at__gtstring datetime
updated_at__gt_or_isnullstring datetime
updated_at__gtestring datetime
updated_at__gte_or_isnullstring datetime
updated_at__ltstring datetime
updated_at__lt_or_isnullstring datetime
updated_at__ltestring datetime
updated_at__lte_or_isnullstring datetime
updated_at_delay_latestboolean

Ensures that the last updated data is not immediately available in order to allow the latest changes to finish taking effect. If used, the updated_at upper bound is limited to 2 seconds ago. This prevents the out-of-order appearance of records. Availabe since API version 2.4.13. For older versions, this filter is forced True if updated_at__gt or updated_at__gteis used.