openapi: 3.0.3
info:
  title: GSMTasks API
  version: 2.11.9
  description: The GSMtasks API is a RESTful web service for developers to programmatically
    interact with GSMtasks data, real-time delivery and task management and route
    optimization functionality.
  contact:
    name: API Support
    url: https://www.gsmtasks.com/
    email: api@gsmtasks.com
paths:
  /account_roles/:
    get:
      operationId: account_roles_list
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - name: activated_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: activated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: activated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: activated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: activated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: activated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: activated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: activated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: activated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: activated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: activated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - name: deleted_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: deleted_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: deleted_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: deleted_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: deleted_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: deleted_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: deleted_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: deleted_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: deleted_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: deleted_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: deleted_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: display_name
        schema:
          type: string
      - name: is_active
        required: false
        in: query
        example: true
        schema:
          type: boolean
      - in: query
        name: is_admin
        schema:
          type: boolean
      - in: query
        name: is_integration
        schema:
          type: boolean
      - in: query
        name: is_manager
        schema:
          type: boolean
      - in: query
        name: is_worker
        schema:
          type: boolean
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - accounts
            - last_time_locations
            - users
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: accounts,users
            summary: Regular sideloading
      - in: query
        name: state
        schema:
          type: string
          enum:
          - active
          - deleted
          - inactive
        description: |-
          * `inactive` - Inactive
          * `active` - Active
          * `deleted` - Deleted
      - name: state__in
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: state__in_or_isnull
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: state__not_in
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: state__not_in_or_isnull
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: user
        schema:
          type: string
          format: uuid
      - in: query
        name: user__email
        schema:
          type: string
      tags:
      - account_roles
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedAccountRoleList'
          description: ''
    post:
      operationId: account_roles_create
      tags:
      - account_roles
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountRoleCreate'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/AccountRoleCreate'
          description: ''
  /account_roles/{id}/:
    get:
      operationId: account_roles_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this account role.
        required: true
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - accounts
            - last_time_locations
            - users
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: accounts,users
            summary: Regular sideloading
      tags:
      - account_roles
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/AccountRole'
          description: ''
    put:
      operationId: account_roles_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this account role.
        required: true
      tags:
      - account_roles
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountRole'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/AccountRole'
          description: ''
    patch:
      operationId: account_roles_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this account role.
        required: true
      tags:
      - account_roles
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedAccountRole'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/AccountRole'
          description: ''
    delete:
      operationId: account_roles_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this account role.
        required: true
      tags:
      - account_roles
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /account_roles/{id}/activate/:
    post:
      operationId: account_roles_activate_create
      description: Action to activate the account role. Available since version `2.4.1`
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this account role.
        required: true
      tags:
      - account_roles
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountRoleActivation'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                type: string
          description: ''
  /account_roles/{id}/notify/:
    post:
      operationId: account_roles_notify_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this account role.
        required: true
      tags:
      - account_roles
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/AccountRole'
          description: ''
  /account_roles/{id}/resend_token/:
    post:
      operationId: account_roles_resend_token_create
      description: Action to resend a new activateion token to the account role. Available
        since version `2.4.30`
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this account role.
        required: true
      tags:
      - account_roles
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                type: string
          description: ''
  /accounts/:
    get:
      operationId: accounts_list
      parameters:
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - name: explicit_permissions
        required: false
        in: query
        description: Filter the returned list by explicit permissions, multiple, comma
          separated values supported.
        schema:
          type: string
        style: form
        explode: false
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - accounts
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedAccountList'
          description: ''
  /accounts/{id}/:
    get:
      operationId: accounts_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this account.
        required: true
      tags:
      - accounts
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Account'
          description: ''
    put:
      operationId: accounts_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this account.
        required: true
      tags:
      - accounts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Account'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Account'
          description: ''
    patch:
      operationId: accounts_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this account.
        required: true
      tags:
      - accounts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedAccount'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Account'
          description: ''
  /accounts/{id}/change_owner/:
    post:
      operationId: accounts_change_owner_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this account.
        required: true
      tags:
      - accounts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountOwnerChange'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/AccountOwnerChange'
          description: ''
  /accounts/{id}/stripe_attach_payment_method/:
    put:
      operationId: accounts_stripe_attach_payment_method_update
      description: |-
        Action to (re)set the account stripe customer and payment method to new values.
        By default the attached method will also be set as default.
        If this is not desired, you can send

            'set_default': False
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this account.
        required: true
      tags:
      - accounts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountStripePaymentMethodAttach'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/AccountStripePaymentMethodAttach'
          description: ''
  /accounts/{id}/stripe_create_setup_intent/:
    post:
      operationId: accounts_stripe_create_setup_intent_create
      description: Action to start a new setup intent.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this account.
        required: true
      tags:
      - accounts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountStripeSetupIntentCreate'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                setup_intent: {}
          description: Responds with external API response
    put:
      operationId: accounts_stripe_create_setup_intent_update
      description: Action to start a new setup intent.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this account.
        required: true
      tags:
      - accounts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountStripeSetupIntentCreate'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                setup_intent: {}
          description: Responds with external API response
  /accounts/{id}/stripe_detach_payment_method/:
    put:
      operationId: accounts_stripe_detach_payment_method_update
      description: |-
        Detached payment method from the customer.
        The payment method itself will remain somewhere in stripe, but as its no longer linked to the customer,
        it might as well be deleted for us
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this account.
        required: true
      tags:
      - accounts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountStripePaymentMethodDetach'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/AccountStripePaymentMethodDetach'
          description: ''
  /accounts/{id}/stripe_get_payment_method/:
    get:
      operationId: accounts_stripe_get_payment_method_retrieve
      description: Fetch a single payment method from stripe.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this account.
        required: true
      tags:
      - accounts
      security:
      - tokenAuth: []
      responses:
        '200':
          description: Responds with external API response
  /accounts/{id}/stripe_get_setup_attempt/:
    get:
      operationId: accounts_stripe_get_setup_attempt_retrieve
      description: Fetch a single setup intent
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this account.
        required: true
      tags:
      - accounts
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/AccountStripeSetupAttemptGet'
          description: ''
  /accounts/{id}/stripe_get_setup_intent/:
    get:
      operationId: accounts_stripe_get_setup_intent_retrieve
      description: Fetch a single payment intent.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this account.
        required: true
      tags:
      - accounts
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                setup_intent: {}
          description: Responds with external API response
  /accounts/{id}/stripe_payment_methods/:
    get:
      operationId: accounts_stripe_payment_methods_retrieve
      description: Fetch all customer payment methods.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this account.
        required: true
      tags:
      - accounts
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                default_payment_method_id: null
                attached_payment_methods: []
          description: Responds with external API response
  /accounts/{id}/stripe_set_default_payment_method/:
    put:
      operationId: accounts_stripe_set_default_payment_method_update
      description: Action to set a payment method to default.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this account.
        required: true
      tags:
      - accounts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountStripePaymentMethodSetDefault'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/AccountStripePaymentMethodSetDefault'
          description: ''
  /accounts/{id}/stripe_setup_intents/:
    get:
      operationId: accounts_stripe_setup_intents_retrieve
      description: Fetch existing setup intents
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this account.
        required: true
      tags:
      - accounts
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/AccountStripeSetupIntentsGet'
          description: ''
  /addons/:
    get:
      operationId: addons_list
      parameters:
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      tags:
      - addons
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedAddonList'
          description: ''
  /addons/{id}/:
    get:
      operationId: addons_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this addon.
        required: true
      tags:
      - addons
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Addon'
          description: ''
  /authenticate/:
    post:
      operationId: authenticate_create
      description: Returns a JSON Web Token that can be used for authenticated requests.
      tags:
      - authenticate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Authenticate'
        required: true
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TokenResponse'
          description: Token obtained
        '400':
          description: Invalid credentials or malformed request
  /billing/invoices/:
    get:
      operationId: billing_invoices_list
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - in: query
        name: billing_method
        schema:
          type: string
          enum:
          - braintree
          - invoice
          - stripe
        description: |-
          * `braintree` - Braintree
          * `invoice` - Invoice
          * `stripe` - Stripe
      - name: confirmed_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: confirmed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: confirmed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: confirmed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: confirmed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: confirmed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: confirmed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: confirmed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: confirmed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: confirmed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: confirmed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: state
        schema:
          type: string
          enum:
          - cancelled
          - confirmed
          - draft
          - overdue
          - paid
        description: |-
          * `draft` - Draft
          * `confirmed` - Confirmed
          * `overdue` - Overdue
          * `paid` - Paid
          * `cancelled` - Cancelled
      tags:
      - billing
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedInvoiceList'
          description: ''
  /billing/invoices/{id}/:
    get:
      operationId: billing_invoices_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this invoice.
        required: true
      tags:
      - billing
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Invoice'
          description: ''
    put:
      operationId: billing_invoices_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this invoice.
        required: true
      tags:
      - billing
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Invoice'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Invoice'
          description: ''
    patch:
      operationId: billing_invoices_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this invoice.
        required: true
      tags:
      - billing
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedInvoice'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Invoice'
          description: ''
  /billing/invoices/{id}/mark_as_paid/:
    post:
      operationId: billing_invoices_mark_as_paid_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this invoice.
        required: true
      tags:
      - billing
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvoicePayment'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Invoice'
          description: ''
  /billing/stripe_payments/:
    get:
      operationId: billing_stripe_payments_list
      parameters:
      - in: query
        name: billable_account
        schema:
          type: string
          format: uuid
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: invoice
        schema:
          type: string
          format: uuid
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: state
        schema:
          type: string
          enum:
          - cancelled
          - draft
          - failed
          - rejected
          - retried
          - saved
          - settled
        description: |-
          * `draft` - Draft
          * `failed` - Failed to upload
          * `saved` - Saved
          * `settled` - Settled
          * `rejected` - Rejected
          * `retried` - Retried
          * `cancelled` - Cancelled
      - in: query
        name: stripe_state
        schema:
          nullable: true
          enum:
          - null
          - canceled
          - processing
          - requires_action
          - requires_capture
          - requires_confirmation
          - requires_payment_method
          - succeeded
        description: |-
          * `None` - Unknown
          * `requires_payment_method` - Requires payment method
          * `requires_confirmation` - Requires confirmation
          * `requires_capture` - requires capture
          * `requires_action` - requires action
          * `processing` - Processing
          * `succeeded` - Succeeded
          * `canceled` - Canceled
      tags:
      - billing
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedStripePaymentList'
          description: ''
  /billing/stripe_payments/{id}/:
    get:
      operationId: billing_stripe_payments_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this stripe payment.
        required: true
      tags:
      - billing
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/StripePayment'
          description: ''
  /client_roles/:
    get:
      operationId: client_roles_list
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - in: query
        name: client
        schema:
          type: string
          format: uuid
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: is_active
        schema:
          type: boolean
      - in: query
        name: is_manager
        schema:
          type: boolean
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - accounts
            - clients
            - users
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: accounts,users
            summary: Regular sideloading
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: user
        schema:
          type: string
          format: uuid
      - in: query
        name: user__email
        schema:
          type: string
      tags:
      - client_roles
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedClientRoleList'
          description: ''
    post:
      operationId: client_roles_create
      tags:
      - client_roles
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientRole'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/ClientRole'
          description: ''
  /client_roles/{id}/:
    get:
      operationId: client_roles_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this client role.
        required: true
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - accounts
            - clients
            - users
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: accounts,users
            summary: Regular sideloading
      tags:
      - client_roles
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/ClientRole'
          description: ''
    put:
      operationId: client_roles_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this client role.
        required: true
      tags:
      - client_roles
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientRole'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/ClientRole'
          description: ''
    patch:
      operationId: client_roles_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this client role.
        required: true
      tags:
      - client_roles
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedClientRole'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/ClientRole'
          description: ''
  /clients/:
    get:
      operationId: clients_list
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: slug
        schema:
          type: string
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - clients
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedClientList'
          description: ''
    post:
      operationId: clients_create
      tags:
      - clients
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Client'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Client'
          description: ''
  /clients/{id}/:
    get:
      operationId: clients_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this client.
        required: true
      tags:
      - clients
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Client'
          description: ''
    put:
      operationId: clients_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this client.
        required: true
      tags:
      - clients
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Client'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Client'
          description: ''
    patch:
      operationId: clients_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this client.
        required: true
      tags:
      - clients
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedClient'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Client'
          description: ''
  /configurations/:
    get:
      operationId: configurations_list
      parameters:
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      tags:
      - configurations
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedConfigurationSerializerV2List'
          description: ''
  /contact_address_exports/:
    get:
      operationId: contact_address_exports_list
      description: |-
        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.

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

        Available since version 2.2.1
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - in: query
        name: address__apartment_number
        schema:
          type: string
      - name: address__apartment_number__icontains
        required: false
        in: query
        schema:
          type: string
      - name: address__apartment_number__iexact
        required: false
        in: query
        schema:
          type: string
      - name: address__apartment_number__iregex
        required: false
        in: query
        schema:
          type: string
      - name: address__apartment_number__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: address__apartment_number__search
        required: false
        in: query
        schema:
          type: string
      - in: query
        name: address__city
        schema:
          type: string
      - name: address__city__icontains
        required: false
        in: query
        schema:
          type: string
      - name: address__city__iexact
        required: false
        in: query
        schema:
          type: string
      - name: address__city__iregex
        required: false
        in: query
        schema:
          type: string
      - name: address__city__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: address__city__search
        required: false
        in: query
        schema:
          type: string
      - in: query
        name: address__country
        schema:
          type: string
      - name: address__country__icontains
        required: false
        in: query
        schema:
          type: string
      - name: address__country__iexact
        required: false
        in: query
        schema:
          type: string
      - name: address__country__iregex
        required: false
        in: query
        schema:
          type: string
      - name: address__country__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: address__country__search
        required: false
        in: query
        schema:
          type: string
      - in: query
        name: address__country_code
        schema:
          type: string
      - name: address__country_code__icontains
        required: false
        in: query
        schema:
          type: string
      - name: address__country_code__iexact
        required: false
        in: query
        schema:
          type: string
      - name: address__country_code__iregex
        required: false
        in: query
        schema:
          type: string
      - name: address__country_code__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: address__country_code__search
        required: false
        in: query
        schema:
          type: string
      - in: query
        name: address__formatted_address
        schema:
          type: string
      - name: address__formatted_address__icontains
        required: false
        in: query
        schema:
          type: string
      - name: address__formatted_address__iexact
        required: false
        in: query
        schema:
          type: string
      - name: address__formatted_address__iregex
        required: false
        in: query
        schema:
          type: string
      - name: address__formatted_address__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: address__formatted_address__search
        required: false
        in: query
        schema:
          type: string
      - in: query
        name: address__postal_code
        schema:
          type: string
      - name: address__postal_code__icontains
        required: false
        in: query
        schema:
          type: string
      - name: address__postal_code__iexact
        required: false
        in: query
        schema:
          type: string
      - name: address__postal_code__iregex
        required: false
        in: query
        schema:
          type: string
      - name: address__postal_code__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: address__postal_code__search
        required: false
        in: query
        schema:
          type: string
      - in: query
        name: address__state
        schema:
          type: string
      - name: address__state__icontains
        required: false
        in: query
        schema:
          type: string
      - name: address__state__iexact
        required: false
        in: query
        schema:
          type: string
      - name: address__state__iregex
        required: false
        in: query
        schema:
          type: string
      - name: address__state__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: address__state__search
        required: false
        in: query
        schema:
          type: string
      - in: query
        name: address__street
        schema:
          type: string
      - name: address__street__icontains
        required: false
        in: query
        schema:
          type: string
      - name: address__street__iexact
        required: false
        in: query
        schema:
          type: string
      - name: address__street__iregex
        required: false
        in: query
        schema:
          type: string
      - name: address__street__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: address__street__search
        required: false
        in: query
        schema:
          type: string
      - in: query
        name: contact__company
        schema:
          type: string
      - name: contact__company__icontains
        required: false
        in: query
        schema:
          type: string
      - name: contact__company__iexact
        required: false
        in: query
        schema:
          type: string
      - name: contact__company__iregex
        required: false
        in: query
        schema:
          type: string
      - name: contact__company__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: contact__company__search
        required: false
        in: query
        schema:
          type: string
      - name: contact__emails__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact__emails__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact__emails__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: contact__emails__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - in: query
        name: contact__name
        schema:
          type: string
      - name: contact__name__icontains
        required: false
        in: query
        schema:
          type: string
      - name: contact__name__iexact
        required: false
        in: query
        schema:
          type: string
      - name: contact__name__iregex
        required: false
        in: query
        schema:
          type: string
      - name: contact__name__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: contact__name__search
        required: false
        in: query
        schema:
          type: string
      - in: query
        name: contact__notes
        schema:
          type: string
      - name: contact__notes__icontains
        required: false
        in: query
        schema:
          type: string
      - name: contact__notes__iexact
        required: false
        in: query
        schema:
          type: string
      - name: contact__notes__iregex
        required: false
        in: query
        schema:
          type: string
      - name: contact__notes__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: contact__notes__search
        required: false
        in: query
        schema:
          type: string
      - name: contact__phones__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact__phones__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact__phones__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: contact__phones__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: fields
        schema:
          type: string
        description: 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 will be returned
        examples:
          ExampleName:
            value: name,external_id,created_at,address__raw_address
            summary: Returns fields name, external_id, created_at and address__raw_address
              in the same order
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - xlsx
          default: json
        description: Selects response method. xlsx returns Excel file
      - in: query
        name: is_orderer
        schema:
          type: boolean
      - in: query
        name: is_receiver
        schema:
          type: boolean
      - name: metafields__namespace:key
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: source
        schema:
          type: string
      - name: source__icontains
        required: false
        in: query
        schema:
          type: string
      - name: source__iexact
        required: false
        in: query
        schema:
          type: string
      - name: source__iregex
        required: false
        in: query
        schema:
          type: string
      - name: source__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: source__search
        required: false
        in: query
        schema:
          type: string
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - contact_address_exports
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedContactAddressExportList'
            application/vnd.openxmlformats-officedocument.spreadsheetml.sheet; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedContactAddressExportList'
          description: ''
  /contact_address_import/:
    get:
      operationId: contact_address_import_list
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - name: completed_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - name: failed_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: failed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: failed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: failed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: started_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: started_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: started_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: started_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: state
        schema:
          type: string
          enum:
          - completed
          - failed
          - pending
          - started
        description: |-
          * `pending` - Pending
          * `started` - Started
          * `completed` - Completed
          * `failed` - Failed
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - contact_address_import
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedContactAddressBackgroundImportList'
          description: ''
    post:
      operationId: contact_address_import_create
      tags:
      - contact_address_import
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactAddressBackgroundImport'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/ContactAddressBackgroundImport'
          description: ''
  /contact_address_import/{id}/:
    get:
      operationId: contact_address_import_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this contact address background import.
        required: true
      tags:
      - contact_address_import
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/ContactAddressBackgroundImport'
          description: ''
  /contact_addresses/:
    get:
      operationId: contact_addresses_list
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - in: query
        name: address__apartment_number
        schema:
          type: string
      - name: address__apartment_number__icontains
        required: false
        in: query
        schema:
          type: string
      - name: address__apartment_number__iexact
        required: false
        in: query
        schema:
          type: string
      - name: address__apartment_number__iregex
        required: false
        in: query
        schema:
          type: string
      - name: address__apartment_number__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: address__apartment_number__search
        required: false
        in: query
        schema:
          type: string
      - in: query
        name: address__city
        schema:
          type: string
      - name: address__city__icontains
        required: false
        in: query
        schema:
          type: string
      - name: address__city__iexact
        required: false
        in: query
        schema:
          type: string
      - name: address__city__iregex
        required: false
        in: query
        schema:
          type: string
      - name: address__city__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: address__city__search
        required: false
        in: query
        schema:
          type: string
      - in: query
        name: address__country
        schema:
          type: string
      - name: address__country__icontains
        required: false
        in: query
        schema:
          type: string
      - name: address__country__iexact
        required: false
        in: query
        schema:
          type: string
      - name: address__country__iregex
        required: false
        in: query
        schema:
          type: string
      - name: address__country__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: address__country__search
        required: false
        in: query
        schema:
          type: string
      - in: query
        name: address__country_code
        schema:
          type: string
      - name: address__country_code__icontains
        required: false
        in: query
        schema:
          type: string
      - name: address__country_code__iexact
        required: false
        in: query
        schema:
          type: string
      - name: address__country_code__iregex
        required: false
        in: query
        schema:
          type: string
      - name: address__country_code__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: address__country_code__search
        required: false
        in: query
        schema:
          type: string
      - in: query
        name: address__formatted_address
        schema:
          type: string
      - name: address__formatted_address__icontains
        required: false
        in: query
        schema:
          type: string
      - name: address__formatted_address__iexact
        required: false
        in: query
        schema:
          type: string
      - name: address__formatted_address__iregex
        required: false
        in: query
        schema:
          type: string
      - name: address__formatted_address__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: address__formatted_address__search
        required: false
        in: query
        schema:
          type: string
      - name: address__geocode_failed_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: address__geocode_failed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: address__geocode_failed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: address__geocode_failed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: address__geocoded_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: address__geocoded_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: address__geocoded_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: address__postal_code
        schema:
          type: string
      - name: address__postal_code__icontains
        required: false
        in: query
        schema:
          type: string
      - name: address__postal_code__iexact
        required: false
        in: query
        schema:
          type: string
      - name: address__postal_code__iregex
        required: false
        in: query
        schema:
          type: string
      - name: address__postal_code__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: address__postal_code__search
        required: false
        in: query
        schema:
          type: string
      - in: query
        name: address__state
        schema:
          type: string
      - name: address__state__icontains
        required: false
        in: query
        schema:
          type: string
      - name: address__state__iexact
        required: false
        in: query
        schema:
          type: string
      - name: address__state__iregex
        required: false
        in: query
        schema:
          type: string
      - name: address__state__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: address__state__search
        required: false
        in: query
        schema:
          type: string
      - in: query
        name: address__street
        schema:
          type: string
      - name: address__street__icontains
        required: false
        in: query
        schema:
          type: string
      - name: address__street__iexact
        required: false
        in: query
        schema:
          type: string
      - name: address__street__iregex
        required: false
        in: query
        schema:
          type: string
      - name: address__street__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: address__street__search
        required: false
        in: query
        schema:
          type: string
      - in: query
        name: client
        schema:
          type: string
          format: uuid
      - in: query
        name: contact__company
        schema:
          type: string
      - name: contact__company__icontains
        required: false
        in: query
        schema:
          type: string
      - name: contact__company__iexact
        required: false
        in: query
        schema:
          type: string
      - name: contact__company__iregex
        required: false
        in: query
        schema:
          type: string
      - name: contact__company__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: contact__company__search
        required: false
        in: query
        schema:
          type: string
      - name: contact__emails__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact__emails__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact__emails__icontains
        required: false
        in: query
        schema:
          type: string
      - name: contact__emails__iexact
        required: false
        in: query
        schema:
          type: string
      - name: contact__emails__iregex
        required: false
        in: query
        schema:
          type: string
      - name: contact__emails__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: contact__emails__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: contact__emails__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact__emails__search
        required: false
        in: query
        schema:
          type: string
      - in: query
        name: contact__name
        schema:
          type: string
      - name: contact__name__icontains
        required: false
        in: query
        schema:
          type: string
      - name: contact__name__iexact
        required: false
        in: query
        schema:
          type: string
      - name: contact__name__iregex
        required: false
        in: query
        schema:
          type: string
      - name: contact__name__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: contact__name__search
        required: false
        in: query
        schema:
          type: string
      - in: query
        name: contact__notes
        schema:
          type: string
      - name: contact__notes__icontains
        required: false
        in: query
        schema:
          type: string
      - name: contact__notes__iexact
        required: false
        in: query
        schema:
          type: string
      - name: contact__notes__iregex
        required: false
        in: query
        schema:
          type: string
      - name: contact__notes__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: contact__notes__search
        required: false
        in: query
        schema:
          type: string
      - name: contact__phones__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact__phones__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact__phones__icontains
        required: false
        in: query
        schema:
          type: string
      - name: contact__phones__iexact
        required: false
        in: query
        schema:
          type: string
      - name: contact__phones__iregex
        required: false
        in: query
        schema:
          type: string
      - name: contact__phones__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: contact__phones__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: contact__phones__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact__phones__search
        required: false
        in: query
        schema:
          type: string
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: is_orderer
        schema:
          type: boolean
      - in: query
        name: is_receiver
        schema:
          type: boolean
      - name: metafields__namespace:key
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: source
        schema:
          type: string
      - name: source__icontains
        required: false
        in: query
        schema:
          type: string
      - name: source__iexact
        required: false
        in: query
        schema:
          type: string
      - name: source__iregex
        required: false
        in: query
        schema:
          type: string
      - name: source__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: source__search
        required: false
        in: query
        schema:
          type: string
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - contact_addresses
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedContactAddressList'
          description: ''
    post:
      operationId: contact_addresses_create
      tags:
      - contact_addresses
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactAddress'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/ContactAddress'
          description: ''
  /contact_addresses/{id}/:
    get:
      operationId: contact_addresses_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this contact address.
        required: true
      tags:
      - contact_addresses
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/ContactAddress'
          description: ''
    put:
      operationId: contact_addresses_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this contact address.
        required: true
      tags:
      - contact_addresses
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactAddress'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/ContactAddress'
          description: ''
    patch:
      operationId: contact_addresses_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this contact address.
        required: true
      tags:
      - contact_addresses
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedContactAddress'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/ContactAddress'
          description: ''
  /devices/:
    get:
      operationId: devices_list
      parameters:
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - accounts
            - users
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: accounts,users
            summary: Regular sideloading
      - in: query
        name: user
        schema:
          type: string
          format: uuid
      - in: query
        name: user__account_roles__account
        schema:
          type: string
          format: uuid
      tags:
      - devices
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedDeviceList'
          description: ''
    post:
      operationId: devices_create
      tags:
      - devices
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Device'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Device'
          description: ''
  /devices/{id}/:
    get:
      operationId: devices_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this device.
        required: true
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - accounts
            - users
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: accounts,users
            summary: Regular sideloading
      tags:
      - devices
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Device'
          description: ''
  /docs/schema/:
    get:
      operationId: docs_schema_retrieve
      description: |-
        Cached version of SpectacularAPIView that includes API version in cache key.

        Cache is controlled by ``OPENAPI_SCHEMA_CACHE_TIMEOUT`` (seconds). Set to ``0``
        to disable caching (useful in local development). When enabled, cache is
        invalidated when:
        - API version in settings.REST_FRAMEWORK['CURRENT_VERSION'] changes
        - settings.RELEASE changes (CalVer tag or git SHA of the running image)
        - Accept or Accept-Language headers change
        - The configured timeout elapses
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - yaml
      - in: query
        name: lang
        schema:
          type: string
          enum:
          - de
          - en
          - es
          - et
          - fi
          - fr
          - it
          - lt
          - lv
          - pl
          - ru
          - sv
      tags:
      - docs
      security:
      - tokenAuth: []
      - {}
      responses:
        '200':
          content:
            application/vnd.oai.openapi; version=2.11.9:
              schema:
                type: object
                additionalProperties: {}
            application/yaml; version=2.11.9:
              schema:
                type: object
                additionalProperties: {}
            application/vnd.oai.openapi+json; version=2.11.9:
              schema:
                type: object
                additionalProperties: {}
            application/json; version=2.11.9:
              schema:
                type: object
                additionalProperties: {}
          description: ''
  /documents/:
    get:
      operationId: documents_list
      parameters:
      - name: account
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: account__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: contact_address
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: contact_address__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_by
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: created_by__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: filename
        schema:
          type: string
      - name: filename__icontains
        required: false
        in: query
        schema:
          type: string
      - name: filename__iexact
        required: false
        in: query
        schema:
          type: string
      - name: filename__iregex
        required: false
        in: query
        schema:
          type: string
      - name: filename__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: filename__search
        required: false
        in: query
        schema:
          type: string
      - in: query
        name: mimetype
        schema:
          type: string
      - name: order
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: order__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: source
        schema:
          type: string
          nullable: true
          enum:
          - integration
          - mobile
          - web
        description: |-
          * `web` - Web
          * `mobile` - Mobile
          * `integration` - Integration
      - name: task
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: task__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - documents
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedDocumentList'
          description: ''
    post:
      operationId: documents_create
      tags:
      - documents
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Document'
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Document'
          description: ''
  /documents/{id}/:
    get:
      operationId: documents_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this document.
        required: true
      tags:
      - documents
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Document'
          description: ''
    put:
      operationId: documents_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this document.
        required: true
      tags:
      - documents
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentUpdate'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/DocumentUpdate'
          description: ''
    patch:
      operationId: documents_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this document.
        required: true
      tags:
      - documents
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedDocumentUpdate'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/DocumentUpdate'
          description: ''
    delete:
      operationId: documents_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this document.
        required: true
      tags:
      - documents
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /documents/batch_delete/:
    post:
      operationId: documents_batch_delete_create
      description: Available from version 2.4.2
      tags:
      - documents
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentDeleteAction'
        required: true
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /emails/:
    get:
      operationId: emails_list
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: external_id
        schema:
          type: string
      - in: query
        name: external_id__icontains
        schema:
          type: string
      - name: failed_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: failed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: failed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: failed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: from_email
        schema:
          type: string
      - in: query
        name: from_email__icontains
        schema:
          type: string
      - in: query
        name: id
        schema:
          type: string
          format: uuid
      - in: query
        name: message
        schema:
          type: string
      - in: query
        name: message__icontains
        schema:
          type: string
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: received_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: received_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: received_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: received_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: received_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: received_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: received_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: received_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: received_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: received_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: received_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: reply_to_email
        schema:
          type: string
      - in: query
        name: reply_to_email__icontains
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - name: sent_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: sent_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: sent_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: sent_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: sent_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: sent_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: sent_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: sent_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: sent_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: sent_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: sent_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: state
        schema:
          type: string
          enum:
          - failed
          - over_quota
          - queued
          - received
          - sent
        description: |-
          * `queued` - Queued
          * `over_quota` - Over quota
          * `sent` - Sent
          * `failed` - Failed
          * `received` - Received
      - in: query
        name: state__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: subject
        schema:
          type: string
      - in: query
        name: subject__icontains
        schema:
          type: string
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - emails
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedEmailList'
          description: ''
    post:
      operationId: emails_create
      tags:
      - emails
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Email'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Email'
          description: ''
  /emails/{id}/:
    get:
      operationId: emails_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this email.
        required: true
      tags:
      - emails
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Email'
          description: ''
  /emails/{id}/resend/:
    post:
      operationId: emails_resend_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this email.
        required: true
      tags:
      - emails
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Email'
          description: ''
  /exports/:
    get:
      operationId: exports_list
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - xlsx
        description: |-
          * `json` - JSON
          * `xlsx` - XLSX
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - exports
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedExportList'
          description: ''
    post:
      operationId: exports_create
      tags:
      - exports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Export'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Export'
          description: ''
  /exports/{id}/:
    get:
      operationId: exports_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this export.
        required: true
      tags:
      - exports
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Export'
          description: ''
    put:
      operationId: exports_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this export.
        required: true
      tags:
      - exports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Export'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Export'
          description: ''
    patch:
      operationId: exports_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this export.
        required: true
      tags:
      - exports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedExport'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Export'
          description: ''
    delete:
      operationId: exports_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this export.
        required: true
      tags:
      - exports
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /file_uploads/:
    get:
      operationId: file_uploads_list
      parameters:
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_by
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: created_by__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: filename
        schema:
          type: string
      - name: filename__icontains
        required: false
        in: query
        schema:
          type: string
      - name: filename__iexact
        required: false
        in: query
        schema:
          type: string
      - name: filename__iregex
        required: false
        in: query
        schema:
          type: string
      - name: filename__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: filename__search
        required: false
        in: query
        schema:
          type: string
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: source
        schema:
          type: string
          nullable: true
          enum:
          - integration
          - mobile
          - tracker-logs
          - web
        description: |-
          * `web` - Web
          * `mobile` - Mobile
          * `integration` - Integration
          * `tracker-logs` - Tracker logs
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - file_uploads
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedS3FileUploadList'
          description: ''
    post:
      operationId: file_uploads_create
      tags:
      - file_uploads
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/S3FileUpload'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/S3FileUpload'
          description: ''
  /file_uploads/{id}/:
    get:
      operationId: file_uploads_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this file upload.
        required: true
      tags:
      - file_uploads
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/S3FileUpload'
          description: ''
  /form_fields/:
    get:
      operationId: form_fields_list
      parameters:
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: field_type
        schema:
          type: string
          enum:
          - array
          - boolean
          - decimal
          - integer
          - multi_select
          - single_select
          - text_area
          - text_input
        description: |-
          * `text_input` - Text input
          * `text_area` - Text area
          * `boolean` - Boolean
          * `single_select` - Single select
          * `multi_select` - Multi select
          * `array` - Array
          * `integer` - Integer
          * `decimal` - Decimal
      - in: query
        name: form
        schema:
          type: string
          format: uuid
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: parent_field
        schema:
          type: string
          format: uuid
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - form_fields
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedFormFieldList'
          description: ''
    post:
      operationId: form_fields_create
      tags:
      - form_fields
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FormField'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/FormField'
          description: ''
  /form_fields/{id}/:
    get:
      operationId: form_fields_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this form field.
        required: true
      tags:
      - form_fields
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/FormField'
          description: ''
    put:
      operationId: form_fields_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this form field.
        required: true
      tags:
      - form_fields
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FormField'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/FormField'
          description: ''
    patch:
      operationId: form_fields_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this form field.
        required: true
      tags:
      - form_fields
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedFormField'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/FormField'
          description: ''
    delete:
      operationId: form_fields_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this form field.
        required: true
      tags:
      - form_fields
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /form_responses/:
    get:
      operationId: form_responses_list
      parameters:
      - in: query
        name: completed_by
        schema:
          type: string
          format: uuid
      - in: query
        name: completed_by__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: created_by
        schema:
          type: string
          format: uuid
      - in: query
        name: created_by__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: form
        schema:
          type: string
          format: uuid
      - in: query
        name: form__account
        schema:
          type: string
          format: uuid
      - in: query
        name: form__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - completed_bys
            - created_bys
            - forms
            - users
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: forms,created_bys
            summary: Regular sideloading
          MultiSourceSideloadingForUsers:
            value: users[created_bys,completed_bys]
            summary: Multi source sideloading for users
      - in: query
        name: state
        schema:
          type: string
          enum:
          - completed
          - draft
        description: |-
          * `draft` - Draft
          * `completed` - Completed
      - in: query
        name: state__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: task
        schema:
          type: string
          format: uuid
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - form_responses
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedFormResponseList'
          description: ''
    post:
      operationId: form_responses_create
      tags:
      - form_responses
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FormResponse'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/FormResponse'
          description: ''
  /form_responses/{id}/:
    get:
      operationId: form_responses_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this form response.
        required: true
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - completed_bys
            - created_bys
            - forms
            - users
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: forms,created_bys
            summary: Regular sideloading
          MultiSourceSideloadingForUsers:
            value: users[created_bys,completed_bys]
            summary: Multi source sideloading for users
      tags:
      - form_responses
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/FormResponse'
          description: ''
    patch:
      operationId: form_responses_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this form response.
        required: true
      tags:
      - form_responses
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedFormResponse'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/FormResponse'
          description: ''
    delete:
      operationId: form_responses_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this form response.
        required: true
      tags:
      - form_responses
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /form_responses/{id}/complete/:
    post:
      operationId: form_responses_complete_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this form response.
        required: true
      tags:
      - form_responses
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/FormResponse'
          description: Form response completed.
        '400':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/FormResponseCompleteError'
              examples:
                AlreadyCompleted:
                  value:
                    non_field_errors:
                    - 'Cannot complete form response: current state is ''completed''.'
                  summary: Already completed
          description: Form response cannot be completed from its current state.
        '409':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/FormResponseCompleteError'
              examples:
                LockConflict:
                  value:
                    non_field_errors:
                    - Could not obtain lock for FormResponse object. Try again later.
                  summary: Lock conflict
          description: Form response is locked by another request.
  /form_rules/:
    get:
      operationId: form_rules_list
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: form
        schema:
          type: string
          format: uuid
      - in: query
        name: open_in
        schema:
          type: string
          enum:
          - in-app-browser
          - webview
        description: |-
          * `webview` - Webview
          * `in-app-browser` - In app browser
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - form_rules
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedFormRuleList'
          description: ''
    post:
      operationId: form_rules_create
      tags:
      - form_rules
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FormRule'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/FormRule'
          description: ''
  /form_rules/{id}/:
    get:
      operationId: form_rules_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this form rule.
        required: true
      tags:
      - form_rules
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/FormRule'
          description: ''
    put:
      operationId: form_rules_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this form rule.
        required: true
      tags:
      - form_rules
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FormRule'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/FormRule'
          description: ''
    patch:
      operationId: form_rules_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this form rule.
        required: true
      tags:
      - form_rules
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedFormRule'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/FormRule'
          description: ''
    delete:
      operationId: form_rules_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this form rule.
        required: true
      tags:
      - form_rules
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /forms/:
    get:
      operationId: forms_list
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: created_by
        schema:
          type: string
          format: uuid
      - in: query
        name: created_by__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: form_rules__is_active
        schema:
          type: boolean
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - form_fields
            - form_rules
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: form_fields,form_rules
            summary: Regular sideloading
      - name: status__in
        required: false
        in: query
        description: 'Filter by status: active, inactive (comma-separated).'
        schema:
          type: string
          enum:
          - active
          - inactive
        style: form
        explode: false
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - forms
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedFormList'
          description: ''
    post:
      operationId: forms_create
      tags:
      - forms
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Form'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Form'
          description: ''
  /forms/{id}/:
    get:
      operationId: forms_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this form.
        required: true
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - form_fields
            - form_rules
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: form_fields,form_rules
            summary: Regular sideloading
      tags:
      - forms
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Form'
          description: ''
    put:
      operationId: forms_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this form.
        required: true
      tags:
      - forms
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Form'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Form'
          description: ''
    patch:
      operationId: forms_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this form.
        required: true
      tags:
      - forms
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedForm'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Form'
          description: ''
    delete:
      operationId: forms_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this form.
        required: true
      tags:
      - forms
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /integrations/:
    post:
      operationId: integrations_create
      tags:
      - integrations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IntegrationRequest'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/IntegrationRequest'
          description: ''
  /logout/:
    post:
      operationId: logout_create
      tags:
      - logout
      security:
      - tokenAuth: []
      responses:
        '201':
          description: No response body
  /metafields/:
    get:
      operationId: metafields_list
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - in: query
        name: applies_to
        schema:
          type: string
          enum:
          - contact_addresses
          - routes
          - tasks
        description: |-
          What model this metafield applies to

          * `tasks` - Tasks
          * `routes` - Routes
          * `contact_addresses` - Contact Addresses
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: hide_when_empty
        schema:
          type: boolean
      - in: query
        name: is_editable
        schema:
          type: boolean
      - in: query
        name: is_editable_assignee
        schema:
          type: boolean
      - in: query
        name: is_persistent
        schema:
          type: boolean
      - in: query
        name: is_required
        schema:
          type: boolean
      - in: query
        name: is_searchable
        schema:
          type: boolean
      - in: query
        name: key
        schema:
          type: string
      - in: query
        name: label
        schema:
          type: string
      - in: query
        name: namespace
        schema:
          type: string
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: show_in_detail_view
        schema:
          type: boolean
      - in: query
        name: show_in_list_view
        schema:
          type: boolean
      - in: query
        name: show_in_mobile_app
        schema:
          type: boolean
      - in: query
        name: show_in_pod
        schema:
          type: boolean
      - in: query
        name: show_when_task_type_assignment
        schema:
          type: boolean
      - in: query
        name: show_when_task_type_drop_off
        schema:
          type: boolean
      - in: query
        name: show_when_task_type_pick_up
        schema:
          type: boolean
      - in: query
        name: source
        schema:
          type: string
          format: uuid
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: value_type
        schema:
          type: string
          enum:
          - assignee
          - choice
          - decimal
          - integer
          - json
          - link
          - multiselect
          - string
          - text
        description: |-
          * `string` - String
          * `integer` - Integer
          * `decimal` - Decimal
          * `choice` - Choice
          * `link` - Link
          * `assignee` - Assignee
          * `json` - JSON
          * `multiselect` - Multiselect
          * `text` - Text
      tags:
      - metafields
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedMetafieldList'
          description: ''
    post:
      operationId: metafields_create
      tags:
      - metafields
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Metafield'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Metafield'
          description: ''
  /metafields/{id}/:
    get:
      operationId: metafields_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this metafield.
        required: true
      tags:
      - metafields
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Metafield'
          description: ''
    put:
      operationId: metafields_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this metafield.
        required: true
      tags:
      - metafields
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Metafield'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Metafield'
          description: ''
    patch:
      operationId: metafields_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this metafield.
        required: true
      tags:
      - metafields
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedMetafield'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Metafield'
          description: ''
    delete:
      operationId: metafields_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this metafield.
        required: true
      tags:
      - metafields
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /notification_templates/:
    get:
      operationId: notification_templates_list
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: event
        schema:
          type: string
          enum:
          - accept
          - activate
          - assign
          - assignee_away
          - assignee_near
          - cancel
          - complete
          - create
          - fail
          - reject
          - restart
          - transit
          - unaccept
          - unassign
          - updated
        description: |-
          * `create` - Create
          * `assign` - Assign
          * `unassign` - Unassign
          * `reject` - Reject
          * `restart` - Restart
          * `accept` - Accept
          * `unaccept` - Unaccept
          * `transit` - Transit
          * `activate` - Activate
          * `complete` - Complete
          * `fail` - Fail
          * `cancel` - Cancel
          * `assignee_near` - Assignee near
          * `assignee_away` - Assignee away
          * `updated` - Updated
      - in: query
        name: is_active
        schema:
          type: boolean
      - in: query
        name: name
        schema:
          type: string
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: recipient
        schema:
          type: string
          nullable: true
          enum:
          - account
          - assignee
          - client
          - contact
          - orderer
        description: |-
          * `account` - Account
          * `assignee` - Assignee
          * `orderer` - Orderer
          * `contact` - Contact
          * `client` - Client
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: via_app
        schema:
          type: boolean
      - in: query
        name: via_email
        schema:
          type: boolean
      - in: query
        name: via_sms
        schema:
          type: boolean
      tags:
      - notification_templates
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedNotificationTemplateList'
          description: ''
    post:
      operationId: notification_templates_create
      tags:
      - notification_templates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationTemplate'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
          description: ''
  /notification_templates/{id}/:
    get:
      operationId: notification_templates_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this notification template.
        required: true
      tags:
      - notification_templates
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
          description: ''
    put:
      operationId: notification_templates_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this notification template.
        required: true
      tags:
      - notification_templates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationTemplate'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
          description: ''
    patch:
      operationId: notification_templates_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this notification template.
        required: true
      tags:
      - notification_templates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedNotificationTemplate'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
          description: ''
    delete:
      operationId: notification_templates_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this notification template.
        required: true
      tags:
      - notification_templates
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /notification_templates/{id}/render/:
    post:
      operationId: notification_templates_render_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this notification template.
        required: true
      tags:
      - notification_templates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RenderRequest'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/RenderResponse'
          description: ''
  /notifications/:
    get:
      operationId: notifications_list
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: event
        schema:
          type: string
          nullable: true
          enum:
          - accept
          - activate
          - assign
          - assignee_away
          - assignee_near
          - cancel
          - complete
          - create
          - fail
          - reject
          - restart
          - transit
          - unaccept
          - unassign
          - updated
        description: |-
          * `create` - Create
          * `assign` - Assign
          * `unassign` - Unassign
          * `reject` - Reject
          * `restart` - Restart
          * `accept` - Accept
          * `unaccept` - Unaccept
          * `transit` - Transit
          * `activate` - Activate
          * `complete` - Complete
          * `fail` - Fail
          * `cancel` - Cancel
          * `assignee_near` - Assignee near
          * `assignee_away` - Assignee away
          * `updated` - Updated
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: recipient
        schema:
          type: string
          nullable: true
          enum:
          - account
          - assignee
          - client
          - contact
          - orderer
        description: |-
          * `account` - Account
          * `assignee` - Assignee
          * `orderer` - Orderer
          * `contact` - Contact
          * `client` - Client
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - name: sent_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: sent_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: sent_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: sent_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: sent_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: sent_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: sent_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: sent_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: sent_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: sent_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: sent_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - tasks
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: tasks
            summary: Regular sideloading
      - in: query
        name: task
        schema:
          type: string
          format: uuid
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: via_app
        schema:
          type: boolean
      - in: query
        name: via_email
        schema:
          type: boolean
      - in: query
        name: via_sms
        schema:
          type: boolean
      tags:
      - notifications
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedNotificationList'
          description: ''
    post:
      operationId: notifications_create
      tags:
      - notifications
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Notification'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Notification'
          description: ''
  /notifications/{id}/:
    get:
      operationId: notifications_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this notification.
        required: true
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - tasks
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: tasks
            summary: Regular sideloading
      tags:
      - notifications
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Notification'
          description: ''
  /orders/:
    get:
      operationId: orders_list
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: external_id
        schema:
          type: string
      - in: query
        name: id
        schema:
          type: string
          format: uuid
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: reference
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - assignees
            - clients
            - documents
            - signatures
            - tasks
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: clients,tasks
            summary: Regular sideloading
          MultiSourceSideloadingForDocuments:
            value: documents[documents,tasks__documents,recurrence__documents,tasks__contact_address__documents]
            summary: Multi source sideloading for documents
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - orders
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedOrderSerializerV2List'
          description: ''
    post:
      operationId: orders_create
      tags:
      - orders
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderSerializerV2'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/OrderSerializerV2'
          description: ''
  /orders/{id}/:
    get:
      operationId: orders_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this order.
        required: true
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - assignees
            - clients
            - documents
            - signatures
            - tasks
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: clients,tasks
            summary: Regular sideloading
          MultiSourceSideloadingForDocuments:
            value: documents[documents,tasks__documents,recurrence__documents,tasks__contact_address__documents]
            summary: Multi source sideloading for documents
      tags:
      - orders
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/OrderSerializerV2'
          description: ''
    put:
      operationId: orders_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this order.
        required: true
      tags:
      - orders
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderSerializerV2'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/OrderSerializerV2'
          description: ''
    patch:
      operationId: orders_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this order.
        required: true
      tags:
      - orders
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedOrderSerializerV2'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/OrderSerializerV2'
          description: ''
  /password_change/:
    post:
      operationId: password_change_create
      tags:
      - password_change
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordChange'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PasswordChange'
          description: ''
  /password_reset/:
    post:
      operationId: password_reset_create
      tags:
      - password_reset
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordReset'
        required: true
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PasswordReset'
          description: ''
  /password_reset_confirm/:
    post:
      operationId: password_reset_confirm_create
      tags:
      - password_reset_confirm
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordResetConfirm'
        required: true
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PasswordResetConfirm'
          description: ''
  /push_notifications/:
    get:
      operationId: push_notifications_list
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: event
        schema:
          type: string
          nullable: true
          enum:
          - accept
          - activate
          - assign
          - assignee_away
          - assignee_near
          - cancel
          - complete
          - create
          - fail
          - reject
          - restart
          - transit
          - unaccept
          - unassign
          - updated
        description: |-
          * `create` - Create
          * `assign` - Assign
          * `unassign` - Unassign
          * `reject` - Reject
          * `restart` - Restart
          * `accept` - Accept
          * `unaccept` - Unaccept
          * `transit` - Transit
          * `activate` - Activate
          * `complete` - Complete
          * `fail` - Fail
          * `cancel` - Cancel
          * `assignee_near` - Assignee near
          * `assignee_away` - Assignee away
          * `updated` - Updated
      - in: query
        name: event__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: external_id
        schema:
          type: string
          format: uuid
      - in: query
        name: external_id__icontains
        schema:
          type: string
          format: uuid
      - name: failed_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: failed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: failed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: failed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: id
        schema:
          type: string
          format: uuid
      - in: query
        name: message
        schema:
          type: string
      - in: query
        name: message__icontains
        schema:
          type: string
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: pending_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: pending_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: pending_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: pending_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: pending_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: pending_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: pending_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: pending_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: pending_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: pending_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: pending_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: state
        schema:
          type: string
          enum:
          - failed
          - pending
          - queued
          - sent
        description: |-
          * `queued` - Queued
          * `pending` - Pending
          * `failed` - Failed
          * `sent` - Sent
      - in: query
        name: state__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: subject
        schema:
          type: string
      - in: query
        name: subject__icontains
        schema:
          type: string
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:22+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - push_notifications
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedPushNotificationList'
          description: ''
    post:
      operationId: push_notifications_create
      tags:
      - push_notifications
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PushNotification'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PushNotification'
          description: ''
  /push_notifications/{id}/:
    get:
      operationId: push_notifications_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this push notification.
        required: true
      tags:
      - push_notifications
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PushNotification'
          description: ''
  /push_notifications/{id}/resend/:
    post:
      operationId: push_notifications_resend_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this push notification.
        required: true
      tags:
      - push_notifications
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PushNotification'
          description: ''
  /recurrences/:
    get:
      operationId: recurrences_list
      parameters:
      - name: account
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: account__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: assign_worker
        required: false
        in: query
        description: Old implementation, indicating weather the task will be assigned
          to an assignee on recurrence
        example: true
        schema:
          type: boolean
      - name: assignee
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: assignee__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_by
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: created_by__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: is_active
        schema:
          type: boolean
      - name: last_errored_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: last_errored_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: last_errored_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: last_errored_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_errored_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_errored_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_errored_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_errored_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_errored_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_errored_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_errored_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_recurred_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: last_recurred_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: last_recurred_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: last_recurred_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_recurred_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_recurred_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_recurred_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_recurred_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_recurred_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_recurred_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_recurred_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_scheduled_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: last_scheduled_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: last_scheduled_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: last_scheduled_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_scheduled_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_scheduled_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_scheduled_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_scheduled_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_scheduled_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_scheduled_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_scheduled_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: next_scheduled_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: next_scheduled_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: next_scheduled_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: next_scheduled_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: next_scheduled_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: next_scheduled_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: next_scheduled_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: next_scheduled_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: next_scheduled_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: next_scheduled_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: next_scheduled_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - documents
            - orders
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: orders,documents
            summary: Regular sideloading
      - name: tasks_data__address__formatted_address__exact
        required: false
        in: query
        example: some_value
        schema:
          type: string
          format: string
      - name: tasks_data__address__formatted_address__icontains
        required: false
        in: query
        example: some_value
        schema:
          type: string
          format: string
      - name: tasks_data__address__formatted_address__in
        required: false
        in: query
        example: some_value
        schema:
          type: string
          format: string
      - name: tasks_data__category__exact
        required: false
        in: query
        example: some_value
        schema:
          type: string
          format: string
      - name: tasks_data__category__in
        required: false
        in: query
        example: some_value
        schema:
          type: string
          format: string
      - name: tasks_data__contact__company__exact
        required: false
        in: query
        example: some_value
        schema:
          type: string
          format: string
      - name: tasks_data__contact__company__icontains
        required: false
        in: query
        example: some_value
        schema:
          type: string
          format: string
      - name: tasks_data__contact__company__in
        required: false
        in: query
        example: some_value
        schema:
          type: string
          format: string
      - name: tasks_data__contact__emails__contains
        required: false
        in: query
        example: some_value
        schema:
          type: string
          format: string
      - name: tasks_data__contact__emails__isnull
        required: false
        in: query
        example: some_value
        schema:
          type: string
          format: string
      - name: tasks_data__contact__name__exact
        required: false
        in: query
        example: some_value
        schema:
          type: string
          format: string
      - name: tasks_data__contact__name__icontains
        required: false
        in: query
        example: some_value
        schema:
          type: string
          format: string
      - name: tasks_data__contact__name__in
        required: false
        in: query
        example: some_value
        schema:
          type: string
          format: string
      - name: tasks_data__contact__notes__exact
        required: false
        in: query
        example: some_value
        schema:
          type: string
          format: string
      - name: tasks_data__contact__notes__icontains
        required: false
        in: query
        example: some_value
        schema:
          type: string
          format: string
      - name: tasks_data__contact__phones__contains
        required: false
        in: query
        example: some_value
        schema:
          type: string
          format: string
      - name: tasks_data__contact__phones__isnull
        required: false
        in: query
        example: some_value
        schema:
          type: string
          format: string
      - name: tasks_data__description__icontains
        required: false
        in: query
        example: some_value
        schema:
          type: string
          format: string
      - name: tasks_data__state__exact
        required: false
        in: query
        example: some_value
        schema:
          type: string
          format: string
      - name: tasks_data__state__in
        required: false
        in: query
        example: some_value
        schema:
          type: string
          format: string
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - recurrences
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedRecurrenceList'
          description: ''
    post:
      operationId: recurrences_create
      tags:
      - recurrences
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Recurrence'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Recurrence'
          description: ''
  /recurrences/{id}/:
    get:
      operationId: recurrences_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this recurrence.
        required: true
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - documents
            - orders
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: orders,documents
            summary: Regular sideloading
      tags:
      - recurrences
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Recurrence'
          description: ''
    put:
      operationId: recurrences_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this recurrence.
        required: true
      tags:
      - recurrences
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Recurrence'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Recurrence'
          description: ''
    patch:
      operationId: recurrences_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this recurrence.
        required: true
      tags:
      - recurrences
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedRecurrence'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Recurrence'
          description: ''
  /register/:
    post:
      operationId: register_create
      tags:
      - register
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Registration'
        required: true
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Registration'
          description: ''
  /reports/tasks/states_count/:
    get:
      operationId: reports_tasks_states_count_retrieve
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
        required: true
      - in: query
        name: assignee
        schema:
          type: string
          format: uuid
      - in: query
        name: assignee__in
        schema:
          type: string
        description: User UUID-s list. Comma separated value
        examples:
          Example:
            value: 6864d3d2-3a2b-4f99-a431-420d75aa9477,bb6ce238-0e99-4b46-bdc4-6936a846d4c3
            summary: example
      - in: query
        name: date_from
        schema:
          type: string
          format: date
        required: true
        examples:
          DateFrom:
            value: '2022-05-24'
            summary: date_from
      - in: query
        name: date_until
        schema:
          type: string
          format: date
        required: true
        examples:
          DateUntil:
            value: '2022-05-24'
            summary: date_until
      - in: query
        name: timezone
        schema:
          type: string
          enum:
          - Africa/Abidjan
          - Africa/Accra
          - Africa/Addis_Ababa
          - Africa/Algiers
          - Africa/Asmara
          - Africa/Asmera
          - Africa/Bamako
          - Africa/Bangui
          - Africa/Banjul
          - Africa/Bissau
          - Africa/Blantyre
          - Africa/Brazzaville
          - Africa/Bujumbura
          - Africa/Cairo
          - Africa/Casablanca
          - Africa/Ceuta
          - Africa/Conakry
          - Africa/Dakar
          - Africa/Dar_es_Salaam
          - Africa/Djibouti
          - Africa/Douala
          - Africa/El_Aaiun
          - Africa/Freetown
          - Africa/Gaborone
          - Africa/Harare
          - Africa/Johannesburg
          - Africa/Juba
          - Africa/Kampala
          - Africa/Khartoum
          - Africa/Kigali
          - Africa/Kinshasa
          - Africa/Lagos
          - Africa/Libreville
          - Africa/Lome
          - Africa/Luanda
          - Africa/Lubumbashi
          - Africa/Lusaka
          - Africa/Malabo
          - Africa/Maputo
          - Africa/Maseru
          - Africa/Mbabane
          - Africa/Mogadishu
          - Africa/Monrovia
          - Africa/Nairobi
          - Africa/Ndjamena
          - Africa/Niamey
          - Africa/Nouakchott
          - Africa/Ouagadougou
          - Africa/Porto-Novo
          - Africa/Sao_Tome
          - Africa/Timbuktu
          - Africa/Tripoli
          - Africa/Tunis
          - Africa/Windhoek
          - America/Adak
          - America/Anchorage
          - America/Anguilla
          - America/Antigua
          - America/Araguaina
          - America/Argentina/Buenos_Aires
          - America/Argentina/Catamarca
          - America/Argentina/ComodRivadavia
          - America/Argentina/Cordoba
          - America/Argentina/Jujuy
          - America/Argentina/La_Rioja
          - America/Argentina/Mendoza
          - America/Argentina/Rio_Gallegos
          - America/Argentina/Salta
          - America/Argentina/San_Juan
          - America/Argentina/San_Luis
          - America/Argentina/Tucuman
          - America/Argentina/Ushuaia
          - America/Aruba
          - America/Asuncion
          - America/Atikokan
          - America/Atka
          - America/Bahia
          - America/Bahia_Banderas
          - America/Barbados
          - America/Belem
          - America/Belize
          - America/Blanc-Sablon
          - America/Boa_Vista
          - America/Bogota
          - America/Boise
          - America/Buenos_Aires
          - America/Cambridge_Bay
          - America/Campo_Grande
          - America/Cancun
          - America/Caracas
          - America/Catamarca
          - America/Cayenne
          - America/Cayman
          - America/Chicago
          - America/Chihuahua
          - America/Ciudad_Juarez
          - America/Coral_Harbour
          - America/Cordoba
          - America/Costa_Rica
          - America/Coyhaique
          - America/Creston
          - America/Cuiaba
          - America/Curacao
          - America/Danmarkshavn
          - America/Dawson
          - America/Dawson_Creek
          - America/Denver
          - America/Detroit
          - America/Dominica
          - America/Edmonton
          - America/Eirunepe
          - America/El_Salvador
          - America/Ensenada
          - America/Fort_Nelson
          - America/Fort_Wayne
          - America/Fortaleza
          - America/Glace_Bay
          - America/Godthab
          - America/Goose_Bay
          - America/Grand_Turk
          - America/Grenada
          - America/Guadeloupe
          - America/Guatemala
          - America/Guayaquil
          - America/Guyana
          - America/Halifax
          - America/Havana
          - America/Hermosillo
          - America/Indiana/Indianapolis
          - America/Indiana/Knox
          - America/Indiana/Marengo
          - America/Indiana/Petersburg
          - America/Indiana/Tell_City
          - America/Indiana/Vevay
          - America/Indiana/Vincennes
          - America/Indiana/Winamac
          - America/Indianapolis
          - America/Inuvik
          - America/Iqaluit
          - America/Jamaica
          - America/Jujuy
          - America/Juneau
          - America/Kentucky/Louisville
          - America/Kentucky/Monticello
          - America/Knox_IN
          - America/Kralendijk
          - America/La_Paz
          - America/Lima
          - America/Los_Angeles
          - America/Louisville
          - America/Lower_Princes
          - America/Maceio
          - America/Managua
          - America/Manaus
          - America/Marigot
          - America/Martinique
          - America/Matamoros
          - America/Mazatlan
          - America/Mendoza
          - America/Menominee
          - America/Merida
          - America/Metlakatla
          - America/Mexico_City
          - America/Miquelon
          - America/Moncton
          - America/Monterrey
          - America/Montevideo
          - America/Montreal
          - America/Montserrat
          - America/Nassau
          - America/New_York
          - America/Nipigon
          - America/Nome
          - America/Noronha
          - America/North_Dakota/Beulah
          - America/North_Dakota/Center
          - America/North_Dakota/New_Salem
          - America/Nuuk
          - America/Ojinaga
          - America/Panama
          - America/Pangnirtung
          - America/Paramaribo
          - America/Phoenix
          - America/Port-au-Prince
          - America/Port_of_Spain
          - America/Porto_Acre
          - America/Porto_Velho
          - America/Puerto_Rico
          - America/Punta_Arenas
          - America/Rainy_River
          - America/Rankin_Inlet
          - America/Recife
          - America/Regina
          - America/Resolute
          - America/Rio_Branco
          - America/Rosario
          - America/Santa_Isabel
          - America/Santarem
          - America/Santiago
          - America/Santo_Domingo
          - America/Sao_Paulo
          - America/Scoresbysund
          - America/Shiprock
          - America/Sitka
          - America/St_Barthelemy
          - America/St_Johns
          - America/St_Kitts
          - America/St_Lucia
          - America/St_Thomas
          - America/St_Vincent
          - America/Swift_Current
          - America/Tegucigalpa
          - America/Thule
          - America/Thunder_Bay
          - America/Tijuana
          - America/Toronto
          - America/Tortola
          - America/Vancouver
          - America/Virgin
          - America/Whitehorse
          - America/Winnipeg
          - America/Yakutat
          - America/Yellowknife
          - Antarctica/Casey
          - Antarctica/Davis
          - Antarctica/DumontDUrville
          - Antarctica/Macquarie
          - Antarctica/Mawson
          - Antarctica/McMurdo
          - Antarctica/Palmer
          - Antarctica/Rothera
          - Antarctica/South_Pole
          - Antarctica/Syowa
          - Antarctica/Troll
          - Antarctica/Vostok
          - Arctic/Longyearbyen
          - Asia/Aden
          - Asia/Almaty
          - Asia/Amman
          - Asia/Anadyr
          - Asia/Aqtau
          - Asia/Aqtobe
          - Asia/Ashgabat
          - Asia/Ashkhabad
          - Asia/Atyrau
          - Asia/Baghdad
          - Asia/Bahrain
          - Asia/Baku
          - Asia/Bangkok
          - Asia/Barnaul
          - Asia/Beirut
          - Asia/Bishkek
          - Asia/Brunei
          - Asia/Calcutta
          - Asia/Chita
          - Asia/Choibalsan
          - Asia/Chongqing
          - Asia/Chungking
          - Asia/Colombo
          - Asia/Dacca
          - Asia/Damascus
          - Asia/Dhaka
          - Asia/Dili
          - Asia/Dubai
          - Asia/Dushanbe
          - Asia/Famagusta
          - Asia/Gaza
          - Asia/Harbin
          - Asia/Hebron
          - Asia/Ho_Chi_Minh
          - Asia/Hong_Kong
          - Asia/Hovd
          - Asia/Irkutsk
          - Asia/Istanbul
          - Asia/Jakarta
          - Asia/Jayapura
          - Asia/Jerusalem
          - Asia/Kabul
          - Asia/Kamchatka
          - Asia/Karachi
          - Asia/Kashgar
          - Asia/Kathmandu
          - Asia/Katmandu
          - Asia/Khandyga
          - Asia/Kolkata
          - Asia/Krasnoyarsk
          - Asia/Kuala_Lumpur
          - Asia/Kuching
          - Asia/Kuwait
          - Asia/Macao
          - Asia/Macau
          - Asia/Magadan
          - Asia/Makassar
          - Asia/Manila
          - Asia/Muscat
          - Asia/Nicosia
          - Asia/Novokuznetsk
          - Asia/Novosibirsk
          - Asia/Omsk
          - Asia/Oral
          - Asia/Phnom_Penh
          - Asia/Pontianak
          - Asia/Pyongyang
          - Asia/Qatar
          - Asia/Qostanay
          - Asia/Qyzylorda
          - Asia/Rangoon
          - Asia/Riyadh
          - Asia/Saigon
          - Asia/Sakhalin
          - Asia/Samarkand
          - Asia/Seoul
          - Asia/Shanghai
          - Asia/Singapore
          - Asia/Srednekolymsk
          - Asia/Taipei
          - Asia/Tashkent
          - Asia/Tbilisi
          - Asia/Tehran
          - Asia/Tel_Aviv
          - Asia/Thimbu
          - Asia/Thimphu
          - Asia/Tokyo
          - Asia/Tomsk
          - Asia/Ujung_Pandang
          - Asia/Ulaanbaatar
          - Asia/Ulan_Bator
          - Asia/Urumqi
          - Asia/Ust-Nera
          - Asia/Vientiane
          - Asia/Vladivostok
          - Asia/Yakutsk
          - Asia/Yangon
          - Asia/Yekaterinburg
          - Asia/Yerevan
          - Atlantic/Azores
          - Atlantic/Bermuda
          - Atlantic/Canary
          - Atlantic/Cape_Verde
          - Atlantic/Faeroe
          - Atlantic/Faroe
          - Atlantic/Jan_Mayen
          - Atlantic/Madeira
          - Atlantic/Reykjavik
          - Atlantic/South_Georgia
          - Atlantic/St_Helena
          - Atlantic/Stanley
          - Australia/ACT
          - Australia/Adelaide
          - Australia/Brisbane
          - Australia/Broken_Hill
          - Australia/Canberra
          - Australia/Currie
          - Australia/Darwin
          - Australia/Eucla
          - Australia/Hobart
          - Australia/LHI
          - Australia/Lindeman
          - Australia/Lord_Howe
          - Australia/Melbourne
          - Australia/NSW
          - Australia/North
          - Australia/Perth
          - Australia/Queensland
          - Australia/South
          - Australia/Sydney
          - Australia/Tasmania
          - Australia/Victoria
          - Australia/West
          - Australia/Yancowinna
          - Brazil/Acre
          - Brazil/DeNoronha
          - Brazil/East
          - Brazil/West
          - CET
          - CST6CDT
          - Canada/Atlantic
          - Canada/Central
          - Canada/Eastern
          - Canada/Mountain
          - Canada/Newfoundland
          - Canada/Pacific
          - Canada/Saskatchewan
          - Canada/Yukon
          - Chile/Continental
          - Chile/EasterIsland
          - Cuba
          - EET
          - EST
          - EST5EDT
          - Egypt
          - Eire
          - Etc/GMT
          - Etc/GMT+0
          - Etc/GMT+1
          - Etc/GMT+10
          - Etc/GMT+11
          - Etc/GMT+12
          - Etc/GMT+2
          - Etc/GMT+3
          - Etc/GMT+4
          - Etc/GMT+5
          - Etc/GMT+6
          - Etc/GMT+7
          - Etc/GMT+8
          - Etc/GMT+9
          - Etc/GMT-0
          - Etc/GMT-1
          - Etc/GMT-10
          - Etc/GMT-11
          - Etc/GMT-12
          - Etc/GMT-13
          - Etc/GMT-14
          - Etc/GMT-2
          - Etc/GMT-3
          - Etc/GMT-4
          - Etc/GMT-5
          - Etc/GMT-6
          - Etc/GMT-7
          - Etc/GMT-8
          - Etc/GMT-9
          - Etc/GMT0
          - Etc/Greenwich
          - Etc/UCT
          - Etc/UTC
          - Etc/Universal
          - Etc/Zulu
          - Europe/Amsterdam
          - Europe/Andorra
          - Europe/Astrakhan
          - Europe/Athens
          - Europe/Belfast
          - Europe/Belgrade
          - Europe/Berlin
          - Europe/Bratislava
          - Europe/Brussels
          - Europe/Bucharest
          - Europe/Budapest
          - Europe/Busingen
          - Europe/Chisinau
          - Europe/Copenhagen
          - Europe/Dublin
          - Europe/Gibraltar
          - Europe/Guernsey
          - Europe/Helsinki
          - Europe/Isle_of_Man
          - Europe/Istanbul
          - Europe/Jersey
          - Europe/Kaliningrad
          - Europe/Kiev
          - Europe/Kirov
          - Europe/Kyiv
          - Europe/Lisbon
          - Europe/Ljubljana
          - Europe/London
          - Europe/Luxembourg
          - Europe/Madrid
          - Europe/Malta
          - Europe/Mariehamn
          - Europe/Minsk
          - Europe/Monaco
          - Europe/Moscow
          - Europe/Nicosia
          - Europe/Oslo
          - Europe/Paris
          - Europe/Podgorica
          - Europe/Prague
          - Europe/Riga
          - Europe/Rome
          - Europe/Samara
          - Europe/San_Marino
          - Europe/Sarajevo
          - Europe/Saratov
          - Europe/Simferopol
          - Europe/Skopje
          - Europe/Sofia
          - Europe/Stockholm
          - Europe/Tallinn
          - Europe/Tirane
          - Europe/Tiraspol
          - Europe/Ulyanovsk
          - Europe/Uzhgorod
          - Europe/Vaduz
          - Europe/Vatican
          - Europe/Vienna
          - Europe/Vilnius
          - Europe/Volgograd
          - Europe/Warsaw
          - Europe/Zagreb
          - Europe/Zaporozhye
          - Europe/Zurich
          - Factory
          - GB
          - GB-Eire
          - GMT
          - GMT+0
          - GMT-0
          - GMT0
          - Greenwich
          - HST
          - Hongkong
          - Iceland
          - Indian/Antananarivo
          - Indian/Chagos
          - Indian/Christmas
          - Indian/Cocos
          - Indian/Comoro
          - Indian/Kerguelen
          - Indian/Mahe
          - Indian/Maldives
          - Indian/Mauritius
          - Indian/Mayotte
          - Indian/Reunion
          - Iran
          - Israel
          - Jamaica
          - Japan
          - Kwajalein
          - Libya
          - MET
          - MST
          - MST7MDT
          - Mexico/BajaNorte
          - Mexico/BajaSur
          - Mexico/General
          - NZ
          - NZ-CHAT
          - Navajo
          - PRC
          - PST8PDT
          - Pacific/Apia
          - Pacific/Auckland
          - Pacific/Bougainville
          - Pacific/Chatham
          - Pacific/Chuuk
          - Pacific/Easter
          - Pacific/Efate
          - Pacific/Enderbury
          - Pacific/Fakaofo
          - Pacific/Fiji
          - Pacific/Funafuti
          - Pacific/Galapagos
          - Pacific/Gambier
          - Pacific/Guadalcanal
          - Pacific/Guam
          - Pacific/Honolulu
          - Pacific/Johnston
          - Pacific/Kanton
          - Pacific/Kiritimati
          - Pacific/Kosrae
          - Pacific/Kwajalein
          - Pacific/Majuro
          - Pacific/Marquesas
          - Pacific/Midway
          - Pacific/Nauru
          - Pacific/Niue
          - Pacific/Norfolk
          - Pacific/Noumea
          - Pacific/Pago_Pago
          - Pacific/Palau
          - Pacific/Pitcairn
          - Pacific/Pohnpei
          - Pacific/Ponape
          - Pacific/Port_Moresby
          - Pacific/Rarotonga
          - Pacific/Saipan
          - Pacific/Samoa
          - Pacific/Tahiti
          - Pacific/Tarawa
          - Pacific/Tongatapu
          - Pacific/Truk
          - Pacific/Wake
          - Pacific/Wallis
          - Pacific/Yap
          - Poland
          - Portugal
          - ROC
          - ROK
          - Singapore
          - Turkey
          - UCT
          - US/Alaska
          - US/Aleutian
          - US/Arizona
          - US/Central
          - US/East-Indiana
          - US/Eastern
          - US/Hawaii
          - US/Indiana-Starke
          - US/Michigan
          - US/Mountain
          - US/Pacific
          - US/Samoa
          - UTC
          - Universal
          - W-SU
          - WET
          - Zulu
          - localtime
      tags:
      - reports
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TasksStatesCountResponse'
          description: ''
  /reviews/:
    get:
      operationId: reviews_list
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - last_assignees
            - last_tasks
            - trackers
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: trackers,last_tasks
            summary: Regular sideloading
      - in: query
        name: tracker
        schema:
          type: string
          format: uuid
      tags:
      - reviews
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedReviewList'
          description: ''
    post:
      operationId: reviews_create
      tags:
      - reviews
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Review'
        required: true
      security:
      - tokenAuth: []
      - {}
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Review'
          description: ''
  /reviews/{id}/:
    get:
      operationId: reviews_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this review.
        required: true
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - last_assignees
            - last_tasks
            - trackers
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: trackers,last_tasks
            summary: Regular sideloading
      tags:
      - reviews
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Review'
          description: ''
  /route_optimizations/:
    get:
      operationId: route_optimizations_list
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - in: query
        name: assignees__id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: commited_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: commited_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: commited_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: commited_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: commited_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: commited_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: commited_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: commited_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: commited_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: commited_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: commited_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: created_by
        schema:
          type: string
          format: uuid
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - name: end_time
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: end_time__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: end_time__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: end_time__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: failed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: failed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: failed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: id
        schema:
          type: string
          format: uuid
      - in: query
        name: objective
        schema:
          type: string
          nullable: true
          enum:
          - completion_time
          - transport_time
          - vehicles
        description: |-
          * `vehicles` - Vehicles
          * `transport_time` - Transport Time
          * `completion_time` - Completion Time
      - in: query
        name: objective__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: ready_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: ready_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: ready_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: ready_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: ready_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: ready_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: ready_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: ready_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: ready_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: ready_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: ready_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: scheduled_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: scheduled_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: scheduled_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - assignees
            - created_bys
            - tasks
            - users
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: assignees,tasks
            summary: Regular sideloading
          MultiSourceSideloadingForUsers:
            value: users[assignees,created_bys]
            summary: Multi source sideloading for users
      - name: start_time
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: start_time__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: start_time__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: start_time__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: started_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: started_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: started_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: state
        schema:
          type: string
          enum:
          - completed
          - failed
          - over_quota
          - pending
          - ready
          - started
        description: |-
          * `pending` - Pending
          * `started` - Started
          * `ready` - Ready
          * `completed` - Completed
          * `over_quota` - Over quota
          * `failed` - Failed
      - in: query
        name: state__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: tasks__id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: total_distance__gt
        schema:
          type: integer
      - in: query
        name: total_distance__gte
        schema:
          type: integer
      - in: query
        name: total_distance__lt
        schema:
          type: integer
      - in: query
        name: total_distance__lte
        schema:
          type: integer
      - in: query
        name: total_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: total_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: total_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: total_duration__lte
        schema:
          type: string
          format: duration
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - route_optimizations
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedRouteOptimizationSerializerV2List'
          description: ''
    post:
      operationId: route_optimizations_create
      tags:
      - route_optimizations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RouteOptimizationSerializerV2'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/RouteOptimizationSerializerV2'
          description: ''
  /route_optimizations/{id}/:
    get:
      operationId: route_optimizations_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this route optimization.
        required: true
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - assignees
            - created_bys
            - tasks
            - users
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: assignees,tasks
            summary: Regular sideloading
          MultiSourceSideloadingForUsers:
            value: users[assignees,created_bys]
            summary: Multi source sideloading for users
      tags:
      - route_optimizations
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/RouteOptimizationSerializerV2'
          description: ''
  /route_optimizations/{id}/commit/:
    post:
      operationId: route_optimizations_commit_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this route optimization.
        required: true
      tags:
      - route_optimizations
      security:
      - tokenAuth: []
      responses:
        '200':
          description: No response body
  /route_optimizations/{id}/report/:
    get:
      operationId: route_optimizations_report_retrieve
      description: Returns a rendered report
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - html
          - pdf
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this route optimization.
        required: true
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - assignees
            - created_bys
            - tasks
            - users
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: assignees,tasks
            summary: Regular sideloading
          MultiSourceSideloadingForUsers:
            value: users[assignees,created_bys]
            summary: Multi source sideloading for users
      tags:
      - route_optimizations
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            text/html; version=2.11.9:
              schema:
                type: string
            application/pdf; version=2.11.9:
              schema:
                type: string
                format: byte
          description: ''
  /route_optimizations/{id}/results/:
    get:
      operationId: route_optimizations_results_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this route optimization.
        required: true
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - assignees
            - created_bys
            - tasks
            - users
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: assignees,tasks
            summary: Regular sideloading
          MultiSourceSideloadingForUsers:
            value: users[assignees,created_bys]
            summary: Multi source sideloading for users
      tags:
      - route_optimizations
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/RouteOptimizationResultSerializerV2'
          description: ''
  /route_optimizations/{id}/routes/:
    get:
      operationId: route_optimizations_routes_list
      description: Returns a list of routes
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - in: query
        name: assignees__id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: commited_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: commited_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: commited_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: commited_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: commited_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: commited_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: commited_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: commited_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: commited_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: commited_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: commited_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: created_by
        schema:
          type: string
          format: uuid
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - name: end_time
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: end_time__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: end_time__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: end_time__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: failed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: failed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: failed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this route optimization.
        required: true
      - in: query
        name: id
        schema:
          type: string
          format: uuid
      - in: query
        name: objective
        schema:
          type: string
          nullable: true
          enum:
          - completion_time
          - transport_time
          - vehicles
        description: |-
          * `vehicles` - Vehicles
          * `transport_time` - Transport Time
          * `completion_time` - Completion Time
      - in: query
        name: objective__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: ready_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: ready_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: ready_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: ready_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: ready_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: ready_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: ready_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: ready_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: ready_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: ready_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: ready_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: scheduled_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: scheduled_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: scheduled_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - assignees
            - created_bys
            - tasks
            - users
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: assignees,tasks
            summary: Regular sideloading
          MultiSourceSideloadingForUsers:
            value: users[assignees,created_bys]
            summary: Multi source sideloading for users
      - name: start_time
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: start_time__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: start_time__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: start_time__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: started_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: started_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: started_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: state
        schema:
          type: string
          enum:
          - completed
          - failed
          - over_quota
          - pending
          - ready
          - started
        description: |-
          * `pending` - Pending
          * `started` - Started
          * `ready` - Ready
          * `completed` - Completed
          * `over_quota` - Over quota
          * `failed` - Failed
      - in: query
        name: state__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: tasks__id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: total_distance__gt
        schema:
          type: integer
      - in: query
        name: total_distance__gte
        schema:
          type: integer
      - in: query
        name: total_distance__lt
        schema:
          type: integer
      - in: query
        name: total_distance__lte
        schema:
          type: integer
      - in: query
        name: total_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: total_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: total_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: total_duration__lte
        schema:
          type: string
          format: duration
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - route_optimizations
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedRouteList'
          description: ''
    post:
      operationId: route_optimizations_routes_create
      description: Returns a list of routes
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - in: query
        name: assignees__id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: commited_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: commited_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: commited_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: commited_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: commited_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: commited_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: commited_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: commited_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: commited_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: commited_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: commited_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: created_by
        schema:
          type: string
          format: uuid
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - name: end_time
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: end_time__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: end_time__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: end_time__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: failed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: failed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: failed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this route optimization.
        required: true
      - in: query
        name: id
        schema:
          type: string
          format: uuid
      - in: query
        name: objective
        schema:
          type: string
          nullable: true
          enum:
          - completion_time
          - transport_time
          - vehicles
        description: |-
          * `vehicles` - Vehicles
          * `transport_time` - Transport Time
          * `completion_time` - Completion Time
      - in: query
        name: objective__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: ready_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: ready_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: ready_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: ready_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: ready_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: ready_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: ready_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: ready_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: ready_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: ready_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: ready_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: scheduled_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: scheduled_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: scheduled_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: start_time__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: start_time__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: start_time__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: started_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: started_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: started_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: state
        schema:
          type: string
          enum:
          - completed
          - failed
          - over_quota
          - pending
          - ready
          - started
        description: |-
          * `pending` - Pending
          * `started` - Started
          * `ready` - Ready
          * `completed` - Completed
          * `over_quota` - Over quota
          * `failed` - Failed
      - in: query
        name: state__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: tasks__id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: total_distance__gt
        schema:
          type: integer
      - in: query
        name: total_distance__gte
        schema:
          type: integer
      - in: query
        name: total_distance__lt
        schema:
          type: integer
      - in: query
        name: total_distance__lte
        schema:
          type: integer
      - in: query
        name: total_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: total_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: total_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: total_duration__lte
        schema:
          type: string
          format: duration
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - route_optimizations
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedRouteList'
          description: ''
  /route_optimizations/{id}/schedule/:
    post:
      operationId: route_optimizations_schedule_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this route optimization.
        required: true
      tags:
      - route_optimizations
      security:
      - tokenAuth: []
      responses:
        '200':
          description: No response body
  /routes/:
    get:
      operationId: routes_list
      parameters:
      - name: account
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: account__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: assignee
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: assignee__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: assignee__isnull
        schema:
          type: boolean
      - in: query
        name: code
        schema:
          type: string
      - in: query
        name: code__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - name: end_time
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: end_time__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: end_time__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: end_time__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: external_id
        schema:
          type: string
      - in: query
        name: external_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: name
        schema:
          type: string
      - in: query
        name: name__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: objective
        schema:
          type: string
          enum:
          - completion_time
          - transport_time
          - vehicles
        description: |-
          * `vehicles` - Vehicles
          * `transport_time` - Transport Time
          * `completion_time` - Completion Time
      - in: query
        name: objective__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - name: start_time
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: start_time__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: start_time__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: start_time__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: state
        schema:
          type: string
          enum:
          - active
          - archived
          - draft
        description: |-
          * `active` - Active
          * `archived` - Archived
          * `draft` - Draft
      - in: query
        name: state__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - routes
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedRouteList'
          description: ''
    post:
      operationId: routes_create
      tags:
      - routes
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Route'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Route'
          description: ''
  /routes/{id}/:
    get:
      operationId: routes_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this route.
        required: true
      tags:
      - routes
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Route'
          description: ''
    put:
      operationId: routes_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this route.
        required: true
      tags:
      - routes
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Route'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Route'
          description: ''
    patch:
      operationId: routes_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this route.
        required: true
      tags:
      - routes
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedRoute'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Route'
          description: ''
    delete:
      operationId: routes_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this route.
        required: true
      tags:
      - routes
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /routes/{id}/activate/:
    post:
      operationId: routes_activate_create
      description: Action to activate the route. Available since version `2.4.18`
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this route.
        required: true
      tags:
      - routes
      security:
      - tokenAuth: []
      responses:
        '200':
          description: No response body
  /routes/{id}/archive/:
    post:
      operationId: routes_archive_create
      description: Action to archive the route. Available since version `2.4.18`
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this route.
        required: true
      tags:
      - routes
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RouteArchive'
      security:
      - tokenAuth: []
      responses:
        '200':
          description: No response body
  /routes/{id}/draft/:
    post:
      operationId: routes_draft_create
      description: Action to draft the route. Available since version `2.4.18`
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this route.
        required: true
      tags:
      - routes
      security:
      - tokenAuth: []
      responses:
        '200':
          description: No response body
  /session_tokens/:
    get:
      operationId: session_tokens_list
      parameters:
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - name: id
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: id__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: last_used_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: last_used_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: last_used_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: last_used_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_used_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_used_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_used_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_used_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_used_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_used_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: last_used_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: revoked_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: revoked_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: revoked_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: revoked_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: revoked_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: revoked_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: revoked_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: revoked_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: revoked_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: revoked_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: revoked_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - users
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: users
            summary: Regular sideloading
      - name: user
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: user__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      tags:
      - session_tokens
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedSessionTokenList'
          description: ''
  /session_tokens/{id}/:
    get:
      operationId: session_tokens_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this Session token.
        required: true
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - users
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: users
            summary: Regular sideloading
      tags:
      - session_tokens
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/SessionToken'
          description: ''
  /session_tokens/{id}/revoke/:
    post:
      operationId: session_tokens_revoke_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this Session token.
        required: true
      tags:
      - session_tokens
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SessionToken'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/SessionToken'
          description: Session token revoked
        '404':
          description: Session token not found in the caller's queryset
  /session_tokens/authorize/:
    post:
      operationId: session_tokens_authorize_create
      tags:
      - session_tokens
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Authorize'
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Authorize'
          description: ''
  /session_tokens/refresh/:
    post:
      operationId: session_tokens_refresh_create
      tags:
      - session_tokens
      responses:
        '200':
          description: No response body
  /signatures/:
    get:
      operationId: signatures_list
      parameters:
      - name: account
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: account__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_by
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: created_by__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: filename
        schema:
          type: string
      - name: filename__icontains
        required: false
        in: query
        schema:
          type: string
      - name: filename__iexact
        required: false
        in: query
        schema:
          type: string
      - name: filename__iregex
        required: false
        in: query
        schema:
          type: string
      - name: filename__istartswith
        required: false
        in: query
        schema:
          type: string
      - name: filename__search
        required: false
        in: query
        schema:
          type: string
      - in: query
        name: mimetype
        schema:
          type: string
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: source
        schema:
          type: string
          nullable: true
          enum:
          - integration
          - mobile
          - web
        description: |-
          * `web` - Web
          * `mobile` - Mobile
          * `integration` - Integration
      - name: task
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: task__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - signatures
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedSignatureList'
          description: ''
    post:
      operationId: signatures_create
      tags:
      - signatures
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Signature'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Signature'
          description: ''
  /signatures/{id}/:
    get:
      operationId: signatures_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this signature.
        required: true
      tags:
      - signatures
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Signature'
          description: ''
    delete:
      operationId: signatures_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this signature.
        required: true
      tags:
      - signatures
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /signatures/batch_delete/:
    post:
      operationId: signatures_batch_delete_create
      description: Available from version 2.4.2
      tags:
      - signatures
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignatureDeleteAction'
        required: true
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /sms/:
    get:
      operationId: sms_list
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - in: query
        name: alphanumeric_sender_id
        schema:
          type: string
      - in: query
        name: alphanumeric_sender_id__icontains
        schema:
          type: string
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - name: failed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: failed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: failed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: failed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: id
        schema:
          type: string
          format: uuid
      - in: query
        name: message
        schema:
          type: string
      - in: query
        name: message__icontains
        schema:
          type: string
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: phone
        schema:
          type: string
      - in: query
        name: phone__icontains
        schema:
          type: string
      - in: query
        name: price
        schema:
          type: number
      - in: query
        name: price__gt
        schema:
          type: number
      - in: query
        name: price__gte
        schema:
          type: number
      - in: query
        name: price__lt
        schema:
          type: number
      - in: query
        name: price__lte
        schema:
          type: number
      - in: query
        name: provider
        schema:
          type: string
          enum:
          - smsapi
          - twilio
        description: |-
          * `twilio` - Twilio
          * `smsapi` - SMSAPI
      - in: query
        name: provider__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: received_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: received_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: received_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: received_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: received_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: received_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: received_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: received_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: received_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: received_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: received_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: segments_count
        schema:
          type: integer
      - in: query
        name: segments_count__gt
        schema:
          type: integer
      - in: query
        name: segments_count__gte
        schema:
          type: integer
      - in: query
        name: segments_count__lt
        schema:
          type: integer
      - in: query
        name: segments_count__lte
        schema:
          type: integer
      - name: sent_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: sent_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: sent_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: sent_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: sent_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: sent_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: sent_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: sent_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: sent_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: sent_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: sent_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: state
        schema:
          type: string
          enum:
          - failed
          - over_quota
          - queued
          - received
          - sent
        description: |-
          * `queued` - Queued
          * `over_quota` - Over quota
          * `sent` - Sent
          * `failed` - Failed
          * `received` - Received
      - in: query
        name: state__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - sms
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedSMSList'
          description: ''
    post:
      operationId: sms_create
      tags:
      - sms
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SMS'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/SMS'
          description: Existing SMS returned
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/SMS'
          description: SMS created
  /sms/{id}/:
    get:
      operationId: sms_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this sms.
        required: true
      tags:
      - sms
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/SMS'
          description: ''
  /sms/{id}/resend/:
    post:
      operationId: sms_resend_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this sms.
        required: true
      tags:
      - sms
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/SMS'
          description: Existing SMS returned
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/SMS'
          description: SMS created
  /task_address_features/:
    get:
      operationId: task_address_features_list
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - in: query
        name: assignee
        schema:
          type: string
          format: uuid
      - in: query
        name: category
        schema:
          type: string
          enum:
          - assignment
          - drop_off
          - pick_up
          - warehouse
        description: |-
          * `assignment` - Assignment
          * `pick_up` - Pick-Up
          * `drop_off` - Drop-Off
          * `warehouse` - Warehouse
      - name: complete_after
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_after__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_after__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_after__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_before__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_before__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_before__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: owner
        schema:
          type: string
          format: uuid
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: position
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: position__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: position__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: position__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - task_address_features
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedTaskAddressFeatureList'
          description: ''
  /task_address_features/{id}/:
    get:
      operationId: task_address_features_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task.
        required: true
      tags:
      - task_address_features
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TaskAddressFeature'
          description: ''
  /task_commands/:
    get:
      operationId: task_commands_list
      parameters:
      - name: accepted_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: accepted_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: accepted_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: accepted_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: accepted_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: accepted_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: accepted_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: accepted_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: accepted_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: accepted_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: accepted_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: action
        schema:
          type: string
          enum:
          - accept
          - activate
          - assign
          - assignee_away
          - assignee_near
          - cancel
          - complete
          - fail
          - reassign
          - reject
          - restart
          - transit
          - unaccept
          - unassign
          - update
        description: |-
          * `update` - Update
          * `reassign` - Reassign
          * `restart` - Restart
          * `assign` - Assign
          * `accept` - Accept
          * `unaccept` - Un-accept
          * `reject` - Reject
          * `unassign` - Un-assign
          * `transit` - Transit
          * `activate` - Activate
          * `complete` - Complete
          * `fail` - Fail
          * `cancel` - Cancel
          * `assignee_near` - Assignee near
          * `assignee_away` - Assignee away
      - in: query
        name: assignee
        schema:
          type: string
          format: uuid
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: rejected_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: rejected_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: rejected_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: rejected_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: rejected_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: rejected_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: rejected_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: rejected_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: rejected_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: rejected_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: rejected_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - tasks
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: tasks
            summary: Regular sideloading
      - in: query
        name: state
        schema:
          type: string
          enum:
          - accepted
          - pending
          - rejected
        description: |-
          * `pending` - Pending
          * `accepted` - Accepted
          * `rejected` - Rejected
      - in: query
        name: task
        schema:
          type: string
          format: uuid
      - in: query
        name: task__account
        schema:
          type: string
          format: uuid
      - in: query
        name: time
        schema:
          type: string
          format: date-time
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: user
        schema:
          type: string
          format: uuid
      tags:
      - task_commands
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedTaskCommandList'
          description: ''
    post:
      operationId: task_commands_create
      tags:
      - task_commands
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskCommand'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TaskCommand'
          description: ''
  /task_commands/{id}/:
    get:
      operationId: task_commands_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task command.
        required: true
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - tasks
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: tasks
            summary: Regular sideloading
      tags:
      - task_commands
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TaskCommand'
          description: ''
  /task_event_tracks/:
    get:
      operationId: task_event_tracks_list
      parameters:
      - name: assignee
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: assignee__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: event
        schema:
          type: string
          enum:
          - accept
          - activate
          - assign
          - assignee_away
          - assignee_near
          - cancel
          - complete
          - create
          - fail
          - reject
          - restart
          - transit
          - unaccept
          - unassign
          - updated
        description: |-
          * `create` - Create
          * `assign` - Assign
          * `unassign` - Unassign
          * `reject` - Reject
          * `restart` - Restart
          * `accept` - Accept
          * `unaccept` - Unaccept
          * `transit` - Transit
          * `activate` - Activate
          * `complete` - Complete
          * `fail` - Fail
          * `cancel` - Cancel
          * `assignee_near` - Assignee near
          * `assignee_away` - Assignee away
          * `updated` - Updated
      - in: query
        name: from_state
        schema:
          type: string
          enum:
          - accepted
          - active
          - assigned
          - away
          - cancelled
          - completed
          - draft
          - failed
          - near
          - scheduled
          - transit
          - unassigned
        description: |-
          * `draft` - Draft
          * `scheduled` - Scheduled
          * `unassigned` - Unassigned
          * `assigned` - Assigned
          * `accepted` - Accepted
          * `transit` - Transit
          * `active` - Active
          * `completed` - Completed
          * `failed` - Failed
          * `cancelled` - Cancelled
          * `away` - Away
          * `near` - Near
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: task
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: task__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: to_state
        schema:
          type: string
          enum:
          - accepted
          - active
          - assigned
          - away
          - cancelled
          - completed
          - draft
          - failed
          - near
          - scheduled
          - transit
          - unassigned
        description: |-
          * `draft` - Draft
          * `scheduled` - Scheduled
          * `unassigned` - Unassigned
          * `assigned` - Assigned
          * `accepted` - Accepted
          * `transit` - Transit
          * `active` - Active
          * `completed` - Completed
          * `failed` - Failed
          * `cancelled` - Cancelled
          * `away` - Away
          * `near` - Near
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: user
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: user__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      tags:
      - task_event_tracks
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedTaskEventTrackList'
          description: ''
  /task_event_tracks/{id}/:
    get:
      operationId: task_event_tracks_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task event.
        required: true
      tags:
      - task_event_tracks
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TaskEventTrack'
          description: ''
  /task_events/:
    get:
      operationId: task_events_list
      description: |-
        Mixin which allows the override of the filename being
        passed back to the user when the spreadsheet is downloaded.
      parameters:
      - in: query
        name: assignee
        schema:
          type: string
          format: uuid
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: event
        schema:
          type: string
          enum:
          - accept
          - activate
          - assign
          - assignee_away
          - assignee_near
          - cancel
          - complete
          - create
          - fail
          - reject
          - restart
          - transit
          - unaccept
          - unassign
          - updated
        description: |-
          * `create` - Create
          * `assign` - Assign
          * `unassign` - Unassign
          * `reject` - Reject
          * `restart` - Restart
          * `accept` - Accept
          * `unaccept` - Unaccept
          * `transit` - Transit
          * `activate` - Activate
          * `complete` - Complete
          * `fail` - Fail
          * `cancel` - Cancel
          * `assignee_near` - Assignee near
          * `assignee_away` - Assignee away
          * `updated` - Updated
      - in: query
        name: event__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: field
        schema:
          type: string
          enum:
          - ''
          - assignee_proximity
          - state
        description: "* `` - \n* `state` - State\n* `assignee_proximity` - Assignee\
          \ proximity"
      - in: query
        name: from_state
        schema:
          type: string
          enum:
          - accepted
          - active
          - assigned
          - away
          - cancelled
          - completed
          - draft
          - failed
          - near
          - scheduled
          - transit
          - unassigned
        description: |-
          * `draft` - Draft
          * `scheduled` - Scheduled
          * `unassigned` - Unassigned
          * `assigned` - Assigned
          * `accepted` - Accepted
          * `transit` - Transit
          * `active` - Active
          * `completed` - Completed
          * `failed` - Failed
          * `cancelled` - Cancelled
          * `away` - Away
          * `near` - Near
      - in: query
        name: from_state__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: task
        schema:
          type: string
          format: uuid
      - in: query
        name: task__account
        schema:
          type: string
          format: uuid
      - in: query
        name: to_state
        schema:
          type: string
          enum:
          - accepted
          - active
          - assigned
          - away
          - cancelled
          - completed
          - draft
          - failed
          - near
          - scheduled
          - transit
          - unassigned
        description: |-
          * `draft` - Draft
          * `scheduled` - Scheduled
          * `unassigned` - Unassigned
          * `assigned` - Assigned
          * `accepted` - Accepted
          * `transit` - Transit
          * `active` - Active
          * `completed` - Completed
          * `failed` - Failed
          * `cancelled` - Cancelled
          * `away` - Away
          * `near` - Near
      - in: query
        name: to_state__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: user
        schema:
          type: string
          format: uuid
      tags:
      - task_events
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedTaskEventSerializerV2List'
          description: ''
  /task_events/{id}/:
    get:
      operationId: task_events_retrieve
      description: |-
        Mixin which allows the override of the filename being
        passed back to the user when the spreadsheet is downloaded.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task event.
        required: true
      tags:
      - task_events
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TaskEventSerializerV2'
          description: ''
  /task_exports/:
    get:
      operationId: task_exports_list
      description: "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=...`\n\nThe 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.\n\
        Also metafields can be added to the response. For this just add them as fields,\
        \ using structure `metafields__{metafield.namespace}:{metafield.key}`. \n\n\
        When exporting to **excel**, the column names may be changed based on account\
        \ metafield names or pre-defined field name and width mapping.\n\nChanges\
        \ in version 2.2.1:\n * field names have been updated to reflect the Task\
        \ fields schema and filters.\n * Invalid fields in fields request will return\
        \ a ValidationError.\n * Account filter is required.\n * AccountRole display\
        \ name is annotated to user objects.\n * 'task_event_notes' is dropped.\n\
        \ * 'contact_phone' and 'contact_email' is replaced with 'contact_phones'\
        \ and 'contact_emails'.\n"
      parameters:
      - name: account
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: account__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: address__apartment_number
        schema:
          type: string
      - in: query
        name: address__apartment_number__icontains
        schema:
          type: string
      - in: query
        name: address__apartment_number__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__apartment_number__iregex
        schema:
          type: string
      - in: query
        name: address__apartment_number__istartswith
        schema:
          type: string
      - in: query
        name: address__apartment_number__search
        schema:
          type: string
      - in: query
        name: address__city
        schema:
          type: string
      - in: query
        name: address__city__icontains
        schema:
          type: string
      - in: query
        name: address__city__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__city__iregex
        schema:
          type: string
      - in: query
        name: address__city__istartswith
        schema:
          type: string
      - in: query
        name: address__city__search
        schema:
          type: string
      - in: query
        name: address__country
        schema:
          type: string
      - in: query
        name: address__country__icontains
        schema:
          type: string
      - in: query
        name: address__country__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__country__iregex
        schema:
          type: string
      - in: query
        name: address__country__istartswith
        schema:
          type: string
      - in: query
        name: address__country__search
        schema:
          type: string
      - in: query
        name: address__country_code
        schema:
          type: string
      - in: query
        name: address__country_code__icontains
        schema:
          type: string
      - in: query
        name: address__country_code__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__country_code__iregex
        schema:
          type: string
      - in: query
        name: address__country_code__istartswith
        schema:
          type: string
      - in: query
        name: address__country_code__search
        schema:
          type: string
      - in: query
        name: address__formatted_address
        schema:
          type: string
      - in: query
        name: address__formatted_address__icontains
        schema:
          type: string
      - in: query
        name: address__formatted_address__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__formatted_address__iregex
        schema:
          type: string
      - in: query
        name: address__formatted_address__istartswith
        schema:
          type: string
      - in: query
        name: address__formatted_address__search
        schema:
          type: string
      - name: address__geocode_failed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocode_failed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocode_failed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocode_failed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocoded_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocoded_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocoded_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: address__geocoding_provider
        schema:
          type: string
          nullable: true
          enum:
          - Paid Services
          - Standard Services
        description: |-
          * `Paid Services` - [('google', 'Google'), ('regio-ee', 'Regio-Ee')]
          * `Standard Services` - [('janaseta', 'Jana Seta'), ('reach-u', 'Reach-U'), ('nominatim', 'Nominatim'), ('in-ads', 'In-ADS')]
      - in: query
        name: address__geocoding_provider__icontains
        schema:
          type: string
      - in: query
        name: address__geocoding_provider__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__geocoding_provider__iregex
        schema:
          type: string
      - in: query
        name: address__geocoding_provider__istartswith
        schema:
          type: string
      - in: query
        name: address__geocoding_provider__search
        schema:
          type: string
      - in: query
        name: address__google_place_id
        schema:
          type: string
      - in: query
        name: address__google_place_id__icontains
        schema:
          type: string
      - in: query
        name: address__google_place_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__google_place_id__iregex
        schema:
          type: string
      - in: query
        name: address__google_place_id__istartswith
        schema:
          type: string
      - in: query
        name: address__google_place_id__search
        schema:
          type: string
      - in: query
        name: address__house_number
        schema:
          type: string
      - in: query
        name: address__house_number__icontains
        schema:
          type: string
      - in: query
        name: address__house_number__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__house_number__iregex
        schema:
          type: string
      - in: query
        name: address__house_number__istartswith
        schema:
          type: string
      - in: query
        name: address__house_number__search
        schema:
          type: string
      - in: query
        name: address__point_of_interest
        schema:
          type: string
      - in: query
        name: address__point_of_interest__icontains
        schema:
          type: string
      - in: query
        name: address__point_of_interest__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__point_of_interest__iregex
        schema:
          type: string
      - in: query
        name: address__point_of_interest__istartswith
        schema:
          type: string
      - in: query
        name: address__point_of_interest__search
        schema:
          type: string
      - in: query
        name: address__postal_code
        schema:
          type: string
      - in: query
        name: address__postal_code__icontains
        schema:
          type: string
      - in: query
        name: address__postal_code__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__postal_code__iregex
        schema:
          type: string
      - in: query
        name: address__postal_code__istartswith
        schema:
          type: string
      - in: query
        name: address__postal_code__search
        schema:
          type: string
      - in: query
        name: address__raw_address
        schema:
          type: string
      - in: query
        name: address__raw_address__icontains
        schema:
          type: string
      - in: query
        name: address__raw_address__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__raw_address__iregex
        schema:
          type: string
      - in: query
        name: address__raw_address__istartswith
        schema:
          type: string
      - in: query
        name: address__raw_address__search
        schema:
          type: string
      - in: query
        name: address__state
        schema:
          type: string
      - in: query
        name: address__state__icontains
        schema:
          type: string
      - in: query
        name: address__state__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__state__iregex
        schema:
          type: string
      - in: query
        name: address__state__istartswith
        schema:
          type: string
      - in: query
        name: address__state__search
        schema:
          type: string
      - in: query
        name: address__street
        schema:
          type: string
      - in: query
        name: address__street__icontains
        schema:
          type: string
      - in: query
        name: address__street__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__street__iregex
        schema:
          type: string
      - in: query
        name: address__street__istartswith
        schema:
          type: string
      - in: query
        name: address__street__search
        schema:
          type: string
      - name: address_data
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - in: query
        name: address_id
        schema:
          type: string
          format: uuid
      - in: query
        name: address_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address_id__isnull
        schema:
          type: boolean
      - name: assignee
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: assignee__email
        schema:
          type: string
      - in: query
        name: assignee__email__icontains
        schema:
          type: string
      - in: query
        name: assignee__email__iregex
        schema:
          type: string
      - in: query
        name: assignee__email__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__email__istartswith
        schema:
          type: string
      - in: query
        name: assignee__email__search
        schema:
          type: string
      - in: query
        name: assignee__first_name
        schema:
          type: string
      - in: query
        name: assignee__first_name__icontains
        schema:
          type: string
      - in: query
        name: assignee__first_name__iregex
        schema:
          type: string
      - in: query
        name: assignee__first_name__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__first_name__istartswith
        schema:
          type: string
      - in: query
        name: assignee__first_name__search
        schema:
          type: string
      - name: assignee__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: assignee__last_name
        schema:
          type: string
      - in: query
        name: assignee__last_name__icontains
        schema:
          type: string
      - in: query
        name: assignee__last_name__iregex
        schema:
          type: string
      - in: query
        name: assignee__last_name__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__last_name__istartswith
        schema:
          type: string
      - in: query
        name: assignee__last_name__search
        schema:
          type: string
      - in: query
        name: assignee__password_expires_at
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__password_expires_at__gt
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__password_expires_at__gte
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__password_expires_at__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__password_expires_at__lt
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__password_expires_at__lte
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__phone
        schema:
          type: string
      - in: query
        name: assignee__phone__icontains
        schema:
          type: string
      - in: query
        name: assignee__phone__iregex
        schema:
          type: string
      - in: query
        name: assignee__phone__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__phone__istartswith
        schema:
          type: string
      - in: query
        name: assignee__phone__search
        schema:
          type: string
      - in: query
        name: assignee_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: assignee_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: assignee_id__isnull
        schema:
          type: boolean
      - in: query
        name: assignee_proximity
        schema:
          type: string
          enum:
          - away
          - near
        description: |-
          * `away` - Away
          * `near` - Near
      - in: query
        name: assignee_proximity__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: barcodes__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: barcodes__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: barcodes__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: barcodes__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: calendar_time
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: calendar_time__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: calendar_time__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: calendar_time__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: cancelled_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: cancelled_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: cancelled_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: category
        schema:
          type: string
          enum:
          - assignment
          - drop_off
          - pick_up
          - warehouse
        description: |-
          * `assignment` - Assignment
          * `pick_up` - Pick-Up
          * `drop_off` - Drop-Off
          * `warehouse` - Warehouse
      - in: query
        name: category__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: complete_after
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_after__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_after__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_after__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_before__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_before__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_before__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: contact__company__icontains
        schema:
          type: string
      - in: query
        name: contact__company__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__company__iregex
        schema:
          type: string
      - in: query
        name: contact__company__istartswith
        schema:
          type: string
      - in: query
        name: contact__company__search
        schema:
          type: string
      - in: query
        name: contact__email
        schema:
          type: string
      - in: query
        name: contact__email__icontains
        schema:
          type: string
      - in: query
        name: contact__email__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__email__iregex
        schema:
          type: string
      - in: query
        name: contact__email__istartswith
        schema:
          type: string
      - in: query
        name: contact__email__search
        schema:
          type: string
      - name: contact__emails__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated emails supported
        schema:
          type: string
        example: example1@mail.ee,example2@mail.ee
      - name: contact__emails__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated emails supported
        schema:
          type: string
        example: example1@mail.ee,example2@mail.ee
      - name: contact__emails__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: contact__emails__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated emails supported
        schema:
          type: string
        example: example1@mail.ee,example2@mail.ee
      - in: query
        name: contact__name
        schema:
          type: string
      - in: query
        name: contact__name__icontains
        schema:
          type: string
      - in: query
        name: contact__name__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__name__iregex
        schema:
          type: string
      - in: query
        name: contact__name__istartswith
        schema:
          type: string
      - in: query
        name: contact__name__search
        schema:
          type: string
      - in: query
        name: contact__notes
        schema:
          type: string
      - in: query
        name: contact__notes__icontains
        schema:
          type: string
      - in: query
        name: contact__notes__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__notes__iregex
        schema:
          type: string
      - in: query
        name: contact__notes__istartswith
        schema:
          type: string
      - in: query
        name: contact__notes__search
        schema:
          type: string
      - in: query
        name: contact__phone
        schema:
          type: string
      - in: query
        name: contact__phone__icontains
        schema:
          type: string
      - in: query
        name: contact__phone__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__phone__iregex
        schema:
          type: string
      - in: query
        name: contact__phone__istartswith
        schema:
          type: string
      - in: query
        name: contact__phone__search
        schema:
          type: string
      - name: contact__phones__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact__phones__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact__phones__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: contact__phones__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact_address
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: contact_address__external_id
        schema:
          type: string
      - in: query
        name: contact_address__external_id__icontains
        schema:
          type: string
      - in: query
        name: contact_address__external_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact_address__external_id__isnull
        schema:
          type: boolean
      - name: contact_address__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: contact_data
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - in: query
        name: contact_id
        schema:
          type: string
          format: uuid
      - in: query
        name: contact_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact_id__isnull
        schema:
          type: boolean
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: created_by
        schema:
          type: string
          format: uuid
      - in: query
        name: created_by__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: created_by__isnull
        schema:
          type: boolean
      - in: query
        name: description
        schema:
          type: string
      - in: query
        name: description__icontains
        schema:
          type: string
      - in: query
        name: description__iregex
        schema:
          type: string
      - in: query
        name: description__istartswith
        schema:
          type: string
      - in: query
        name: description__search
        schema:
          type: string
      - in: query
        name: duration
        schema:
          type: string
          format: duration
      - in: query
        name: duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: external_id
        schema:
          type: string
      - in: query
        name: external_id__icontains
        schema:
          type: string
      - in: query
        name: external_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: external_id__iregex
        schema:
          type: string
      - in: query
        name: external_id__isnull
        schema:
          type: boolean
      - in: query
        name: external_id__istartswith
        schema:
          type: string
      - in: query
        name: external_id__search
        schema:
          type: string
      - in: query
        name: fields
        schema:
          type: string
        description: 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
        examples:
          ExampleName:
            value: name,external_id,created_at,metafields__namespace:key
            summary: Returns fields name, external_id, created_at and metafields__namespace:key
              in the same order
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - xlsx
          default: json
        description: Selects response method. xlsx returns Excel file
      - in: query
        name: id
        schema:
          type: string
          format: uuid
      - in: query
        name: id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: is_optimal
        schema:
          type: boolean
      - in: query
        name: is_optimal__isnull
        schema:
          type: boolean
      - in: query
        name: metadata__accepted_distance
        schema:
          type: integer
      - in: query
        name: metadata__accepted_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__accepted_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__accepted_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__accepted_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__accepted_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__accepted_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__accepted_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__accepted_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__accepted_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_distance
        schema:
          type: integer
      - in: query
        name: metadata__active_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__active_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__active_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__active_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__active_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_distance
        schema:
          type: integer
      - in: query
        name: metadata__assigned_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__assigned_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__assigned_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__assigned_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__assigned_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_distance
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_distance
        schema:
          type: integer
      - in: query
        name: metadata__completed_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__completed_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__completed_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__completed_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__completed_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__documents_count
        schema:
          type: integer
      - in: query
        name: metadata__documents_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__documents_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__documents_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__documents_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__events_count
        schema:
          type: integer
      - in: query
        name: metadata__events_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__events_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__events_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__events_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__failed_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__failed_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__failed_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__failed_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__failed_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__forms_completed_count
        schema:
          type: integer
      - in: query
        name: metadata__forms_completed_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__forms_completed_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__forms_completed_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__forms_completed_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__forms_count
        schema:
          type: integer
      - in: query
        name: metadata__forms_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__forms_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__forms_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__forms_count__lte
        schema:
          type: integer
      - name: metadata__last_accepted_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_accepted_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_accepted_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_accepted_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_active_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_active_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_active_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_assigned_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_assigned_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_assigned_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_cancelled_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_cancelled_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_cancelled_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_completed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_completed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_completed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_failed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_failed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_failed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_transit_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_transit_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_transit_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_unassigned_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_unassigned_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_unassigned_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: metadata__signatures_count
        schema:
          type: integer
      - in: query
        name: metadata__signatures_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__signatures_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__signatures_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__signatures_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__transit_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__transit_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__transit_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__transit_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__transit_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_distance
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_duration__lte
        schema:
          type: string
          format: duration
      - name: metafields__namespace:key
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - name: order
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: order__auto_assign
        schema:
          type: boolean
      - name: order__created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: order__created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: order__created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: order__created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: order__created_by
        schema:
          type: string
          format: uuid
      - in: query
        name: order__created_by__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: order__created_by__isnull
        schema:
          type: boolean
      - in: query
        name: order__description
        schema:
          type: string
      - in: query
        name: order__description__icontains
        schema:
          type: string
      - in: query
        name: order__description__iregex
        schema:
          type: string
      - in: query
        name: order__description__isnull
        schema:
          type: boolean
      - in: query
        name: order__description__istartswith
        schema:
          type: string
      - in: query
        name: order__description__search
        schema:
          type: string
      - in: query
        name: order__external_id
        schema:
          type: string
      - in: query
        name: order__external_id__icontains
        schema:
          type: string
      - in: query
        name: order__external_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: order__external_id__iregex
        schema:
          type: string
      - in: query
        name: order__external_id__isnull
        schema:
          type: boolean
      - in: query
        name: order__external_id__istartswith
        schema:
          type: string
      - in: query
        name: order__external_id__search
        schema:
          type: string
      - name: order__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: order__orderer
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - in: query
        name: order__orderer__company
        schema:
          type: string
      - in: query
        name: order__orderer__company__icontains
        schema:
          type: string
      - in: query
        name: order__orderer__company__iexact
        schema:
          type: string
      - in: query
        name: order__orderer__company__istartswith
        schema:
          type: string
      - in: query
        name: order__orderer__emails__contained_by
        schema:
          type: string
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated values supported
        examples:
          Example:
            value: example1@mail.ee,example2@mail.ee
            summary: example
      - in: query
        name: order__orderer__emails__contains
        schema:
          type: string
        description: Filter the returned list where all filter_values are present.
          Comma separated values supported
        examples:
          Example:
            value: example1@mail.ee,example2@mail.ee
            summary: example
      - in: query
        name: order__orderer__emails__overlap
        schema:
          type: string
        description: Filter the returned list where at least one filter value in target
          array. Comma separated values supported
        examples:
          Example:
            value: example1@mail.ee,example2@mail.ee
            summary: example
      - in: query
        name: order__orderer__name
        schema:
          type: string
      - in: query
        name: order__orderer__name__icontains
        schema:
          type: string
      - in: query
        name: order__orderer__name__iexact
        schema:
          type: string
      - in: query
        name: order__orderer__name__istartswith
        schema:
          type: string
      - in: query
        name: order__orderer__notes
        schema:
          type: string
      - in: query
        name: order__orderer__notes__icontains
        schema:
          type: string
      - in: query
        name: order__orderer__notes__iexact
        schema:
          type: string
      - in: query
        name: order__orderer__notes__istartswith
        schema:
          type: string
      - in: query
        name: order__orderer__phones__contained_by
        schema:
          type: string
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated values supported
        examples:
          Example:
            value: +3725012345,5022333
            summary: example
      - in: query
        name: order__orderer__phones__contains
        schema:
          type: string
        description: Filter the returned list where all filter_values are present.
          Comma separated values supported
        examples:
          Example:
            value: +3725012345,5022333
            summary: example
      - in: query
        name: order__orderer__phones__overlap
        schema:
          type: string
        description: Filter the returned list where at least one filter value in target
          array. Comma separated values supported
        examples:
          Example:
            value: +3725012345,5022333
            summary: example
      - in: query
        name: order__reference
        schema:
          type: string
      - in: query
        name: order__reference__icontains
        schema:
          type: string
      - in: query
        name: order__reference__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: order__reference__iregex
        schema:
          type: string
      - in: query
        name: order__reference__istartswith
        schema:
          type: string
      - in: query
        name: order__reference__search
        schema:
          type: string
      - in: query
        name: order_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: order_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: order_id__isnull
        schema:
          type: boolean
      - name: orderer
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: orderer__id
        schema:
          type: string
          format: uuid
      - in: query
        name: orderer__id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: orderer__id__isnull
        schema:
          type: boolean
      - name: orderer__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: orderer__name
        schema:
          type: string
      - in: query
        name: orderer__name__icontains
        schema:
          type: string
      - in: query
        name: orderer_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: orderer_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: orderer_id__isnull
        schema:
          type: boolean
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - in: query
        name: owner_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: owner_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: owner_id__isnull
        schema:
          type: boolean
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: position
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: position__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: position__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: position__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: previous_assignees__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated UUID values supported
        schema:
          type: string
        example: 539766ec-f9db-4731-b21d-40618ab3050e,b71c1095-2165-49ae-a22a-a22a47cd90f1
      - name: previous_assignees__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated UUID values supported
        schema:
          type: string
        example: 539766ec-f9db-4731-b21d-40618ab3050e,b71c1095-2165-49ae-a22a-a22a47cd90f1
      - name: previous_assignees__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: previous_assignees__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated UUID values supported
        schema:
          type: string
        example: 539766ec-f9db-4731-b21d-40618ab3050e,b71c1095-2165-49ae-a22a-a22a47cd90f1
      - in: query
        name: priority
        schema:
          type: integer
      - in: query
        name: priority__gt
        schema:
          type: integer
      - in: query
        name: priority__gte
        schema:
          type: integer
      - in: query
        name: priority__in
        schema:
          type: array
          items:
            type: integer
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: priority__lt
        schema:
          type: integer
      - in: query
        name: priority__lte
        schema:
          type: integer
      - name: receiver
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: receiver__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: receiver_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: receiver_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: receiver_id__isnull
        schema:
          type: boolean
      - in: query
        name: reference
        schema:
          type: string
      - in: query
        name: reference__icontains
        schema:
          type: string
      - in: query
        name: reference__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: reference__iregex
        schema:
          type: string
      - in: query
        name: reference__istartswith
        schema:
          type: string
      - in: query
        name: reference__search
        schema:
          type: string
      - name: route
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: route__account
        schema:
          type: string
          format: uuid
      - in: query
        name: route__account__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__account__isnull
        schema:
          type: boolean
      - in: query
        name: route__assignee
        schema:
          type: string
          format: uuid
      - in: query
        name: route__assignee__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__assignee__isnull
        schema:
          type: boolean
      - in: query
        name: route__code
        schema:
          type: string
      - in: query
        name: route__code__icontains
        schema:
          type: string
      - in: query
        name: route__code__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__code__iregex
        schema:
          type: string
      - in: query
        name: route__code__isnull
        schema:
          type: boolean
      - in: query
        name: route__code__istartswith
        schema:
          type: string
      - in: query
        name: route__code__search
        schema:
          type: string
      - in: query
        name: route__description
        schema:
          type: string
      - in: query
        name: route__description__icontains
        schema:
          type: string
      - in: query
        name: route__description__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__description__iregex
        schema:
          type: string
      - in: query
        name: route__description__isnull
        schema:
          type: boolean
      - in: query
        name: route__description__istartswith
        schema:
          type: string
      - in: query
        name: route__description__search
        schema:
          type: string
      - in: query
        name: route__end_address
        schema:
          type: string
          format: uuid
      - in: query
        name: route__end_address__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__end_address__isnull
        schema:
          type: boolean
      - in: query
        name: route__end_time
        schema:
          type: string
          format: date-time
      - in: query
        name: route__end_time__gt
        schema:
          type: string
          format: date-time
      - in: query
        name: route__end_time__gte
        schema:
          type: string
          format: date-time
      - in: query
        name: route__end_time__isnull
        schema:
          type: boolean
      - in: query
        name: route__end_time__lt
        schema:
          type: string
          format: date-time
      - in: query
        name: route__end_time__lte
        schema:
          type: string
          format: date-time
      - in: query
        name: route__external_id
        schema:
          type: string
      - in: query
        name: route__external_id__icontains
        schema:
          type: string
      - in: query
        name: route__external_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__external_id__isnull
        schema:
          type: boolean
      - name: route__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: route__metafields
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - in: query
        name: route__name
        schema:
          type: string
      - in: query
        name: route__name__icontains
        schema:
          type: string
      - in: query
        name: route__name__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__name__iregex
        schema:
          type: string
      - in: query
        name: route__name__isnull
        schema:
          type: boolean
      - in: query
        name: route__name__istartswith
        schema:
          type: string
      - in: query
        name: route__name__search
        schema:
          type: string
      - in: query
        name: route__start_address
        schema:
          type: string
          format: uuid
      - in: query
        name: route__start_address__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__start_address__isnull
        schema:
          type: boolean
      - in: query
        name: route__start_time
        schema:
          type: string
          format: date-time
      - in: query
        name: route__start_time__gt
        schema:
          type: string
          format: date-time
      - in: query
        name: route__start_time__gte
        schema:
          type: string
          format: date-time
      - in: query
        name: route__start_time__isnull
        schema:
          type: boolean
      - in: query
        name: route__start_time__lt
        schema:
          type: string
          format: date-time
      - in: query
        name: route__start_time__lte
        schema:
          type: string
          format: date-time
      - in: query
        name: route_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: route_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route_id__isnull
        schema:
          type: boolean
      - name: scheduled_time
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: scheduled_time__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: scheduled_time__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: scheduled_time__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - name: size__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated integer values supported
        schema:
          type: string
        example: 11,23
      - name: size__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated integer values supported
        schema:
          type: string
        example: 11,23
      - name: size__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: size__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated integer values supported
        schema:
          type: string
        example: 11,23
      - in: query
        name: state
        schema:
          type: string
          enum:
          - accepted
          - active
          - assigned
          - cancelled
          - completed
          - draft
          - failed
          - scheduled
          - transit
          - unassigned
        description: |-
          * `draft` - Draft
          * `scheduled` - Scheduled
          * `unassigned` - Unassigned
          * `assigned` - Assigned
          * `accepted` - Accepted
          * `transit` - Transit
          * `active` - Active
          * `completed` - Completed
          * `failed` - Failed
          * `cancelled` - Cancelled
      - name: state__in
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: state__in_or_isnull
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: state__not_in
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: state__not_in_or_isnull
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: task_import
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: task_import__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: unassignee_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: unassignee_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: unassignee_id__isnull
        schema:
          type: boolean
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at_delay_latest
        required: false
        in: query
        description: 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__gte`is used.
        example: true
        schema:
          type: boolean
      tags:
      - task_exports
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedTaskExportList'
            application/vnd.openxmlformats-officedocument.spreadsheetml.sheet; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedTaskExportList'
          description: ''
  /task_forms/:
    get:
      operationId: task_forms_list
      parameters:
      - in: query
        name: completed
        schema:
          type: boolean
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: open_in
        schema:
          type: string
          enum:
          - in-app-browser
          - webview
        description: |-
          * `webview` - Webview
          * `in-app-browser` - In app browser
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: task
        schema:
          type: string
          format: uuid
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - task_forms
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedTaskFormList'
          description: ''
    post:
      operationId: task_forms_create
      tags:
      - task_forms
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskForm'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TaskForm'
          description: ''
  /task_forms/{id}/:
    get:
      operationId: task_forms_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task form.
        required: true
      tags:
      - task_forms
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TaskForm'
          description: ''
    put:
      operationId: task_forms_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task form.
        required: true
      tags:
      - task_forms
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskForm'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TaskForm'
          description: ''
    patch:
      operationId: task_forms_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task form.
        required: true
      tags:
      - task_forms
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedTaskForm'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TaskForm'
          description: ''
    delete:
      operationId: task_forms_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task form.
        required: true
      tags:
      - task_forms
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /task_import/:
    get:
      operationId: task_import_list
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - name: completed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - name: failed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: failed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: failed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: failed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: failed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: started_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: started_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: started_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: started_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: started_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: state
        schema:
          type: string
          enum:
          - completed
          - failed
          - pending
          - started
        description: |-
          * `pending` - Pending
          * `started` - Started
          * `completed` - Completed
          * `failed` - Failed
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - task_import
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedTasksBackgroundImportList'
          description: ''
    post:
      operationId: task_import_create
      tags:
      - task_import
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TasksBackgroundImport'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TasksBackgroundImport'
          description: ''
  /task_import/{id}/:
    get:
      operationId: task_import_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this tasks background import.
        required: true
      tags:
      - task_import
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TasksBackgroundImport'
          description: ''
  /task_import_mapping/:
    get:
      operationId: task_import_mapping_list
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - name: field_names__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: field_names__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: field_names__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: field_names__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - task_import_mapping
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedImportMappingList'
          description: ''
    post:
      operationId: task_import_mapping_create
      tags:
      - task_import_mapping
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportMapping'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/ImportMapping'
          description: ''
  /task_import_mapping/{id}/:
    get:
      operationId: task_import_mapping_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this mapping.
        required: true
      tags:
      - task_import_mapping
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/ImportMapping'
          description: ''
  /task_metadatas/:
    get:
      operationId: task_metadatas_list
      parameters:
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: task
        schema:
          type: string
          format: uuid
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - task_metadatas
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedTaskMetadataList'
          description: ''
  /task_metadatas/{id}/:
    get:
      operationId: task_metadatas_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task metadata.
        required: true
      tags:
      - task_metadatas
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TaskMetadata'
          description: ''
  /tasks/:
    get:
      operationId: tasks_list
      parameters:
      - name: account
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: account__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: address__apartment_number
        schema:
          type: string
      - in: query
        name: address__apartment_number__icontains
        schema:
          type: string
      - in: query
        name: address__apartment_number__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__apartment_number__iregex
        schema:
          type: string
      - in: query
        name: address__apartment_number__istartswith
        schema:
          type: string
      - in: query
        name: address__apartment_number__search
        schema:
          type: string
      - in: query
        name: address__city
        schema:
          type: string
      - in: query
        name: address__city__icontains
        schema:
          type: string
      - in: query
        name: address__city__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__city__iregex
        schema:
          type: string
      - in: query
        name: address__city__istartswith
        schema:
          type: string
      - in: query
        name: address__city__search
        schema:
          type: string
      - in: query
        name: address__country
        schema:
          type: string
      - in: query
        name: address__country__icontains
        schema:
          type: string
      - in: query
        name: address__country__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__country__iregex
        schema:
          type: string
      - in: query
        name: address__country__istartswith
        schema:
          type: string
      - in: query
        name: address__country__search
        schema:
          type: string
      - in: query
        name: address__country_code
        schema:
          type: string
      - in: query
        name: address__country_code__icontains
        schema:
          type: string
      - in: query
        name: address__country_code__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__country_code__iregex
        schema:
          type: string
      - in: query
        name: address__country_code__istartswith
        schema:
          type: string
      - in: query
        name: address__country_code__search
        schema:
          type: string
      - in: query
        name: address__formatted_address
        schema:
          type: string
      - in: query
        name: address__formatted_address__icontains
        schema:
          type: string
      - in: query
        name: address__formatted_address__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__formatted_address__iregex
        schema:
          type: string
      - in: query
        name: address__formatted_address__istartswith
        schema:
          type: string
      - in: query
        name: address__formatted_address__search
        schema:
          type: string
      - name: address__geocode_failed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocode_failed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocode_failed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocode_failed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocoded_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocoded_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocoded_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: address__geocoding_provider
        schema:
          type: string
          nullable: true
          enum:
          - Paid Services
          - Standard Services
        description: |-
          * `Paid Services` - [('google', 'Google'), ('regio-ee', 'Regio-Ee')]
          * `Standard Services` - [('janaseta', 'Jana Seta'), ('reach-u', 'Reach-U'), ('nominatim', 'Nominatim'), ('in-ads', 'In-ADS')]
      - in: query
        name: address__geocoding_provider__icontains
        schema:
          type: string
      - in: query
        name: address__geocoding_provider__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__geocoding_provider__iregex
        schema:
          type: string
      - in: query
        name: address__geocoding_provider__istartswith
        schema:
          type: string
      - in: query
        name: address__geocoding_provider__search
        schema:
          type: string
      - in: query
        name: address__google_place_id
        schema:
          type: string
      - in: query
        name: address__google_place_id__icontains
        schema:
          type: string
      - in: query
        name: address__google_place_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__google_place_id__iregex
        schema:
          type: string
      - in: query
        name: address__google_place_id__istartswith
        schema:
          type: string
      - in: query
        name: address__google_place_id__search
        schema:
          type: string
      - in: query
        name: address__house_number
        schema:
          type: string
      - in: query
        name: address__house_number__icontains
        schema:
          type: string
      - in: query
        name: address__house_number__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__house_number__iregex
        schema:
          type: string
      - in: query
        name: address__house_number__istartswith
        schema:
          type: string
      - in: query
        name: address__house_number__search
        schema:
          type: string
      - in: query
        name: address__point_of_interest
        schema:
          type: string
      - in: query
        name: address__point_of_interest__icontains
        schema:
          type: string
      - in: query
        name: address__point_of_interest__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__point_of_interest__iregex
        schema:
          type: string
      - in: query
        name: address__point_of_interest__istartswith
        schema:
          type: string
      - in: query
        name: address__point_of_interest__search
        schema:
          type: string
      - in: query
        name: address__postal_code
        schema:
          type: string
      - in: query
        name: address__postal_code__icontains
        schema:
          type: string
      - in: query
        name: address__postal_code__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__postal_code__iregex
        schema:
          type: string
      - in: query
        name: address__postal_code__istartswith
        schema:
          type: string
      - in: query
        name: address__postal_code__search
        schema:
          type: string
      - in: query
        name: address__raw_address
        schema:
          type: string
      - in: query
        name: address__raw_address__icontains
        schema:
          type: string
      - in: query
        name: address__raw_address__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__raw_address__iregex
        schema:
          type: string
      - in: query
        name: address__raw_address__istartswith
        schema:
          type: string
      - in: query
        name: address__raw_address__search
        schema:
          type: string
      - in: query
        name: address__state
        schema:
          type: string
      - in: query
        name: address__state__icontains
        schema:
          type: string
      - in: query
        name: address__state__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__state__iregex
        schema:
          type: string
      - in: query
        name: address__state__istartswith
        schema:
          type: string
      - in: query
        name: address__state__search
        schema:
          type: string
      - in: query
        name: address__street
        schema:
          type: string
      - in: query
        name: address__street__icontains
        schema:
          type: string
      - in: query
        name: address__street__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__street__iregex
        schema:
          type: string
      - in: query
        name: address__street__istartswith
        schema:
          type: string
      - in: query
        name: address__street__search
        schema:
          type: string
      - name: address_data
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - in: query
        name: address_id
        schema:
          type: string
          format: uuid
      - in: query
        name: address_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address_id__isnull
        schema:
          type: boolean
      - name: assignee
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: assignee__email
        schema:
          type: string
      - in: query
        name: assignee__email__icontains
        schema:
          type: string
      - in: query
        name: assignee__email__iregex
        schema:
          type: string
      - in: query
        name: assignee__email__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__email__istartswith
        schema:
          type: string
      - in: query
        name: assignee__email__search
        schema:
          type: string
      - in: query
        name: assignee__first_name
        schema:
          type: string
      - in: query
        name: assignee__first_name__icontains
        schema:
          type: string
      - in: query
        name: assignee__first_name__iregex
        schema:
          type: string
      - in: query
        name: assignee__first_name__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__first_name__istartswith
        schema:
          type: string
      - in: query
        name: assignee__first_name__search
        schema:
          type: string
      - name: assignee__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: assignee__last_name
        schema:
          type: string
      - in: query
        name: assignee__last_name__icontains
        schema:
          type: string
      - in: query
        name: assignee__last_name__iregex
        schema:
          type: string
      - in: query
        name: assignee__last_name__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__last_name__istartswith
        schema:
          type: string
      - in: query
        name: assignee__last_name__search
        schema:
          type: string
      - in: query
        name: assignee__password_expires_at
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__password_expires_at__gt
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__password_expires_at__gte
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__password_expires_at__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__password_expires_at__lt
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__password_expires_at__lte
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__phone
        schema:
          type: string
      - in: query
        name: assignee__phone__icontains
        schema:
          type: string
      - in: query
        name: assignee__phone__iregex
        schema:
          type: string
      - in: query
        name: assignee__phone__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__phone__istartswith
        schema:
          type: string
      - in: query
        name: assignee__phone__search
        schema:
          type: string
      - in: query
        name: assignee_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: assignee_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: assignee_id__isnull
        schema:
          type: boolean
      - in: query
        name: assignee_proximity
        schema:
          type: string
          enum:
          - away
          - near
        description: |-
          * `away` - Away
          * `near` - Near
      - in: query
        name: assignee_proximity__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: barcodes__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: barcodes__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: barcodes__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: barcodes__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: calendar_time
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: calendar_time__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: calendar_time__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: calendar_time__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: cancelled_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: cancelled_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: cancelled_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: category
        schema:
          type: string
          enum:
          - assignment
          - drop_off
          - pick_up
          - warehouse
        description: |-
          * `assignment` - Assignment
          * `pick_up` - Pick-Up
          * `drop_off` - Drop-Off
          * `warehouse` - Warehouse
      - in: query
        name: category__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: complete_after
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_after__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_after__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_after__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_before__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_before__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_before__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: contact__company__icontains
        schema:
          type: string
      - in: query
        name: contact__company__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__company__iregex
        schema:
          type: string
      - in: query
        name: contact__company__istartswith
        schema:
          type: string
      - in: query
        name: contact__company__search
        schema:
          type: string
      - in: query
        name: contact__email
        schema:
          type: string
      - in: query
        name: contact__email__icontains
        schema:
          type: string
      - in: query
        name: contact__email__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__email__iregex
        schema:
          type: string
      - in: query
        name: contact__email__istartswith
        schema:
          type: string
      - in: query
        name: contact__email__search
        schema:
          type: string
      - name: contact__emails__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated emails supported
        schema:
          type: string
        example: example1@mail.ee,example2@mail.ee
      - name: contact__emails__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated emails supported
        schema:
          type: string
        example: example1@mail.ee,example2@mail.ee
      - name: contact__emails__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: contact__emails__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated emails supported
        schema:
          type: string
        example: example1@mail.ee,example2@mail.ee
      - in: query
        name: contact__name
        schema:
          type: string
      - in: query
        name: contact__name__icontains
        schema:
          type: string
      - in: query
        name: contact__name__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__name__iregex
        schema:
          type: string
      - in: query
        name: contact__name__istartswith
        schema:
          type: string
      - in: query
        name: contact__name__search
        schema:
          type: string
      - in: query
        name: contact__notes
        schema:
          type: string
      - in: query
        name: contact__notes__icontains
        schema:
          type: string
      - in: query
        name: contact__notes__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__notes__iregex
        schema:
          type: string
      - in: query
        name: contact__notes__istartswith
        schema:
          type: string
      - in: query
        name: contact__notes__search
        schema:
          type: string
      - in: query
        name: contact__phone
        schema:
          type: string
      - in: query
        name: contact__phone__icontains
        schema:
          type: string
      - in: query
        name: contact__phone__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__phone__iregex
        schema:
          type: string
      - in: query
        name: contact__phone__istartswith
        schema:
          type: string
      - in: query
        name: contact__phone__search
        schema:
          type: string
      - name: contact__phones__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact__phones__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact__phones__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: contact__phones__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact_address
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: contact_address__external_id
        schema:
          type: string
      - in: query
        name: contact_address__external_id__icontains
        schema:
          type: string
      - in: query
        name: contact_address__external_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact_address__external_id__isnull
        schema:
          type: boolean
      - name: contact_address__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: contact_data
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - in: query
        name: contact_id
        schema:
          type: string
          format: uuid
      - in: query
        name: contact_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact_id__isnull
        schema:
          type: boolean
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: created_by
        schema:
          type: string
          format: uuid
      - in: query
        name: created_by__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: created_by__isnull
        schema:
          type: boolean
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: description
        schema:
          type: string
      - in: query
        name: description__icontains
        schema:
          type: string
      - in: query
        name: description__iregex
        schema:
          type: string
      - in: query
        name: description__istartswith
        schema:
          type: string
      - in: query
        name: description__search
        schema:
          type: string
      - in: query
        name: duration
        schema:
          type: string
          format: duration
      - in: query
        name: duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: external_id
        schema:
          type: string
      - in: query
        name: external_id__icontains
        schema:
          type: string
      - in: query
        name: external_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: external_id__iregex
        schema:
          type: string
      - in: query
        name: external_id__isnull
        schema:
          type: boolean
      - in: query
        name: external_id__istartswith
        schema:
          type: string
      - in: query
        name: external_id__search
        schema:
          type: string
      - in: query
        name: id
        schema:
          type: string
          format: uuid
      - in: query
        name: id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: is_optimal
        schema:
          type: boolean
      - in: query
        name: is_optimal__isnull
        schema:
          type: boolean
      - in: query
        name: metadata__accepted_distance
        schema:
          type: integer
      - in: query
        name: metadata__accepted_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__accepted_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__accepted_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__accepted_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__accepted_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__accepted_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__accepted_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__accepted_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__accepted_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_distance
        schema:
          type: integer
      - in: query
        name: metadata__active_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__active_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__active_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__active_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__active_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_distance
        schema:
          type: integer
      - in: query
        name: metadata__assigned_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__assigned_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__assigned_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__assigned_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__assigned_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_distance
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_distance
        schema:
          type: integer
      - in: query
        name: metadata__completed_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__completed_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__completed_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__completed_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__completed_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__documents_count
        schema:
          type: integer
      - in: query
        name: metadata__documents_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__documents_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__documents_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__documents_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__events_count
        schema:
          type: integer
      - in: query
        name: metadata__events_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__events_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__events_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__events_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__failed_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__failed_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__failed_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__failed_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__failed_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__forms_completed_count
        schema:
          type: integer
      - in: query
        name: metadata__forms_completed_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__forms_completed_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__forms_completed_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__forms_completed_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__forms_count
        schema:
          type: integer
      - in: query
        name: metadata__forms_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__forms_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__forms_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__forms_count__lte
        schema:
          type: integer
      - name: metadata__last_accepted_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_accepted_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_accepted_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_accepted_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_active_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_active_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_active_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_assigned_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_assigned_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_assigned_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_cancelled_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_cancelled_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_cancelled_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_completed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_completed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_completed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_failed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_failed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_failed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_transit_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_transit_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_transit_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_unassigned_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_unassigned_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_unassigned_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: metadata__signatures_count
        schema:
          type: integer
      - in: query
        name: metadata__signatures_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__signatures_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__signatures_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__signatures_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__transit_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__transit_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__transit_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__transit_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__transit_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_distance
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_duration__lte
        schema:
          type: string
          format: duration
      - name: metafields__namespace:key
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - name: order
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: order__auto_assign
        schema:
          type: boolean
      - name: order__created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: order__created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: order__created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: order__created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: order__created_by
        schema:
          type: string
          format: uuid
      - in: query
        name: order__created_by__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: order__created_by__isnull
        schema:
          type: boolean
      - in: query
        name: order__description
        schema:
          type: string
      - in: query
        name: order__description__icontains
        schema:
          type: string
      - in: query
        name: order__description__iregex
        schema:
          type: string
      - in: query
        name: order__description__isnull
        schema:
          type: boolean
      - in: query
        name: order__description__istartswith
        schema:
          type: string
      - in: query
        name: order__description__search
        schema:
          type: string
      - in: query
        name: order__external_id
        schema:
          type: string
      - in: query
        name: order__external_id__icontains
        schema:
          type: string
      - in: query
        name: order__external_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: order__external_id__iregex
        schema:
          type: string
      - in: query
        name: order__external_id__isnull
        schema:
          type: boolean
      - in: query
        name: order__external_id__istartswith
        schema:
          type: string
      - in: query
        name: order__external_id__search
        schema:
          type: string
      - name: order__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: order__orderer
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - in: query
        name: order__reference
        schema:
          type: string
      - in: query
        name: order__reference__icontains
        schema:
          type: string
      - in: query
        name: order__reference__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: order__reference__iregex
        schema:
          type: string
      - in: query
        name: order__reference__istartswith
        schema:
          type: string
      - in: query
        name: order__reference__search
        schema:
          type: string
      - in: query
        name: order_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: order_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: order_id__isnull
        schema:
          type: boolean
      - name: orderer
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: orderer__id
        schema:
          type: string
          format: uuid
      - in: query
        name: orderer__id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: orderer__id__isnull
        schema:
          type: boolean
      - name: orderer__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: orderer__name
        schema:
          type: string
      - in: query
        name: orderer__name__icontains
        schema:
          type: string
      - in: query
        name: orderer_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: orderer_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: orderer_id__isnull
        schema:
          type: boolean
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - in: query
        name: owner_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: owner_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: owner_id__isnull
        schema:
          type: boolean
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: position
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: position__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: position__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: position__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: previous_assignees__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated UUID values supported
        schema:
          type: string
        example: 6ca77ce2-c373-44fd-aec9-651399952b46,8a6e097e-5b6a-4e54-8a7b-646c5a919239
      - name: previous_assignees__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated UUID values supported
        schema:
          type: string
        example: 6ca77ce2-c373-44fd-aec9-651399952b46,8a6e097e-5b6a-4e54-8a7b-646c5a919239
      - name: previous_assignees__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: previous_assignees__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated UUID values supported
        schema:
          type: string
        example: 6ca77ce2-c373-44fd-aec9-651399952b46,8a6e097e-5b6a-4e54-8a7b-646c5a919239
      - in: query
        name: priority
        schema:
          type: integer
      - in: query
        name: priority__gt
        schema:
          type: integer
      - in: query
        name: priority__gte
        schema:
          type: integer
      - in: query
        name: priority__in
        schema:
          type: array
          items:
            type: integer
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: priority__lt
        schema:
          type: integer
      - in: query
        name: priority__lte
        schema:
          type: integer
      - name: receiver
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: receiver__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: receiver_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: receiver_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: receiver_id__isnull
        schema:
          type: boolean
      - in: query
        name: reference
        schema:
          type: string
      - in: query
        name: reference__icontains
        schema:
          type: string
      - in: query
        name: reference__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: reference__iregex
        schema:
          type: string
      - in: query
        name: reference__istartswith
        schema:
          type: string
      - in: query
        name: reference__search
        schema:
          type: string
      - name: route
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: route__account
        schema:
          type: string
          format: uuid
      - in: query
        name: route__account__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__account__isnull
        schema:
          type: boolean
      - in: query
        name: route__assignee
        schema:
          type: string
          format: uuid
      - in: query
        name: route__assignee__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__assignee__isnull
        schema:
          type: boolean
      - in: query
        name: route__code
        schema:
          type: string
      - in: query
        name: route__code__icontains
        schema:
          type: string
      - in: query
        name: route__code__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__code__iregex
        schema:
          type: string
      - in: query
        name: route__code__isnull
        schema:
          type: boolean
      - in: query
        name: route__code__istartswith
        schema:
          type: string
      - in: query
        name: route__code__search
        schema:
          type: string
      - in: query
        name: route__description
        schema:
          type: string
      - in: query
        name: route__description__icontains
        schema:
          type: string
      - in: query
        name: route__description__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__description__iregex
        schema:
          type: string
      - in: query
        name: route__description__isnull
        schema:
          type: boolean
      - in: query
        name: route__description__istartswith
        schema:
          type: string
      - in: query
        name: route__description__search
        schema:
          type: string
      - in: query
        name: route__end_address
        schema:
          type: string
          format: uuid
      - in: query
        name: route__end_address__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__end_address__isnull
        schema:
          type: boolean
      - in: query
        name: route__end_time
        schema:
          type: string
          format: date-time
      - in: query
        name: route__end_time__gt
        schema:
          type: string
          format: date-time
      - in: query
        name: route__end_time__gte
        schema:
          type: string
          format: date-time
      - in: query
        name: route__end_time__isnull
        schema:
          type: boolean
      - in: query
        name: route__end_time__lt
        schema:
          type: string
          format: date-time
      - in: query
        name: route__end_time__lte
        schema:
          type: string
          format: date-time
      - in: query
        name: route__external_id
        schema:
          type: string
      - in: query
        name: route__external_id__icontains
        schema:
          type: string
      - in: query
        name: route__external_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__external_id__isnull
        schema:
          type: boolean
      - name: route__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: route__metafields
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - in: query
        name: route__name
        schema:
          type: string
      - in: query
        name: route__name__icontains
        schema:
          type: string
      - in: query
        name: route__name__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__name__iregex
        schema:
          type: string
      - in: query
        name: route__name__isnull
        schema:
          type: boolean
      - in: query
        name: route__name__istartswith
        schema:
          type: string
      - in: query
        name: route__name__search
        schema:
          type: string
      - in: query
        name: route__start_address
        schema:
          type: string
          format: uuid
      - in: query
        name: route__start_address__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__start_address__isnull
        schema:
          type: boolean
      - in: query
        name: route__start_time
        schema:
          type: string
          format: date-time
      - in: query
        name: route__start_time__gt
        schema:
          type: string
          format: date-time
      - in: query
        name: route__start_time__gte
        schema:
          type: string
          format: date-time
      - in: query
        name: route__start_time__isnull
        schema:
          type: boolean
      - in: query
        name: route__start_time__lt
        schema:
          type: string
          format: date-time
      - in: query
        name: route__start_time__lte
        schema:
          type: string
          format: date-time
      - in: query
        name: route_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: route_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route_id__isnull
        schema:
          type: boolean
      - name: scheduled_time
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: scheduled_time__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: scheduled_time__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: scheduled_time__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - assignees
            - clients
            - documents
            - metadatas
            - orders
            - routes
            - signatures
            - trackers
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: assignees,clients
            summary: Regular sideloading
          MultiSourceSideloadingForDocuments:
            value: documents[documents,order__documents,recurrence__documents,contact_address__documents]
            summary: Multi source sideloading for documents
      - name: size__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated integer values supported
        schema:
          type: string
        example: 11,23
      - name: size__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated integer values supported
        schema:
          type: string
        example: 11,23
      - name: size__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: size__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated integer values supported
        schema:
          type: string
        example: 11,23
      - in: query
        name: state
        schema:
          type: string
          enum:
          - accepted
          - active
          - assigned
          - cancelled
          - completed
          - draft
          - failed
          - scheduled
          - transit
          - unassigned
        description: |-
          * `draft` - Draft
          * `scheduled` - Scheduled
          * `unassigned` - Unassigned
          * `assigned` - Assigned
          * `accepted` - Accepted
          * `transit` - Transit
          * `active` - Active
          * `completed` - Completed
          * `failed` - Failed
          * `cancelled` - Cancelled
      - name: state__in
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: state__in_or_isnull
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: state__not_in
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: state__not_in_or_isnull
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: task_import
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: task_import__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: unassignee_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: unassignee_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: unassignee_id__isnull
        schema:
          type: boolean
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at_delay_latest
        required: false
        in: query
        description: 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__gte`is used.
        example: true
        schema:
          type: boolean
      tags:
      - tasks
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedTaskSerializerV2List'
          description: ''
    post:
      operationId: tasks_create
      tags:
      - tasks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskSerializerV2'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TaskSerializerV2'
          description: ''
  /tasks/{id}/:
    get:
      operationId: tasks_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task.
        required: true
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - assignees
            - clients
            - documents
            - metadatas
            - orders
            - routes
            - signatures
            - trackers
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: assignees,clients
            summary: Regular sideloading
          MultiSourceSideloadingForDocuments:
            value: documents[documents,order__documents,recurrence__documents,contact_address__documents]
            summary: Multi source sideloading for documents
      tags:
      - tasks
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TaskSerializerV2'
          description: ''
    put:
      operationId: tasks_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task.
        required: true
      tags:
      - tasks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskSerializerV2'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TaskSerializerV2'
          description: ''
    patch:
      operationId: tasks_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task.
        required: true
      tags:
      - tasks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedTaskSerializerV2'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TaskSerializerV2'
          description: ''
  /tasks/{id}/accept/:
    post:
      operationId: tasks_accept_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task.
        required: true
      tags:
      - tasks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskAction'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TaskSerializerV2'
          description: ''
  /tasks/{id}/account_change/:
    post:
      operationId: tasks_account_change_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task.
        required: true
      tags:
      - tasks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskAccountChange'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Task'
          description: ''
  /tasks/{id}/activate/:
    post:
      operationId: tasks_activate_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task.
        required: true
      tags:
      - tasks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskAction'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TaskSerializerV2'
          description: ''
  /tasks/{id}/assign/:
    post:
      operationId: tasks_assign_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task.
        required: true
      tags:
      - tasks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskAssign'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TaskSerializerV2'
          description: ''
  /tasks/{id}/cancel/:
    post:
      operationId: tasks_cancel_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task.
        required: true
      tags:
      - tasks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskAction'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TaskSerializerV2'
          description: ''
  /tasks/{id}/complete/:
    post:
      operationId: tasks_complete_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task.
        required: true
      tags:
      - tasks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskAction'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TaskSerializerV2'
          description: ''
  /tasks/{id}/documents/:
    get:
      operationId: tasks_documents_list
      parameters:
      - name: account
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: account__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: address__apartment_number
        schema:
          type: string
      - in: query
        name: address__apartment_number__icontains
        schema:
          type: string
      - in: query
        name: address__apartment_number__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__apartment_number__iregex
        schema:
          type: string
      - in: query
        name: address__apartment_number__istartswith
        schema:
          type: string
      - in: query
        name: address__apartment_number__search
        schema:
          type: string
      - in: query
        name: address__city
        schema:
          type: string
      - in: query
        name: address__city__icontains
        schema:
          type: string
      - in: query
        name: address__city__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__city__iregex
        schema:
          type: string
      - in: query
        name: address__city__istartswith
        schema:
          type: string
      - in: query
        name: address__city__search
        schema:
          type: string
      - in: query
        name: address__country
        schema:
          type: string
      - in: query
        name: address__country__icontains
        schema:
          type: string
      - in: query
        name: address__country__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__country__iregex
        schema:
          type: string
      - in: query
        name: address__country__istartswith
        schema:
          type: string
      - in: query
        name: address__country__search
        schema:
          type: string
      - in: query
        name: address__country_code
        schema:
          type: string
      - in: query
        name: address__country_code__icontains
        schema:
          type: string
      - in: query
        name: address__country_code__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__country_code__iregex
        schema:
          type: string
      - in: query
        name: address__country_code__istartswith
        schema:
          type: string
      - in: query
        name: address__country_code__search
        schema:
          type: string
      - in: query
        name: address__formatted_address
        schema:
          type: string
      - in: query
        name: address__formatted_address__icontains
        schema:
          type: string
      - in: query
        name: address__formatted_address__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__formatted_address__iregex
        schema:
          type: string
      - in: query
        name: address__formatted_address__istartswith
        schema:
          type: string
      - in: query
        name: address__formatted_address__search
        schema:
          type: string
      - name: address__geocode_failed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocode_failed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocode_failed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocode_failed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocoded_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocoded_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocoded_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: address__geocoding_provider
        schema:
          type: string
          nullable: true
          enum:
          - Paid Services
          - Standard Services
        description: |-
          * `Paid Services` - [('google', 'Google'), ('regio-ee', 'Regio-Ee')]
          * `Standard Services` - [('janaseta', 'Jana Seta'), ('reach-u', 'Reach-U'), ('nominatim', 'Nominatim'), ('in-ads', 'In-ADS')]
      - in: query
        name: address__geocoding_provider__icontains
        schema:
          type: string
      - in: query
        name: address__geocoding_provider__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__geocoding_provider__iregex
        schema:
          type: string
      - in: query
        name: address__geocoding_provider__istartswith
        schema:
          type: string
      - in: query
        name: address__geocoding_provider__search
        schema:
          type: string
      - in: query
        name: address__google_place_id
        schema:
          type: string
      - in: query
        name: address__google_place_id__icontains
        schema:
          type: string
      - in: query
        name: address__google_place_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__google_place_id__iregex
        schema:
          type: string
      - in: query
        name: address__google_place_id__istartswith
        schema:
          type: string
      - in: query
        name: address__google_place_id__search
        schema:
          type: string
      - in: query
        name: address__house_number
        schema:
          type: string
      - in: query
        name: address__house_number__icontains
        schema:
          type: string
      - in: query
        name: address__house_number__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__house_number__iregex
        schema:
          type: string
      - in: query
        name: address__house_number__istartswith
        schema:
          type: string
      - in: query
        name: address__house_number__search
        schema:
          type: string
      - in: query
        name: address__point_of_interest
        schema:
          type: string
      - in: query
        name: address__point_of_interest__icontains
        schema:
          type: string
      - in: query
        name: address__point_of_interest__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__point_of_interest__iregex
        schema:
          type: string
      - in: query
        name: address__point_of_interest__istartswith
        schema:
          type: string
      - in: query
        name: address__point_of_interest__search
        schema:
          type: string
      - in: query
        name: address__postal_code
        schema:
          type: string
      - in: query
        name: address__postal_code__icontains
        schema:
          type: string
      - in: query
        name: address__postal_code__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__postal_code__iregex
        schema:
          type: string
      - in: query
        name: address__postal_code__istartswith
        schema:
          type: string
      - in: query
        name: address__postal_code__search
        schema:
          type: string
      - in: query
        name: address__raw_address
        schema:
          type: string
      - in: query
        name: address__raw_address__icontains
        schema:
          type: string
      - in: query
        name: address__raw_address__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__raw_address__iregex
        schema:
          type: string
      - in: query
        name: address__raw_address__istartswith
        schema:
          type: string
      - in: query
        name: address__raw_address__search
        schema:
          type: string
      - in: query
        name: address__state
        schema:
          type: string
      - in: query
        name: address__state__icontains
        schema:
          type: string
      - in: query
        name: address__state__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__state__iregex
        schema:
          type: string
      - in: query
        name: address__state__istartswith
        schema:
          type: string
      - in: query
        name: address__state__search
        schema:
          type: string
      - in: query
        name: address__street
        schema:
          type: string
      - in: query
        name: address__street__icontains
        schema:
          type: string
      - in: query
        name: address__street__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__street__iregex
        schema:
          type: string
      - in: query
        name: address__street__istartswith
        schema:
          type: string
      - in: query
        name: address__street__search
        schema:
          type: string
      - name: address_data
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - in: query
        name: address_id
        schema:
          type: string
          format: uuid
      - in: query
        name: address_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address_id__isnull
        schema:
          type: boolean
      - name: assignee
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: assignee__email
        schema:
          type: string
      - in: query
        name: assignee__email__icontains
        schema:
          type: string
      - in: query
        name: assignee__email__iregex
        schema:
          type: string
      - in: query
        name: assignee__email__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__email__istartswith
        schema:
          type: string
      - in: query
        name: assignee__email__search
        schema:
          type: string
      - in: query
        name: assignee__first_name
        schema:
          type: string
      - in: query
        name: assignee__first_name__icontains
        schema:
          type: string
      - in: query
        name: assignee__first_name__iregex
        schema:
          type: string
      - in: query
        name: assignee__first_name__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__first_name__istartswith
        schema:
          type: string
      - in: query
        name: assignee__first_name__search
        schema:
          type: string
      - name: assignee__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: assignee__last_name
        schema:
          type: string
      - in: query
        name: assignee__last_name__icontains
        schema:
          type: string
      - in: query
        name: assignee__last_name__iregex
        schema:
          type: string
      - in: query
        name: assignee__last_name__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__last_name__istartswith
        schema:
          type: string
      - in: query
        name: assignee__last_name__search
        schema:
          type: string
      - in: query
        name: assignee__password_expires_at
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__password_expires_at__gt
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__password_expires_at__gte
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__password_expires_at__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__password_expires_at__lt
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__password_expires_at__lte
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__phone
        schema:
          type: string
      - in: query
        name: assignee__phone__icontains
        schema:
          type: string
      - in: query
        name: assignee__phone__iregex
        schema:
          type: string
      - in: query
        name: assignee__phone__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__phone__istartswith
        schema:
          type: string
      - in: query
        name: assignee__phone__search
        schema:
          type: string
      - in: query
        name: assignee_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: assignee_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: assignee_id__isnull
        schema:
          type: boolean
      - in: query
        name: assignee_proximity
        schema:
          type: string
          enum:
          - away
          - near
        description: |-
          * `away` - Away
          * `near` - Near
      - in: query
        name: assignee_proximity__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: barcodes__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: barcodes__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: barcodes__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: barcodes__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: calendar_time
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: calendar_time__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: calendar_time__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: calendar_time__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: cancelled_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: cancelled_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: cancelled_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: category
        schema:
          type: string
          enum:
          - assignment
          - drop_off
          - pick_up
          - warehouse
        description: |-
          * `assignment` - Assignment
          * `pick_up` - Pick-Up
          * `drop_off` - Drop-Off
          * `warehouse` - Warehouse
      - in: query
        name: category__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: complete_after
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_after__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_after__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_after__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_before__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_before__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_before__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: contact__company__icontains
        schema:
          type: string
      - in: query
        name: contact__company__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__company__iregex
        schema:
          type: string
      - in: query
        name: contact__company__istartswith
        schema:
          type: string
      - in: query
        name: contact__company__search
        schema:
          type: string
      - in: query
        name: contact__email
        schema:
          type: string
      - in: query
        name: contact__email__icontains
        schema:
          type: string
      - in: query
        name: contact__email__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__email__iregex
        schema:
          type: string
      - in: query
        name: contact__email__istartswith
        schema:
          type: string
      - in: query
        name: contact__email__search
        schema:
          type: string
      - name: contact__emails__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated emails supported
        schema:
          type: string
        example: example1@mail.ee,example2@mail.ee
      - name: contact__emails__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated emails supported
        schema:
          type: string
        example: example1@mail.ee,example2@mail.ee
      - name: contact__emails__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: contact__emails__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated emails supported
        schema:
          type: string
        example: example1@mail.ee,example2@mail.ee
      - in: query
        name: contact__name
        schema:
          type: string
      - in: query
        name: contact__name__icontains
        schema:
          type: string
      - in: query
        name: contact__name__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__name__iregex
        schema:
          type: string
      - in: query
        name: contact__name__istartswith
        schema:
          type: string
      - in: query
        name: contact__name__search
        schema:
          type: string
      - in: query
        name: contact__notes
        schema:
          type: string
      - in: query
        name: contact__notes__icontains
        schema:
          type: string
      - in: query
        name: contact__notes__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__notes__iregex
        schema:
          type: string
      - in: query
        name: contact__notes__istartswith
        schema:
          type: string
      - in: query
        name: contact__notes__search
        schema:
          type: string
      - in: query
        name: contact__phone
        schema:
          type: string
      - in: query
        name: contact__phone__icontains
        schema:
          type: string
      - in: query
        name: contact__phone__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__phone__iregex
        schema:
          type: string
      - in: query
        name: contact__phone__istartswith
        schema:
          type: string
      - in: query
        name: contact__phone__search
        schema:
          type: string
      - name: contact__phones__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact__phones__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact__phones__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: contact__phones__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact_address
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: contact_address__external_id
        schema:
          type: string
      - in: query
        name: contact_address__external_id__icontains
        schema:
          type: string
      - in: query
        name: contact_address__external_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact_address__external_id__isnull
        schema:
          type: boolean
      - name: contact_address__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: contact_data
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - in: query
        name: contact_id
        schema:
          type: string
          format: uuid
      - in: query
        name: contact_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact_id__isnull
        schema:
          type: boolean
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: created_by
        schema:
          type: string
          format: uuid
      - in: query
        name: created_by__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: created_by__isnull
        schema:
          type: boolean
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: description
        schema:
          type: string
      - in: query
        name: description__icontains
        schema:
          type: string
      - in: query
        name: description__iregex
        schema:
          type: string
      - in: query
        name: description__istartswith
        schema:
          type: string
      - in: query
        name: description__search
        schema:
          type: string
      - in: query
        name: duration
        schema:
          type: string
          format: duration
      - in: query
        name: duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: external_id
        schema:
          type: string
      - in: query
        name: external_id__icontains
        schema:
          type: string
      - in: query
        name: external_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: external_id__iregex
        schema:
          type: string
      - in: query
        name: external_id__isnull
        schema:
          type: boolean
      - in: query
        name: external_id__istartswith
        schema:
          type: string
      - in: query
        name: external_id__search
        schema:
          type: string
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task.
        required: true
      - in: query
        name: id
        schema:
          type: string
          format: uuid
      - in: query
        name: id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: is_optimal
        schema:
          type: boolean
      - in: query
        name: is_optimal__isnull
        schema:
          type: boolean
      - in: query
        name: metadata__accepted_distance
        schema:
          type: integer
      - in: query
        name: metadata__accepted_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__accepted_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__accepted_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__accepted_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__accepted_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__accepted_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__accepted_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__accepted_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__accepted_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_distance
        schema:
          type: integer
      - in: query
        name: metadata__active_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__active_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__active_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__active_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__active_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_distance
        schema:
          type: integer
      - in: query
        name: metadata__assigned_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__assigned_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__assigned_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__assigned_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__assigned_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_distance
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_distance
        schema:
          type: integer
      - in: query
        name: metadata__completed_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__completed_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__completed_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__completed_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__completed_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__documents_count
        schema:
          type: integer
      - in: query
        name: metadata__documents_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__documents_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__documents_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__documents_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__events_count
        schema:
          type: integer
      - in: query
        name: metadata__events_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__events_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__events_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__events_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__failed_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__failed_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__failed_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__failed_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__failed_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__forms_completed_count
        schema:
          type: integer
      - in: query
        name: metadata__forms_completed_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__forms_completed_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__forms_completed_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__forms_completed_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__forms_count
        schema:
          type: integer
      - in: query
        name: metadata__forms_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__forms_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__forms_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__forms_count__lte
        schema:
          type: integer
      - name: metadata__last_accepted_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_accepted_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_accepted_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_accepted_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_active_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_active_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_active_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_assigned_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_assigned_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_assigned_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_cancelled_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_cancelled_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_cancelled_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_completed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_completed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_completed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_failed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_failed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_failed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_transit_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_transit_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_transit_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_unassigned_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_unassigned_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_unassigned_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: metadata__signatures_count
        schema:
          type: integer
      - in: query
        name: metadata__signatures_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__signatures_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__signatures_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__signatures_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__transit_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__transit_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__transit_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__transit_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__transit_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_distance
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_duration__lte
        schema:
          type: string
          format: duration
      - name: metafields__namespace:key
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - name: order
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: order__auto_assign
        schema:
          type: boolean
      - name: order__created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: order__created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: order__created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: order__created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: order__created_by
        schema:
          type: string
          format: uuid
      - in: query
        name: order__created_by__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: order__created_by__isnull
        schema:
          type: boolean
      - in: query
        name: order__description
        schema:
          type: string
      - in: query
        name: order__description__icontains
        schema:
          type: string
      - in: query
        name: order__description__iregex
        schema:
          type: string
      - in: query
        name: order__description__isnull
        schema:
          type: boolean
      - in: query
        name: order__description__istartswith
        schema:
          type: string
      - in: query
        name: order__description__search
        schema:
          type: string
      - in: query
        name: order__external_id
        schema:
          type: string
      - in: query
        name: order__external_id__icontains
        schema:
          type: string
      - in: query
        name: order__external_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: order__external_id__iregex
        schema:
          type: string
      - in: query
        name: order__external_id__isnull
        schema:
          type: boolean
      - in: query
        name: order__external_id__istartswith
        schema:
          type: string
      - in: query
        name: order__external_id__search
        schema:
          type: string
      - name: order__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: order__orderer
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - in: query
        name: order__reference
        schema:
          type: string
      - in: query
        name: order__reference__icontains
        schema:
          type: string
      - in: query
        name: order__reference__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: order__reference__iregex
        schema:
          type: string
      - in: query
        name: order__reference__istartswith
        schema:
          type: string
      - in: query
        name: order__reference__search
        schema:
          type: string
      - in: query
        name: order_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: order_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: order_id__isnull
        schema:
          type: boolean
      - name: orderer
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: orderer__id
        schema:
          type: string
          format: uuid
      - in: query
        name: orderer__id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: orderer__id__isnull
        schema:
          type: boolean
      - name: orderer__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: orderer__name
        schema:
          type: string
      - in: query
        name: orderer__name__icontains
        schema:
          type: string
      - in: query
        name: orderer_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: orderer_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: orderer_id__isnull
        schema:
          type: boolean
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - in: query
        name: owner_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: owner_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: owner_id__isnull
        schema:
          type: boolean
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: position
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: position__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: position__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: position__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: previous_assignees__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated UUID values supported
        schema:
          type: string
        example: 58665e26-6dd9-4a4e-ad9a-d0081c3b704a,e4fa3390-95a8-46e2-b53b-c1addb49edee
      - name: previous_assignees__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated UUID values supported
        schema:
          type: string
        example: 58665e26-6dd9-4a4e-ad9a-d0081c3b704a,e4fa3390-95a8-46e2-b53b-c1addb49edee
      - name: previous_assignees__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: previous_assignees__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated UUID values supported
        schema:
          type: string
        example: 58665e26-6dd9-4a4e-ad9a-d0081c3b704a,e4fa3390-95a8-46e2-b53b-c1addb49edee
      - in: query
        name: priority
        schema:
          type: integer
      - in: query
        name: priority__gt
        schema:
          type: integer
      - in: query
        name: priority__gte
        schema:
          type: integer
      - in: query
        name: priority__in
        schema:
          type: array
          items:
            type: integer
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: priority__lt
        schema:
          type: integer
      - in: query
        name: priority__lte
        schema:
          type: integer
      - name: receiver
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: receiver__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: receiver_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: receiver_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: receiver_id__isnull
        schema:
          type: boolean
      - in: query
        name: reference
        schema:
          type: string
      - in: query
        name: reference__icontains
        schema:
          type: string
      - in: query
        name: reference__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: reference__iregex
        schema:
          type: string
      - in: query
        name: reference__istartswith
        schema:
          type: string
      - in: query
        name: reference__search
        schema:
          type: string
      - name: route
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: route__account
        schema:
          type: string
          format: uuid
      - in: query
        name: route__account__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__account__isnull
        schema:
          type: boolean
      - in: query
        name: route__assignee
        schema:
          type: string
          format: uuid
      - in: query
        name: route__assignee__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__assignee__isnull
        schema:
          type: boolean
      - in: query
        name: route__code
        schema:
          type: string
      - in: query
        name: route__code__icontains
        schema:
          type: string
      - in: query
        name: route__code__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__code__iregex
        schema:
          type: string
      - in: query
        name: route__code__isnull
        schema:
          type: boolean
      - in: query
        name: route__code__istartswith
        schema:
          type: string
      - in: query
        name: route__code__search
        schema:
          type: string
      - in: query
        name: route__description
        schema:
          type: string
      - in: query
        name: route__description__icontains
        schema:
          type: string
      - in: query
        name: route__description__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__description__iregex
        schema:
          type: string
      - in: query
        name: route__description__isnull
        schema:
          type: boolean
      - in: query
        name: route__description__istartswith
        schema:
          type: string
      - in: query
        name: route__description__search
        schema:
          type: string
      - in: query
        name: route__end_address
        schema:
          type: string
          format: uuid
      - in: query
        name: route__end_address__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__end_address__isnull
        schema:
          type: boolean
      - in: query
        name: route__end_time
        schema:
          type: string
          format: date-time
      - in: query
        name: route__end_time__gt
        schema:
          type: string
          format: date-time
      - in: query
        name: route__end_time__gte
        schema:
          type: string
          format: date-time
      - in: query
        name: route__end_time__isnull
        schema:
          type: boolean
      - in: query
        name: route__end_time__lt
        schema:
          type: string
          format: date-time
      - in: query
        name: route__end_time__lte
        schema:
          type: string
          format: date-time
      - in: query
        name: route__external_id
        schema:
          type: string
      - in: query
        name: route__external_id__icontains
        schema:
          type: string
      - in: query
        name: route__external_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__external_id__isnull
        schema:
          type: boolean
      - name: route__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: route__metafields
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - in: query
        name: route__name
        schema:
          type: string
      - in: query
        name: route__name__icontains
        schema:
          type: string
      - in: query
        name: route__name__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__name__iregex
        schema:
          type: string
      - in: query
        name: route__name__isnull
        schema:
          type: boolean
      - in: query
        name: route__name__istartswith
        schema:
          type: string
      - in: query
        name: route__name__search
        schema:
          type: string
      - in: query
        name: route__start_address
        schema:
          type: string
          format: uuid
      - in: query
        name: route__start_address__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__start_address__isnull
        schema:
          type: boolean
      - in: query
        name: route__start_time
        schema:
          type: string
          format: date-time
      - in: query
        name: route__start_time__gt
        schema:
          type: string
          format: date-time
      - in: query
        name: route__start_time__gte
        schema:
          type: string
          format: date-time
      - in: query
        name: route__start_time__isnull
        schema:
          type: boolean
      - in: query
        name: route__start_time__lt
        schema:
          type: string
          format: date-time
      - in: query
        name: route__start_time__lte
        schema:
          type: string
          format: date-time
      - in: query
        name: route_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: route_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route_id__isnull
        schema:
          type: boolean
      - name: scheduled_time
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: scheduled_time__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: scheduled_time__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: scheduled_time__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - assignees
            - clients
            - documents
            - metadatas
            - orders
            - routes
            - signatures
            - trackers
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: assignees,clients
            summary: Regular sideloading
          MultiSourceSideloadingForDocuments:
            value: documents[documents,order__documents,recurrence__documents,contact_address__documents]
            summary: Multi source sideloading for documents
      - name: size__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated integer values supported
        schema:
          type: string
        example: 11,23
      - name: size__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated integer values supported
        schema:
          type: string
        example: 11,23
      - name: size__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: size__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated integer values supported
        schema:
          type: string
        example: 11,23
      - in: query
        name: state
        schema:
          type: string
          enum:
          - accepted
          - active
          - assigned
          - cancelled
          - completed
          - draft
          - failed
          - scheduled
          - transit
          - unassigned
        description: |-
          * `draft` - Draft
          * `scheduled` - Scheduled
          * `unassigned` - Unassigned
          * `assigned` - Assigned
          * `accepted` - Accepted
          * `transit` - Transit
          * `active` - Active
          * `completed` - Completed
          * `failed` - Failed
          * `cancelled` - Cancelled
      - name: state__in
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: state__in_or_isnull
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: state__not_in
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: state__not_in_or_isnull
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: task_import
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: task_import__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: unassignee_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: unassignee_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: unassignee_id__isnull
        schema:
          type: boolean
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at_delay_latest
        required: false
        in: query
        description: 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__gte`is used.
        example: true
        schema:
          type: boolean
      tags:
      - tasks
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedDocumentList'
          description: ''
  /tasks/{id}/events/:
    get:
      operationId: tasks_events_list
      parameters:
      - name: account
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: account__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: address__apartment_number
        schema:
          type: string
      - in: query
        name: address__apartment_number__icontains
        schema:
          type: string
      - in: query
        name: address__apartment_number__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__apartment_number__iregex
        schema:
          type: string
      - in: query
        name: address__apartment_number__istartswith
        schema:
          type: string
      - in: query
        name: address__apartment_number__search
        schema:
          type: string
      - in: query
        name: address__city
        schema:
          type: string
      - in: query
        name: address__city__icontains
        schema:
          type: string
      - in: query
        name: address__city__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__city__iregex
        schema:
          type: string
      - in: query
        name: address__city__istartswith
        schema:
          type: string
      - in: query
        name: address__city__search
        schema:
          type: string
      - in: query
        name: address__country
        schema:
          type: string
      - in: query
        name: address__country__icontains
        schema:
          type: string
      - in: query
        name: address__country__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__country__iregex
        schema:
          type: string
      - in: query
        name: address__country__istartswith
        schema:
          type: string
      - in: query
        name: address__country__search
        schema:
          type: string
      - in: query
        name: address__country_code
        schema:
          type: string
      - in: query
        name: address__country_code__icontains
        schema:
          type: string
      - in: query
        name: address__country_code__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__country_code__iregex
        schema:
          type: string
      - in: query
        name: address__country_code__istartswith
        schema:
          type: string
      - in: query
        name: address__country_code__search
        schema:
          type: string
      - in: query
        name: address__formatted_address
        schema:
          type: string
      - in: query
        name: address__formatted_address__icontains
        schema:
          type: string
      - in: query
        name: address__formatted_address__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__formatted_address__iregex
        schema:
          type: string
      - in: query
        name: address__formatted_address__istartswith
        schema:
          type: string
      - in: query
        name: address__formatted_address__search
        schema:
          type: string
      - name: address__geocode_failed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocode_failed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocode_failed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocode_failed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocoded_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocoded_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocoded_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: address__geocoding_provider
        schema:
          type: string
          nullable: true
          enum:
          - Paid Services
          - Standard Services
        description: |-
          * `Paid Services` - [('google', 'Google'), ('regio-ee', 'Regio-Ee')]
          * `Standard Services` - [('janaseta', 'Jana Seta'), ('reach-u', 'Reach-U'), ('nominatim', 'Nominatim'), ('in-ads', 'In-ADS')]
      - in: query
        name: address__geocoding_provider__icontains
        schema:
          type: string
      - in: query
        name: address__geocoding_provider__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__geocoding_provider__iregex
        schema:
          type: string
      - in: query
        name: address__geocoding_provider__istartswith
        schema:
          type: string
      - in: query
        name: address__geocoding_provider__search
        schema:
          type: string
      - in: query
        name: address__google_place_id
        schema:
          type: string
      - in: query
        name: address__google_place_id__icontains
        schema:
          type: string
      - in: query
        name: address__google_place_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__google_place_id__iregex
        schema:
          type: string
      - in: query
        name: address__google_place_id__istartswith
        schema:
          type: string
      - in: query
        name: address__google_place_id__search
        schema:
          type: string
      - in: query
        name: address__house_number
        schema:
          type: string
      - in: query
        name: address__house_number__icontains
        schema:
          type: string
      - in: query
        name: address__house_number__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__house_number__iregex
        schema:
          type: string
      - in: query
        name: address__house_number__istartswith
        schema:
          type: string
      - in: query
        name: address__house_number__search
        schema:
          type: string
      - in: query
        name: address__point_of_interest
        schema:
          type: string
      - in: query
        name: address__point_of_interest__icontains
        schema:
          type: string
      - in: query
        name: address__point_of_interest__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__point_of_interest__iregex
        schema:
          type: string
      - in: query
        name: address__point_of_interest__istartswith
        schema:
          type: string
      - in: query
        name: address__point_of_interest__search
        schema:
          type: string
      - in: query
        name: address__postal_code
        schema:
          type: string
      - in: query
        name: address__postal_code__icontains
        schema:
          type: string
      - in: query
        name: address__postal_code__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__postal_code__iregex
        schema:
          type: string
      - in: query
        name: address__postal_code__istartswith
        schema:
          type: string
      - in: query
        name: address__postal_code__search
        schema:
          type: string
      - in: query
        name: address__raw_address
        schema:
          type: string
      - in: query
        name: address__raw_address__icontains
        schema:
          type: string
      - in: query
        name: address__raw_address__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__raw_address__iregex
        schema:
          type: string
      - in: query
        name: address__raw_address__istartswith
        schema:
          type: string
      - in: query
        name: address__raw_address__search
        schema:
          type: string
      - in: query
        name: address__state
        schema:
          type: string
      - in: query
        name: address__state__icontains
        schema:
          type: string
      - in: query
        name: address__state__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__state__iregex
        schema:
          type: string
      - in: query
        name: address__state__istartswith
        schema:
          type: string
      - in: query
        name: address__state__search
        schema:
          type: string
      - in: query
        name: address__street
        schema:
          type: string
      - in: query
        name: address__street__icontains
        schema:
          type: string
      - in: query
        name: address__street__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__street__iregex
        schema:
          type: string
      - in: query
        name: address__street__istartswith
        schema:
          type: string
      - in: query
        name: address__street__search
        schema:
          type: string
      - name: address_data
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - in: query
        name: address_id
        schema:
          type: string
          format: uuid
      - in: query
        name: address_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address_id__isnull
        schema:
          type: boolean
      - name: assignee
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: assignee__email
        schema:
          type: string
      - in: query
        name: assignee__email__icontains
        schema:
          type: string
      - in: query
        name: assignee__email__iregex
        schema:
          type: string
      - in: query
        name: assignee__email__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__email__istartswith
        schema:
          type: string
      - in: query
        name: assignee__email__search
        schema:
          type: string
      - in: query
        name: assignee__first_name
        schema:
          type: string
      - in: query
        name: assignee__first_name__icontains
        schema:
          type: string
      - in: query
        name: assignee__first_name__iregex
        schema:
          type: string
      - in: query
        name: assignee__first_name__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__first_name__istartswith
        schema:
          type: string
      - in: query
        name: assignee__first_name__search
        schema:
          type: string
      - name: assignee__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: assignee__last_name
        schema:
          type: string
      - in: query
        name: assignee__last_name__icontains
        schema:
          type: string
      - in: query
        name: assignee__last_name__iregex
        schema:
          type: string
      - in: query
        name: assignee__last_name__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__last_name__istartswith
        schema:
          type: string
      - in: query
        name: assignee__last_name__search
        schema:
          type: string
      - in: query
        name: assignee__password_expires_at
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__password_expires_at__gt
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__password_expires_at__gte
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__password_expires_at__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__password_expires_at__lt
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__password_expires_at__lte
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__phone
        schema:
          type: string
      - in: query
        name: assignee__phone__icontains
        schema:
          type: string
      - in: query
        name: assignee__phone__iregex
        schema:
          type: string
      - in: query
        name: assignee__phone__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__phone__istartswith
        schema:
          type: string
      - in: query
        name: assignee__phone__search
        schema:
          type: string
      - in: query
        name: assignee_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: assignee_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: assignee_id__isnull
        schema:
          type: boolean
      - in: query
        name: assignee_proximity
        schema:
          type: string
          enum:
          - away
          - near
        description: |-
          * `away` - Away
          * `near` - Near
      - in: query
        name: assignee_proximity__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: barcodes__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: barcodes__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: barcodes__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: barcodes__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: calendar_time
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: calendar_time__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: calendar_time__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: calendar_time__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: cancelled_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: cancelled_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: cancelled_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: category
        schema:
          type: string
          enum:
          - assignment
          - drop_off
          - pick_up
          - warehouse
        description: |-
          * `assignment` - Assignment
          * `pick_up` - Pick-Up
          * `drop_off` - Drop-Off
          * `warehouse` - Warehouse
      - in: query
        name: category__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: complete_after
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_after__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_after__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_after__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_before__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_before__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_before__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: contact__company__icontains
        schema:
          type: string
      - in: query
        name: contact__company__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__company__iregex
        schema:
          type: string
      - in: query
        name: contact__company__istartswith
        schema:
          type: string
      - in: query
        name: contact__company__search
        schema:
          type: string
      - in: query
        name: contact__email
        schema:
          type: string
      - in: query
        name: contact__email__icontains
        schema:
          type: string
      - in: query
        name: contact__email__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__email__iregex
        schema:
          type: string
      - in: query
        name: contact__email__istartswith
        schema:
          type: string
      - in: query
        name: contact__email__search
        schema:
          type: string
      - name: contact__emails__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated emails supported
        schema:
          type: string
        example: example1@mail.ee,example2@mail.ee
      - name: contact__emails__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated emails supported
        schema:
          type: string
        example: example1@mail.ee,example2@mail.ee
      - name: contact__emails__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: contact__emails__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated emails supported
        schema:
          type: string
        example: example1@mail.ee,example2@mail.ee
      - in: query
        name: contact__name
        schema:
          type: string
      - in: query
        name: contact__name__icontains
        schema:
          type: string
      - in: query
        name: contact__name__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__name__iregex
        schema:
          type: string
      - in: query
        name: contact__name__istartswith
        schema:
          type: string
      - in: query
        name: contact__name__search
        schema:
          type: string
      - in: query
        name: contact__notes
        schema:
          type: string
      - in: query
        name: contact__notes__icontains
        schema:
          type: string
      - in: query
        name: contact__notes__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__notes__iregex
        schema:
          type: string
      - in: query
        name: contact__notes__istartswith
        schema:
          type: string
      - in: query
        name: contact__notes__search
        schema:
          type: string
      - in: query
        name: contact__phone
        schema:
          type: string
      - in: query
        name: contact__phone__icontains
        schema:
          type: string
      - in: query
        name: contact__phone__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__phone__iregex
        schema:
          type: string
      - in: query
        name: contact__phone__istartswith
        schema:
          type: string
      - in: query
        name: contact__phone__search
        schema:
          type: string
      - name: contact__phones__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact__phones__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact__phones__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: contact__phones__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact_address
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: contact_address__external_id
        schema:
          type: string
      - in: query
        name: contact_address__external_id__icontains
        schema:
          type: string
      - in: query
        name: contact_address__external_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact_address__external_id__isnull
        schema:
          type: boolean
      - name: contact_address__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: contact_data
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - in: query
        name: contact_id
        schema:
          type: string
          format: uuid
      - in: query
        name: contact_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact_id__isnull
        schema:
          type: boolean
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: created_by
        schema:
          type: string
          format: uuid
      - in: query
        name: created_by__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: created_by__isnull
        schema:
          type: boolean
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: description
        schema:
          type: string
      - in: query
        name: description__icontains
        schema:
          type: string
      - in: query
        name: description__iregex
        schema:
          type: string
      - in: query
        name: description__istartswith
        schema:
          type: string
      - in: query
        name: description__search
        schema:
          type: string
      - in: query
        name: duration
        schema:
          type: string
          format: duration
      - in: query
        name: duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: external_id
        schema:
          type: string
      - in: query
        name: external_id__icontains
        schema:
          type: string
      - in: query
        name: external_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: external_id__iregex
        schema:
          type: string
      - in: query
        name: external_id__isnull
        schema:
          type: boolean
      - in: query
        name: external_id__istartswith
        schema:
          type: string
      - in: query
        name: external_id__search
        schema:
          type: string
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task.
        required: true
      - in: query
        name: id
        schema:
          type: string
          format: uuid
      - in: query
        name: id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: is_optimal
        schema:
          type: boolean
      - in: query
        name: is_optimal__isnull
        schema:
          type: boolean
      - in: query
        name: metadata__accepted_distance
        schema:
          type: integer
      - in: query
        name: metadata__accepted_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__accepted_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__accepted_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__accepted_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__accepted_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__accepted_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__accepted_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__accepted_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__accepted_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_distance
        schema:
          type: integer
      - in: query
        name: metadata__active_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__active_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__active_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__active_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__active_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_distance
        schema:
          type: integer
      - in: query
        name: metadata__assigned_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__assigned_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__assigned_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__assigned_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__assigned_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_distance
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_distance
        schema:
          type: integer
      - in: query
        name: metadata__completed_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__completed_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__completed_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__completed_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__completed_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__documents_count
        schema:
          type: integer
      - in: query
        name: metadata__documents_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__documents_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__documents_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__documents_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__events_count
        schema:
          type: integer
      - in: query
        name: metadata__events_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__events_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__events_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__events_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__failed_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__failed_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__failed_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__failed_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__failed_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__forms_completed_count
        schema:
          type: integer
      - in: query
        name: metadata__forms_completed_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__forms_completed_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__forms_completed_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__forms_completed_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__forms_count
        schema:
          type: integer
      - in: query
        name: metadata__forms_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__forms_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__forms_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__forms_count__lte
        schema:
          type: integer
      - name: metadata__last_accepted_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_accepted_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_accepted_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_accepted_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_active_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_active_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_active_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_assigned_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_assigned_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_assigned_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_cancelled_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_cancelled_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_cancelled_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_completed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_completed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_completed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_failed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_failed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_failed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_transit_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_transit_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_transit_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_unassigned_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_unassigned_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_unassigned_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: metadata__signatures_count
        schema:
          type: integer
      - in: query
        name: metadata__signatures_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__signatures_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__signatures_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__signatures_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__transit_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__transit_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__transit_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__transit_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__transit_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_distance
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_duration__lte
        schema:
          type: string
          format: duration
      - name: metafields__namespace:key
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - name: order
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: order__auto_assign
        schema:
          type: boolean
      - name: order__created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: order__created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: order__created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: order__created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: order__created_by
        schema:
          type: string
          format: uuid
      - in: query
        name: order__created_by__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: order__created_by__isnull
        schema:
          type: boolean
      - in: query
        name: order__description
        schema:
          type: string
      - in: query
        name: order__description__icontains
        schema:
          type: string
      - in: query
        name: order__description__iregex
        schema:
          type: string
      - in: query
        name: order__description__isnull
        schema:
          type: boolean
      - in: query
        name: order__description__istartswith
        schema:
          type: string
      - in: query
        name: order__description__search
        schema:
          type: string
      - in: query
        name: order__external_id
        schema:
          type: string
      - in: query
        name: order__external_id__icontains
        schema:
          type: string
      - in: query
        name: order__external_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: order__external_id__iregex
        schema:
          type: string
      - in: query
        name: order__external_id__isnull
        schema:
          type: boolean
      - in: query
        name: order__external_id__istartswith
        schema:
          type: string
      - in: query
        name: order__external_id__search
        schema:
          type: string
      - name: order__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: order__orderer
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - in: query
        name: order__reference
        schema:
          type: string
      - in: query
        name: order__reference__icontains
        schema:
          type: string
      - in: query
        name: order__reference__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: order__reference__iregex
        schema:
          type: string
      - in: query
        name: order__reference__istartswith
        schema:
          type: string
      - in: query
        name: order__reference__search
        schema:
          type: string
      - in: query
        name: order_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: order_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: order_id__isnull
        schema:
          type: boolean
      - name: orderer
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: orderer__id
        schema:
          type: string
          format: uuid
      - in: query
        name: orderer__id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: orderer__id__isnull
        schema:
          type: boolean
      - name: orderer__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: orderer__name
        schema:
          type: string
      - in: query
        name: orderer__name__icontains
        schema:
          type: string
      - in: query
        name: orderer_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: orderer_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: orderer_id__isnull
        schema:
          type: boolean
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - in: query
        name: owner_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: owner_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: owner_id__isnull
        schema:
          type: boolean
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: position
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: position__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: position__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: position__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: previous_assignees__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated UUID values supported
        schema:
          type: string
        example: 8c42764d-ca44-4c6e-883e-a3e99ff78e1d,bc1b19fd-2979-4d26-a31a-2a1c3e29426e
      - name: previous_assignees__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated UUID values supported
        schema:
          type: string
        example: 8c42764d-ca44-4c6e-883e-a3e99ff78e1d,bc1b19fd-2979-4d26-a31a-2a1c3e29426e
      - name: previous_assignees__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: previous_assignees__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated UUID values supported
        schema:
          type: string
        example: 8c42764d-ca44-4c6e-883e-a3e99ff78e1d,bc1b19fd-2979-4d26-a31a-2a1c3e29426e
      - in: query
        name: priority
        schema:
          type: integer
      - in: query
        name: priority__gt
        schema:
          type: integer
      - in: query
        name: priority__gte
        schema:
          type: integer
      - in: query
        name: priority__in
        schema:
          type: array
          items:
            type: integer
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: priority__lt
        schema:
          type: integer
      - in: query
        name: priority__lte
        schema:
          type: integer
      - name: receiver
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: receiver__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: receiver_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: receiver_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: receiver_id__isnull
        schema:
          type: boolean
      - in: query
        name: reference
        schema:
          type: string
      - in: query
        name: reference__icontains
        schema:
          type: string
      - in: query
        name: reference__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: reference__iregex
        schema:
          type: string
      - in: query
        name: reference__istartswith
        schema:
          type: string
      - in: query
        name: reference__search
        schema:
          type: string
      - name: route
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: route__account
        schema:
          type: string
          format: uuid
      - in: query
        name: route__account__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__account__isnull
        schema:
          type: boolean
      - in: query
        name: route__assignee
        schema:
          type: string
          format: uuid
      - in: query
        name: route__assignee__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__assignee__isnull
        schema:
          type: boolean
      - in: query
        name: route__code
        schema:
          type: string
      - in: query
        name: route__code__icontains
        schema:
          type: string
      - in: query
        name: route__code__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__code__iregex
        schema:
          type: string
      - in: query
        name: route__code__isnull
        schema:
          type: boolean
      - in: query
        name: route__code__istartswith
        schema:
          type: string
      - in: query
        name: route__code__search
        schema:
          type: string
      - in: query
        name: route__description
        schema:
          type: string
      - in: query
        name: route__description__icontains
        schema:
          type: string
      - in: query
        name: route__description__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__description__iregex
        schema:
          type: string
      - in: query
        name: route__description__isnull
        schema:
          type: boolean
      - in: query
        name: route__description__istartswith
        schema:
          type: string
      - in: query
        name: route__description__search
        schema:
          type: string
      - in: query
        name: route__end_address
        schema:
          type: string
          format: uuid
      - in: query
        name: route__end_address__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__end_address__isnull
        schema:
          type: boolean
      - in: query
        name: route__end_time
        schema:
          type: string
          format: date-time
      - in: query
        name: route__end_time__gt
        schema:
          type: string
          format: date-time
      - in: query
        name: route__end_time__gte
        schema:
          type: string
          format: date-time
      - in: query
        name: route__end_time__isnull
        schema:
          type: boolean
      - in: query
        name: route__end_time__lt
        schema:
          type: string
          format: date-time
      - in: query
        name: route__end_time__lte
        schema:
          type: string
          format: date-time
      - in: query
        name: route__external_id
        schema:
          type: string
      - in: query
        name: route__external_id__icontains
        schema:
          type: string
      - in: query
        name: route__external_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__external_id__isnull
        schema:
          type: boolean
      - name: route__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: route__metafields
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - in: query
        name: route__name
        schema:
          type: string
      - in: query
        name: route__name__icontains
        schema:
          type: string
      - in: query
        name: route__name__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__name__iregex
        schema:
          type: string
      - in: query
        name: route__name__isnull
        schema:
          type: boolean
      - in: query
        name: route__name__istartswith
        schema:
          type: string
      - in: query
        name: route__name__search
        schema:
          type: string
      - in: query
        name: route__start_address
        schema:
          type: string
          format: uuid
      - in: query
        name: route__start_address__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__start_address__isnull
        schema:
          type: boolean
      - in: query
        name: route__start_time
        schema:
          type: string
          format: date-time
      - in: query
        name: route__start_time__gt
        schema:
          type: string
          format: date-time
      - in: query
        name: route__start_time__gte
        schema:
          type: string
          format: date-time
      - in: query
        name: route__start_time__isnull
        schema:
          type: boolean
      - in: query
        name: route__start_time__lt
        schema:
          type: string
          format: date-time
      - in: query
        name: route__start_time__lte
        schema:
          type: string
          format: date-time
      - in: query
        name: route_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: route_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route_id__isnull
        schema:
          type: boolean
      - name: scheduled_time
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: scheduled_time__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: scheduled_time__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: scheduled_time__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - assignees
            - clients
            - documents
            - metadatas
            - orders
            - routes
            - signatures
            - trackers
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: assignees,clients
            summary: Regular sideloading
          MultiSourceSideloadingForDocuments:
            value: documents[documents,order__documents,recurrence__documents,contact_address__documents]
            summary: Multi source sideloading for documents
      - name: size__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated integer values supported
        schema:
          type: string
        example: 11,23
      - name: size__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated integer values supported
        schema:
          type: string
        example: 11,23
      - name: size__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: size__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated integer values supported
        schema:
          type: string
        example: 11,23
      - in: query
        name: state
        schema:
          type: string
          enum:
          - accepted
          - active
          - assigned
          - cancelled
          - completed
          - draft
          - failed
          - scheduled
          - transit
          - unassigned
        description: |-
          * `draft` - Draft
          * `scheduled` - Scheduled
          * `unassigned` - Unassigned
          * `assigned` - Assigned
          * `accepted` - Accepted
          * `transit` - Transit
          * `active` - Active
          * `completed` - Completed
          * `failed` - Failed
          * `cancelled` - Cancelled
      - name: state__in
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: state__in_or_isnull
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: state__not_in
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: state__not_in_or_isnull
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: task_import
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: task_import__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: unassignee_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: unassignee_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: unassignee_id__isnull
        schema:
          type: boolean
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at_delay_latest
        required: false
        in: query
        description: 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__gte`is used.
        example: true
        schema:
          type: boolean
      tags:
      - tasks
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedTaskEventList'
          description: ''
  /tasks/{id}/fail/:
    post:
      operationId: tasks_fail_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task.
        required: true
      tags:
      - tasks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskAction'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TaskSerializerV2'
          description: ''
  /tasks/{id}/pod/:
    get:
      operationId: tasks_pod_retrieve
      description: Returns a rendered POD
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - html
          - pdf
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task.
        required: true
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - assignees
            - clients
            - documents
            - metadatas
            - orders
            - routes
            - signatures
            - trackers
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: assignees,clients
            summary: Regular sideloading
          MultiSourceSideloadingForDocuments:
            value: documents[documents,order__documents,recurrence__documents,contact_address__documents]
            summary: Multi source sideloading for documents
      tags:
      - tasks
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            text/html; version=2.11.9:
              schema:
                type: string
            application/pdf; version=2.11.9:
              schema:
                type: string
                format: byte
          description: ''
  /tasks/{id}/reject/:
    post:
      operationId: tasks_reject_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task.
        required: true
      tags:
      - tasks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskAction'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TaskSerializerV2'
          description: ''
  /tasks/{id}/signatures/:
    get:
      operationId: tasks_signatures_list
      parameters:
      - name: account
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: account__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: address__apartment_number
        schema:
          type: string
      - in: query
        name: address__apartment_number__icontains
        schema:
          type: string
      - in: query
        name: address__apartment_number__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__apartment_number__iregex
        schema:
          type: string
      - in: query
        name: address__apartment_number__istartswith
        schema:
          type: string
      - in: query
        name: address__apartment_number__search
        schema:
          type: string
      - in: query
        name: address__city
        schema:
          type: string
      - in: query
        name: address__city__icontains
        schema:
          type: string
      - in: query
        name: address__city__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__city__iregex
        schema:
          type: string
      - in: query
        name: address__city__istartswith
        schema:
          type: string
      - in: query
        name: address__city__search
        schema:
          type: string
      - in: query
        name: address__country
        schema:
          type: string
      - in: query
        name: address__country__icontains
        schema:
          type: string
      - in: query
        name: address__country__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__country__iregex
        schema:
          type: string
      - in: query
        name: address__country__istartswith
        schema:
          type: string
      - in: query
        name: address__country__search
        schema:
          type: string
      - in: query
        name: address__country_code
        schema:
          type: string
      - in: query
        name: address__country_code__icontains
        schema:
          type: string
      - in: query
        name: address__country_code__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__country_code__iregex
        schema:
          type: string
      - in: query
        name: address__country_code__istartswith
        schema:
          type: string
      - in: query
        name: address__country_code__search
        schema:
          type: string
      - in: query
        name: address__formatted_address
        schema:
          type: string
      - in: query
        name: address__formatted_address__icontains
        schema:
          type: string
      - in: query
        name: address__formatted_address__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__formatted_address__iregex
        schema:
          type: string
      - in: query
        name: address__formatted_address__istartswith
        schema:
          type: string
      - in: query
        name: address__formatted_address__search
        schema:
          type: string
      - name: address__geocode_failed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocode_failed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocode_failed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocode_failed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocoded_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocoded_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocoded_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: address__geocoding_provider
        schema:
          type: string
          nullable: true
          enum:
          - Paid Services
          - Standard Services
        description: |-
          * `Paid Services` - [('google', 'Google'), ('regio-ee', 'Regio-Ee')]
          * `Standard Services` - [('janaseta', 'Jana Seta'), ('reach-u', 'Reach-U'), ('nominatim', 'Nominatim'), ('in-ads', 'In-ADS')]
      - in: query
        name: address__geocoding_provider__icontains
        schema:
          type: string
      - in: query
        name: address__geocoding_provider__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__geocoding_provider__iregex
        schema:
          type: string
      - in: query
        name: address__geocoding_provider__istartswith
        schema:
          type: string
      - in: query
        name: address__geocoding_provider__search
        schema:
          type: string
      - in: query
        name: address__google_place_id
        schema:
          type: string
      - in: query
        name: address__google_place_id__icontains
        schema:
          type: string
      - in: query
        name: address__google_place_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__google_place_id__iregex
        schema:
          type: string
      - in: query
        name: address__google_place_id__istartswith
        schema:
          type: string
      - in: query
        name: address__google_place_id__search
        schema:
          type: string
      - in: query
        name: address__house_number
        schema:
          type: string
      - in: query
        name: address__house_number__icontains
        schema:
          type: string
      - in: query
        name: address__house_number__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__house_number__iregex
        schema:
          type: string
      - in: query
        name: address__house_number__istartswith
        schema:
          type: string
      - in: query
        name: address__house_number__search
        schema:
          type: string
      - in: query
        name: address__point_of_interest
        schema:
          type: string
      - in: query
        name: address__point_of_interest__icontains
        schema:
          type: string
      - in: query
        name: address__point_of_interest__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__point_of_interest__iregex
        schema:
          type: string
      - in: query
        name: address__point_of_interest__istartswith
        schema:
          type: string
      - in: query
        name: address__point_of_interest__search
        schema:
          type: string
      - in: query
        name: address__postal_code
        schema:
          type: string
      - in: query
        name: address__postal_code__icontains
        schema:
          type: string
      - in: query
        name: address__postal_code__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__postal_code__iregex
        schema:
          type: string
      - in: query
        name: address__postal_code__istartswith
        schema:
          type: string
      - in: query
        name: address__postal_code__search
        schema:
          type: string
      - in: query
        name: address__raw_address
        schema:
          type: string
      - in: query
        name: address__raw_address__icontains
        schema:
          type: string
      - in: query
        name: address__raw_address__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__raw_address__iregex
        schema:
          type: string
      - in: query
        name: address__raw_address__istartswith
        schema:
          type: string
      - in: query
        name: address__raw_address__search
        schema:
          type: string
      - in: query
        name: address__state
        schema:
          type: string
      - in: query
        name: address__state__icontains
        schema:
          type: string
      - in: query
        name: address__state__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__state__iregex
        schema:
          type: string
      - in: query
        name: address__state__istartswith
        schema:
          type: string
      - in: query
        name: address__state__search
        schema:
          type: string
      - in: query
        name: address__street
        schema:
          type: string
      - in: query
        name: address__street__icontains
        schema:
          type: string
      - in: query
        name: address__street__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__street__iregex
        schema:
          type: string
      - in: query
        name: address__street__istartswith
        schema:
          type: string
      - in: query
        name: address__street__search
        schema:
          type: string
      - name: address_data
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - in: query
        name: address_id
        schema:
          type: string
          format: uuid
      - in: query
        name: address_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address_id__isnull
        schema:
          type: boolean
      - name: assignee
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: assignee__email
        schema:
          type: string
      - in: query
        name: assignee__email__icontains
        schema:
          type: string
      - in: query
        name: assignee__email__iregex
        schema:
          type: string
      - in: query
        name: assignee__email__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__email__istartswith
        schema:
          type: string
      - in: query
        name: assignee__email__search
        schema:
          type: string
      - in: query
        name: assignee__first_name
        schema:
          type: string
      - in: query
        name: assignee__first_name__icontains
        schema:
          type: string
      - in: query
        name: assignee__first_name__iregex
        schema:
          type: string
      - in: query
        name: assignee__first_name__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__first_name__istartswith
        schema:
          type: string
      - in: query
        name: assignee__first_name__search
        schema:
          type: string
      - name: assignee__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: assignee__last_name
        schema:
          type: string
      - in: query
        name: assignee__last_name__icontains
        schema:
          type: string
      - in: query
        name: assignee__last_name__iregex
        schema:
          type: string
      - in: query
        name: assignee__last_name__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__last_name__istartswith
        schema:
          type: string
      - in: query
        name: assignee__last_name__search
        schema:
          type: string
      - in: query
        name: assignee__password_expires_at
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__password_expires_at__gt
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__password_expires_at__gte
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__password_expires_at__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__password_expires_at__lt
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__password_expires_at__lte
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__phone
        schema:
          type: string
      - in: query
        name: assignee__phone__icontains
        schema:
          type: string
      - in: query
        name: assignee__phone__iregex
        schema:
          type: string
      - in: query
        name: assignee__phone__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__phone__istartswith
        schema:
          type: string
      - in: query
        name: assignee__phone__search
        schema:
          type: string
      - in: query
        name: assignee_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: assignee_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: assignee_id__isnull
        schema:
          type: boolean
      - in: query
        name: assignee_proximity
        schema:
          type: string
          enum:
          - away
          - near
        description: |-
          * `away` - Away
          * `near` - Near
      - in: query
        name: assignee_proximity__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: barcodes__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: barcodes__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: barcodes__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: barcodes__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: calendar_time
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: calendar_time__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: calendar_time__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: calendar_time__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: cancelled_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: cancelled_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: cancelled_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: category
        schema:
          type: string
          enum:
          - assignment
          - drop_off
          - pick_up
          - warehouse
        description: |-
          * `assignment` - Assignment
          * `pick_up` - Pick-Up
          * `drop_off` - Drop-Off
          * `warehouse` - Warehouse
      - in: query
        name: category__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: complete_after
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_after__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_after__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_after__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_before__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_before__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_before__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: contact__company__icontains
        schema:
          type: string
      - in: query
        name: contact__company__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__company__iregex
        schema:
          type: string
      - in: query
        name: contact__company__istartswith
        schema:
          type: string
      - in: query
        name: contact__company__search
        schema:
          type: string
      - in: query
        name: contact__email
        schema:
          type: string
      - in: query
        name: contact__email__icontains
        schema:
          type: string
      - in: query
        name: contact__email__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__email__iregex
        schema:
          type: string
      - in: query
        name: contact__email__istartswith
        schema:
          type: string
      - in: query
        name: contact__email__search
        schema:
          type: string
      - name: contact__emails__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated emails supported
        schema:
          type: string
        example: example1@mail.ee,example2@mail.ee
      - name: contact__emails__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated emails supported
        schema:
          type: string
        example: example1@mail.ee,example2@mail.ee
      - name: contact__emails__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: contact__emails__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated emails supported
        schema:
          type: string
        example: example1@mail.ee,example2@mail.ee
      - in: query
        name: contact__name
        schema:
          type: string
      - in: query
        name: contact__name__icontains
        schema:
          type: string
      - in: query
        name: contact__name__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__name__iregex
        schema:
          type: string
      - in: query
        name: contact__name__istartswith
        schema:
          type: string
      - in: query
        name: contact__name__search
        schema:
          type: string
      - in: query
        name: contact__notes
        schema:
          type: string
      - in: query
        name: contact__notes__icontains
        schema:
          type: string
      - in: query
        name: contact__notes__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__notes__iregex
        schema:
          type: string
      - in: query
        name: contact__notes__istartswith
        schema:
          type: string
      - in: query
        name: contact__notes__search
        schema:
          type: string
      - in: query
        name: contact__phone
        schema:
          type: string
      - in: query
        name: contact__phone__icontains
        schema:
          type: string
      - in: query
        name: contact__phone__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__phone__iregex
        schema:
          type: string
      - in: query
        name: contact__phone__istartswith
        schema:
          type: string
      - in: query
        name: contact__phone__search
        schema:
          type: string
      - name: contact__phones__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact__phones__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact__phones__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: contact__phones__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact_address
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: contact_address__external_id
        schema:
          type: string
      - in: query
        name: contact_address__external_id__icontains
        schema:
          type: string
      - in: query
        name: contact_address__external_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact_address__external_id__isnull
        schema:
          type: boolean
      - name: contact_address__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: contact_data
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - in: query
        name: contact_id
        schema:
          type: string
          format: uuid
      - in: query
        name: contact_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact_id__isnull
        schema:
          type: boolean
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: created_by
        schema:
          type: string
          format: uuid
      - in: query
        name: created_by__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: created_by__isnull
        schema:
          type: boolean
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: description
        schema:
          type: string
      - in: query
        name: description__icontains
        schema:
          type: string
      - in: query
        name: description__iregex
        schema:
          type: string
      - in: query
        name: description__istartswith
        schema:
          type: string
      - in: query
        name: description__search
        schema:
          type: string
      - in: query
        name: duration
        schema:
          type: string
          format: duration
      - in: query
        name: duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: external_id
        schema:
          type: string
      - in: query
        name: external_id__icontains
        schema:
          type: string
      - in: query
        name: external_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: external_id__iregex
        schema:
          type: string
      - in: query
        name: external_id__isnull
        schema:
          type: boolean
      - in: query
        name: external_id__istartswith
        schema:
          type: string
      - in: query
        name: external_id__search
        schema:
          type: string
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task.
        required: true
      - in: query
        name: id
        schema:
          type: string
          format: uuid
      - in: query
        name: id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: is_optimal
        schema:
          type: boolean
      - in: query
        name: is_optimal__isnull
        schema:
          type: boolean
      - in: query
        name: metadata__accepted_distance
        schema:
          type: integer
      - in: query
        name: metadata__accepted_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__accepted_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__accepted_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__accepted_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__accepted_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__accepted_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__accepted_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__accepted_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__accepted_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_distance
        schema:
          type: integer
      - in: query
        name: metadata__active_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__active_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__active_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__active_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__active_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_distance
        schema:
          type: integer
      - in: query
        name: metadata__assigned_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__assigned_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__assigned_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__assigned_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__assigned_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_distance
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_distance
        schema:
          type: integer
      - in: query
        name: metadata__completed_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__completed_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__completed_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__completed_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__completed_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__documents_count
        schema:
          type: integer
      - in: query
        name: metadata__documents_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__documents_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__documents_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__documents_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__events_count
        schema:
          type: integer
      - in: query
        name: metadata__events_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__events_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__events_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__events_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__failed_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__failed_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__failed_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__failed_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__failed_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__forms_completed_count
        schema:
          type: integer
      - in: query
        name: metadata__forms_completed_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__forms_completed_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__forms_completed_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__forms_completed_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__forms_count
        schema:
          type: integer
      - in: query
        name: metadata__forms_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__forms_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__forms_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__forms_count__lte
        schema:
          type: integer
      - name: metadata__last_accepted_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_accepted_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_accepted_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_accepted_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_active_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_active_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_active_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_assigned_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_assigned_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_assigned_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_cancelled_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_cancelled_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_cancelled_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_completed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_completed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_completed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_failed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_failed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_failed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_transit_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_transit_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_transit_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_unassigned_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_unassigned_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_unassigned_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: metadata__signatures_count
        schema:
          type: integer
      - in: query
        name: metadata__signatures_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__signatures_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__signatures_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__signatures_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__transit_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__transit_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__transit_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__transit_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__transit_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_distance
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_duration__lte
        schema:
          type: string
          format: duration
      - name: metafields__namespace:key
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - name: order
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: order__auto_assign
        schema:
          type: boolean
      - name: order__created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: order__created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: order__created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: order__created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: order__created_by
        schema:
          type: string
          format: uuid
      - in: query
        name: order__created_by__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: order__created_by__isnull
        schema:
          type: boolean
      - in: query
        name: order__description
        schema:
          type: string
      - in: query
        name: order__description__icontains
        schema:
          type: string
      - in: query
        name: order__description__iregex
        schema:
          type: string
      - in: query
        name: order__description__isnull
        schema:
          type: boolean
      - in: query
        name: order__description__istartswith
        schema:
          type: string
      - in: query
        name: order__description__search
        schema:
          type: string
      - in: query
        name: order__external_id
        schema:
          type: string
      - in: query
        name: order__external_id__icontains
        schema:
          type: string
      - in: query
        name: order__external_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: order__external_id__iregex
        schema:
          type: string
      - in: query
        name: order__external_id__isnull
        schema:
          type: boolean
      - in: query
        name: order__external_id__istartswith
        schema:
          type: string
      - in: query
        name: order__external_id__search
        schema:
          type: string
      - name: order__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: order__orderer
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - in: query
        name: order__reference
        schema:
          type: string
      - in: query
        name: order__reference__icontains
        schema:
          type: string
      - in: query
        name: order__reference__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: order__reference__iregex
        schema:
          type: string
      - in: query
        name: order__reference__istartswith
        schema:
          type: string
      - in: query
        name: order__reference__search
        schema:
          type: string
      - in: query
        name: order_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: order_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: order_id__isnull
        schema:
          type: boolean
      - name: orderer
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: orderer__id
        schema:
          type: string
          format: uuid
      - in: query
        name: orderer__id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: orderer__id__isnull
        schema:
          type: boolean
      - name: orderer__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: orderer__name
        schema:
          type: string
      - in: query
        name: orderer__name__icontains
        schema:
          type: string
      - in: query
        name: orderer_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: orderer_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: orderer_id__isnull
        schema:
          type: boolean
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - in: query
        name: owner_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: owner_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: owner_id__isnull
        schema:
          type: boolean
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: position
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: position__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: position__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: position__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: previous_assignees__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated UUID values supported
        schema:
          type: string
        example: 244dcd1a-6a34-4771-a73c-93747206325f,15b2432e-005d-4c3a-a674-79914be04669
      - name: previous_assignees__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated UUID values supported
        schema:
          type: string
        example: 244dcd1a-6a34-4771-a73c-93747206325f,15b2432e-005d-4c3a-a674-79914be04669
      - name: previous_assignees__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: previous_assignees__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated UUID values supported
        schema:
          type: string
        example: 244dcd1a-6a34-4771-a73c-93747206325f,15b2432e-005d-4c3a-a674-79914be04669
      - in: query
        name: priority
        schema:
          type: integer
      - in: query
        name: priority__gt
        schema:
          type: integer
      - in: query
        name: priority__gte
        schema:
          type: integer
      - in: query
        name: priority__in
        schema:
          type: array
          items:
            type: integer
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: priority__lt
        schema:
          type: integer
      - in: query
        name: priority__lte
        schema:
          type: integer
      - name: receiver
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: receiver__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: receiver_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: receiver_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: receiver_id__isnull
        schema:
          type: boolean
      - in: query
        name: reference
        schema:
          type: string
      - in: query
        name: reference__icontains
        schema:
          type: string
      - in: query
        name: reference__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: reference__iregex
        schema:
          type: string
      - in: query
        name: reference__istartswith
        schema:
          type: string
      - in: query
        name: reference__search
        schema:
          type: string
      - name: route
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: route__account
        schema:
          type: string
          format: uuid
      - in: query
        name: route__account__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__account__isnull
        schema:
          type: boolean
      - in: query
        name: route__assignee
        schema:
          type: string
          format: uuid
      - in: query
        name: route__assignee__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__assignee__isnull
        schema:
          type: boolean
      - in: query
        name: route__code
        schema:
          type: string
      - in: query
        name: route__code__icontains
        schema:
          type: string
      - in: query
        name: route__code__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__code__iregex
        schema:
          type: string
      - in: query
        name: route__code__isnull
        schema:
          type: boolean
      - in: query
        name: route__code__istartswith
        schema:
          type: string
      - in: query
        name: route__code__search
        schema:
          type: string
      - in: query
        name: route__description
        schema:
          type: string
      - in: query
        name: route__description__icontains
        schema:
          type: string
      - in: query
        name: route__description__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__description__iregex
        schema:
          type: string
      - in: query
        name: route__description__isnull
        schema:
          type: boolean
      - in: query
        name: route__description__istartswith
        schema:
          type: string
      - in: query
        name: route__description__search
        schema:
          type: string
      - in: query
        name: route__end_address
        schema:
          type: string
          format: uuid
      - in: query
        name: route__end_address__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__end_address__isnull
        schema:
          type: boolean
      - in: query
        name: route__end_time
        schema:
          type: string
          format: date-time
      - in: query
        name: route__end_time__gt
        schema:
          type: string
          format: date-time
      - in: query
        name: route__end_time__gte
        schema:
          type: string
          format: date-time
      - in: query
        name: route__end_time__isnull
        schema:
          type: boolean
      - in: query
        name: route__end_time__lt
        schema:
          type: string
          format: date-time
      - in: query
        name: route__end_time__lte
        schema:
          type: string
          format: date-time
      - in: query
        name: route__external_id
        schema:
          type: string
      - in: query
        name: route__external_id__icontains
        schema:
          type: string
      - in: query
        name: route__external_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__external_id__isnull
        schema:
          type: boolean
      - name: route__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: route__metafields
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - in: query
        name: route__name
        schema:
          type: string
      - in: query
        name: route__name__icontains
        schema:
          type: string
      - in: query
        name: route__name__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__name__iregex
        schema:
          type: string
      - in: query
        name: route__name__isnull
        schema:
          type: boolean
      - in: query
        name: route__name__istartswith
        schema:
          type: string
      - in: query
        name: route__name__search
        schema:
          type: string
      - in: query
        name: route__start_address
        schema:
          type: string
          format: uuid
      - in: query
        name: route__start_address__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__start_address__isnull
        schema:
          type: boolean
      - in: query
        name: route__start_time
        schema:
          type: string
          format: date-time
      - in: query
        name: route__start_time__gt
        schema:
          type: string
          format: date-time
      - in: query
        name: route__start_time__gte
        schema:
          type: string
          format: date-time
      - in: query
        name: route__start_time__isnull
        schema:
          type: boolean
      - in: query
        name: route__start_time__lt
        schema:
          type: string
          format: date-time
      - in: query
        name: route__start_time__lte
        schema:
          type: string
          format: date-time
      - in: query
        name: route_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: route_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route_id__isnull
        schema:
          type: boolean
      - name: scheduled_time
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: scheduled_time__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: scheduled_time__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: scheduled_time__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: sideload
        schema:
          type: array
          items:
            type: string
            enum:
            - assignees
            - clients
            - documents
            - metadatas
            - orders
            - routes
            - signatures
            - trackers
        description: This option allows you to fetch related obejcts for all of the
          relations with a signle query. Multi-source sideloadable fields can be filtered
          by the sources by declaring the required sources in square brackets after
          the sideloading key. All available Mutli-source fields will have an example
          provided with all available sources. The comma separated sources can be
          ommited with the square brackets if all sources are to be sideloaded.
        examples:
          RegularSideloading:
            value: assignees,clients
            summary: Regular sideloading
          MultiSourceSideloadingForDocuments:
            value: documents[documents,order__documents,recurrence__documents,contact_address__documents]
            summary: Multi source sideloading for documents
      - name: size__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated integer values supported
        schema:
          type: string
        example: 11,23
      - name: size__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated integer values supported
        schema:
          type: string
        example: 11,23
      - name: size__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: size__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated integer values supported
        schema:
          type: string
        example: 11,23
      - in: query
        name: state
        schema:
          type: string
          enum:
          - accepted
          - active
          - assigned
          - cancelled
          - completed
          - draft
          - failed
          - scheduled
          - transit
          - unassigned
        description: |-
          * `draft` - Draft
          * `scheduled` - Scheduled
          * `unassigned` - Unassigned
          * `assigned` - Assigned
          * `accepted` - Accepted
          * `transit` - Transit
          * `active` - Active
          * `completed` - Completed
          * `failed` - Failed
          * `cancelled` - Cancelled
      - name: state__in
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: state__in_or_isnull
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: state__not_in
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: state__not_in_or_isnull
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: task_import
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: task_import__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: unassignee_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: unassignee_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: unassignee_id__isnull
        schema:
          type: boolean
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at_delay_latest
        required: false
        in: query
        description: 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__gte`is used.
        example: true
        schema:
          type: boolean
      tags:
      - tasks
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedSignatureList'
          description: ''
  /tasks/{id}/transit/:
    post:
      operationId: tasks_transit_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task.
        required: true
      tags:
      - tasks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskAction'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TaskSerializerV2'
          description: ''
  /tasks/{id}/unaccept/:
    post:
      operationId: tasks_unaccept_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task.
        required: true
      tags:
      - tasks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskAction'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TaskSerializerV2'
          description: ''
  /tasks/{id}/unassign/:
    post:
      operationId: tasks_unassign_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this task.
        required: true
      tags:
      - tasks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskAction'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TaskSerializerV2'
          description: ''
  /tasks/reorder/:
    post:
      operationId: tasks_reorder_create
      description: Deprecated from version 2.3.0 onwards.
      parameters:
      - name: account
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: account__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: address__apartment_number
        schema:
          type: string
      - in: query
        name: address__apartment_number__icontains
        schema:
          type: string
      - in: query
        name: address__apartment_number__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__apartment_number__iregex
        schema:
          type: string
      - in: query
        name: address__apartment_number__istartswith
        schema:
          type: string
      - in: query
        name: address__apartment_number__search
        schema:
          type: string
      - in: query
        name: address__city
        schema:
          type: string
      - in: query
        name: address__city__icontains
        schema:
          type: string
      - in: query
        name: address__city__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__city__iregex
        schema:
          type: string
      - in: query
        name: address__city__istartswith
        schema:
          type: string
      - in: query
        name: address__city__search
        schema:
          type: string
      - in: query
        name: address__country
        schema:
          type: string
      - in: query
        name: address__country__icontains
        schema:
          type: string
      - in: query
        name: address__country__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__country__iregex
        schema:
          type: string
      - in: query
        name: address__country__istartswith
        schema:
          type: string
      - in: query
        name: address__country__search
        schema:
          type: string
      - in: query
        name: address__country_code
        schema:
          type: string
      - in: query
        name: address__country_code__icontains
        schema:
          type: string
      - in: query
        name: address__country_code__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__country_code__iregex
        schema:
          type: string
      - in: query
        name: address__country_code__istartswith
        schema:
          type: string
      - in: query
        name: address__country_code__search
        schema:
          type: string
      - in: query
        name: address__formatted_address
        schema:
          type: string
      - in: query
        name: address__formatted_address__icontains
        schema:
          type: string
      - in: query
        name: address__formatted_address__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__formatted_address__iregex
        schema:
          type: string
      - in: query
        name: address__formatted_address__istartswith
        schema:
          type: string
      - in: query
        name: address__formatted_address__search
        schema:
          type: string
      - name: address__geocode_failed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocode_failed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocode_failed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocode_failed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocode_failed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocoded_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocoded_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: address__geocoded_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: address__geocoded_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: address__geocoding_provider
        schema:
          type: string
          nullable: true
          enum:
          - Paid Services
          - Standard Services
        description: |-
          * `Paid Services` - [('google', 'Google'), ('regio-ee', 'Regio-Ee')]
          * `Standard Services` - [('janaseta', 'Jana Seta'), ('reach-u', 'Reach-U'), ('nominatim', 'Nominatim'), ('in-ads', 'In-ADS')]
      - in: query
        name: address__geocoding_provider__icontains
        schema:
          type: string
      - in: query
        name: address__geocoding_provider__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__geocoding_provider__iregex
        schema:
          type: string
      - in: query
        name: address__geocoding_provider__istartswith
        schema:
          type: string
      - in: query
        name: address__geocoding_provider__search
        schema:
          type: string
      - in: query
        name: address__google_place_id
        schema:
          type: string
      - in: query
        name: address__google_place_id__icontains
        schema:
          type: string
      - in: query
        name: address__google_place_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__google_place_id__iregex
        schema:
          type: string
      - in: query
        name: address__google_place_id__istartswith
        schema:
          type: string
      - in: query
        name: address__google_place_id__search
        schema:
          type: string
      - in: query
        name: address__house_number
        schema:
          type: string
      - in: query
        name: address__house_number__icontains
        schema:
          type: string
      - in: query
        name: address__house_number__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__house_number__iregex
        schema:
          type: string
      - in: query
        name: address__house_number__istartswith
        schema:
          type: string
      - in: query
        name: address__house_number__search
        schema:
          type: string
      - in: query
        name: address__point_of_interest
        schema:
          type: string
      - in: query
        name: address__point_of_interest__icontains
        schema:
          type: string
      - in: query
        name: address__point_of_interest__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__point_of_interest__iregex
        schema:
          type: string
      - in: query
        name: address__point_of_interest__istartswith
        schema:
          type: string
      - in: query
        name: address__point_of_interest__search
        schema:
          type: string
      - in: query
        name: address__postal_code
        schema:
          type: string
      - in: query
        name: address__postal_code__icontains
        schema:
          type: string
      - in: query
        name: address__postal_code__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__postal_code__iregex
        schema:
          type: string
      - in: query
        name: address__postal_code__istartswith
        schema:
          type: string
      - in: query
        name: address__postal_code__search
        schema:
          type: string
      - in: query
        name: address__raw_address
        schema:
          type: string
      - in: query
        name: address__raw_address__icontains
        schema:
          type: string
      - in: query
        name: address__raw_address__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__raw_address__iregex
        schema:
          type: string
      - in: query
        name: address__raw_address__istartswith
        schema:
          type: string
      - in: query
        name: address__raw_address__search
        schema:
          type: string
      - in: query
        name: address__state
        schema:
          type: string
      - in: query
        name: address__state__icontains
        schema:
          type: string
      - in: query
        name: address__state__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__state__iregex
        schema:
          type: string
      - in: query
        name: address__state__istartswith
        schema:
          type: string
      - in: query
        name: address__state__search
        schema:
          type: string
      - in: query
        name: address__street
        schema:
          type: string
      - in: query
        name: address__street__icontains
        schema:
          type: string
      - in: query
        name: address__street__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address__street__iregex
        schema:
          type: string
      - in: query
        name: address__street__istartswith
        schema:
          type: string
      - in: query
        name: address__street__search
        schema:
          type: string
      - name: address_data
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - in: query
        name: address_id
        schema:
          type: string
          format: uuid
      - in: query
        name: address_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: address_id__isnull
        schema:
          type: boolean
      - name: assignee
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: assignee__email
        schema:
          type: string
      - in: query
        name: assignee__email__icontains
        schema:
          type: string
      - in: query
        name: assignee__email__iregex
        schema:
          type: string
      - in: query
        name: assignee__email__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__email__istartswith
        schema:
          type: string
      - in: query
        name: assignee__email__search
        schema:
          type: string
      - in: query
        name: assignee__first_name
        schema:
          type: string
      - in: query
        name: assignee__first_name__icontains
        schema:
          type: string
      - in: query
        name: assignee__first_name__iregex
        schema:
          type: string
      - in: query
        name: assignee__first_name__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__first_name__istartswith
        schema:
          type: string
      - in: query
        name: assignee__first_name__search
        schema:
          type: string
      - name: assignee__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: assignee__last_name
        schema:
          type: string
      - in: query
        name: assignee__last_name__icontains
        schema:
          type: string
      - in: query
        name: assignee__last_name__iregex
        schema:
          type: string
      - in: query
        name: assignee__last_name__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__last_name__istartswith
        schema:
          type: string
      - in: query
        name: assignee__last_name__search
        schema:
          type: string
      - in: query
        name: assignee__password_expires_at
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__password_expires_at__gt
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__password_expires_at__gte
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__password_expires_at__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__password_expires_at__lt
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__password_expires_at__lte
        schema:
          type: string
          format: date-time
      - in: query
        name: assignee__phone
        schema:
          type: string
      - in: query
        name: assignee__phone__icontains
        schema:
          type: string
      - in: query
        name: assignee__phone__iregex
        schema:
          type: string
      - in: query
        name: assignee__phone__isnull
        schema:
          type: boolean
      - in: query
        name: assignee__phone__istartswith
        schema:
          type: string
      - in: query
        name: assignee__phone__search
        schema:
          type: string
      - in: query
        name: assignee_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: assignee_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: assignee_id__isnull
        schema:
          type: boolean
      - in: query
        name: assignee_proximity
        schema:
          type: string
          enum:
          - away
          - near
        description: |-
          * `away` - Away
          * `near` - Near
      - in: query
        name: assignee_proximity__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: barcodes__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: barcodes__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: barcodes__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: barcodes__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: calendar_time
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: calendar_time__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: calendar_time__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: calendar_time__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: calendar_time__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: cancelled_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: cancelled_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: cancelled_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cancelled_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: category
        schema:
          type: string
          enum:
          - assignment
          - drop_off
          - pick_up
          - warehouse
        description: |-
          * `assignment` - Assignment
          * `pick_up` - Pick-Up
          * `drop_off` - Drop-Off
          * `warehouse` - Warehouse
      - in: query
        name: category__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: complete_after
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_after__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_after__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_after__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_after__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_before__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_before__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: complete_before__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: complete_before__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: completed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: completed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: contact__company__icontains
        schema:
          type: string
      - in: query
        name: contact__company__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__company__iregex
        schema:
          type: string
      - in: query
        name: contact__company__istartswith
        schema:
          type: string
      - in: query
        name: contact__company__search
        schema:
          type: string
      - in: query
        name: contact__email
        schema:
          type: string
      - in: query
        name: contact__email__icontains
        schema:
          type: string
      - in: query
        name: contact__email__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__email__iregex
        schema:
          type: string
      - in: query
        name: contact__email__istartswith
        schema:
          type: string
      - in: query
        name: contact__email__search
        schema:
          type: string
      - name: contact__emails__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated emails supported
        schema:
          type: string
        example: example1@mail.ee,example2@mail.ee
      - name: contact__emails__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated emails supported
        schema:
          type: string
        example: example1@mail.ee,example2@mail.ee
      - name: contact__emails__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: contact__emails__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated emails supported
        schema:
          type: string
        example: example1@mail.ee,example2@mail.ee
      - in: query
        name: contact__name
        schema:
          type: string
      - in: query
        name: contact__name__icontains
        schema:
          type: string
      - in: query
        name: contact__name__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__name__iregex
        schema:
          type: string
      - in: query
        name: contact__name__istartswith
        schema:
          type: string
      - in: query
        name: contact__name__search
        schema:
          type: string
      - in: query
        name: contact__notes
        schema:
          type: string
      - in: query
        name: contact__notes__icontains
        schema:
          type: string
      - in: query
        name: contact__notes__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__notes__iregex
        schema:
          type: string
      - in: query
        name: contact__notes__istartswith
        schema:
          type: string
      - in: query
        name: contact__notes__search
        schema:
          type: string
      - in: query
        name: contact__phone
        schema:
          type: string
      - in: query
        name: contact__phone__icontains
        schema:
          type: string
      - in: query
        name: contact__phone__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact__phone__iregex
        schema:
          type: string
      - in: query
        name: contact__phone__istartswith
        schema:
          type: string
      - in: query
        name: contact__phone__search
        schema:
          type: string
      - name: contact__phones__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact__phones__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact__phones__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: contact__phones__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated values supported
        schema:
          type: string
        example: abc,def
      - name: contact_address
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: contact_address__external_id
        schema:
          type: string
      - in: query
        name: contact_address__external_id__icontains
        schema:
          type: string
      - in: query
        name: contact_address__external_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact_address__external_id__isnull
        schema:
          type: boolean
      - name: contact_address__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: contact_data
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - in: query
        name: contact_id
        schema:
          type: string
          format: uuid
      - in: query
        name: contact_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: contact_id__isnull
        schema:
          type: boolean
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: created_by
        schema:
          type: string
          format: uuid
      - in: query
        name: created_by__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: created_by__isnull
        schema:
          type: boolean
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: description
        schema:
          type: string
      - in: query
        name: description__icontains
        schema:
          type: string
      - in: query
        name: description__iregex
        schema:
          type: string
      - in: query
        name: description__istartswith
        schema:
          type: string
      - in: query
        name: description__search
        schema:
          type: string
      - in: query
        name: duration
        schema:
          type: string
          format: duration
      - in: query
        name: duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: external_id
        schema:
          type: string
      - in: query
        name: external_id__icontains
        schema:
          type: string
      - in: query
        name: external_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: external_id__iregex
        schema:
          type: string
      - in: query
        name: external_id__isnull
        schema:
          type: boolean
      - in: query
        name: external_id__istartswith
        schema:
          type: string
      - in: query
        name: external_id__search
        schema:
          type: string
      - in: query
        name: id
        schema:
          type: string
          format: uuid
      - in: query
        name: id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: is_optimal
        schema:
          type: boolean
      - in: query
        name: is_optimal__isnull
        schema:
          type: boolean
      - in: query
        name: metadata__accepted_distance
        schema:
          type: integer
      - in: query
        name: metadata__accepted_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__accepted_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__accepted_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__accepted_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__accepted_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__accepted_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__accepted_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__accepted_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__accepted_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_distance
        schema:
          type: integer
      - in: query
        name: metadata__active_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__active_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__active_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__active_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__active_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__active_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_distance
        schema:
          type: integer
      - in: query
        name: metadata__assigned_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__assigned_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__assigned_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__assigned_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__assigned_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__assigned_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_distance
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__cancelled_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__cancelled_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_distance
        schema:
          type: integer
      - in: query
        name: metadata__completed_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__completed_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__completed_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__completed_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__completed_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__completed_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__documents_count
        schema:
          type: integer
      - in: query
        name: metadata__documents_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__documents_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__documents_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__documents_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__events_count
        schema:
          type: integer
      - in: query
        name: metadata__events_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__events_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__events_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__events_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__failed_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__failed_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__failed_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__failed_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__failed_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__failed_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__forms_completed_count
        schema:
          type: integer
      - in: query
        name: metadata__forms_completed_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__forms_completed_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__forms_completed_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__forms_completed_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__forms_count
        schema:
          type: integer
      - in: query
        name: metadata__forms_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__forms_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__forms_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__forms_count__lte
        schema:
          type: integer
      - name: metadata__last_accepted_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_accepted_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_accepted_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_accepted_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_accepted_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_active_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_active_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_active_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_active_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_assigned_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_assigned_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_assigned_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_assigned_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_cancelled_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_cancelled_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_cancelled_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_cancelled_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_completed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_completed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_completed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_completed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_failed_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_failed_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_failed_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_failed_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_transit_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_transit_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_transit_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_transit_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_unassigned_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_unassigned_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: metadata__last_unassigned_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: metadata__last_unassigned_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: metadata__signatures_count
        schema:
          type: integer
      - in: query
        name: metadata__signatures_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__signatures_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__signatures_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__signatures_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count__gt
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count__gte
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count__lt
        schema:
          type: integer
      - in: query
        name: metadata__task_event_notes_count__lte
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__transit_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__transit_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__transit_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__transit_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__transit_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__transit_duration__lte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_distance
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_distance__gt
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_distance__gte
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_distance__lt
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_distance__lte
        schema:
          type: integer
      - in: query
        name: metadata__unassigned_duration
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_duration__gt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_duration__gte
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_duration__lt
        schema:
          type: string
          format: duration
      - in: query
        name: metadata__unassigned_duration__lte
        schema:
          type: string
          format: duration
      - name: metafields__namespace:key
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - name: order
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: order__auto_assign
        schema:
          type: boolean
      - name: order__created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: order__created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: order__created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: order__created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: order__created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: order__created_by
        schema:
          type: string
          format: uuid
      - in: query
        name: order__created_by__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: order__created_by__isnull
        schema:
          type: boolean
      - in: query
        name: order__description
        schema:
          type: string
      - in: query
        name: order__description__icontains
        schema:
          type: string
      - in: query
        name: order__description__iregex
        schema:
          type: string
      - in: query
        name: order__description__isnull
        schema:
          type: boolean
      - in: query
        name: order__description__istartswith
        schema:
          type: string
      - in: query
        name: order__description__search
        schema:
          type: string
      - in: query
        name: order__external_id
        schema:
          type: string
      - in: query
        name: order__external_id__icontains
        schema:
          type: string
      - in: query
        name: order__external_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: order__external_id__iregex
        schema:
          type: string
      - in: query
        name: order__external_id__isnull
        schema:
          type: boolean
      - in: query
        name: order__external_id__istartswith
        schema:
          type: string
      - in: query
        name: order__external_id__search
        schema:
          type: string
      - name: order__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: order__orderer
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - in: query
        name: order__reference
        schema:
          type: string
      - in: query
        name: order__reference__icontains
        schema:
          type: string
      - in: query
        name: order__reference__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: order__reference__iregex
        schema:
          type: string
      - in: query
        name: order__reference__istartswith
        schema:
          type: string
      - in: query
        name: order__reference__search
        schema:
          type: string
      - in: query
        name: order_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: order_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: order_id__isnull
        schema:
          type: boolean
      - name: orderer
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: orderer__id
        schema:
          type: string
          format: uuid
      - in: query
        name: orderer__id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: orderer__id__isnull
        schema:
          type: boolean
      - name: orderer__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: orderer__name
        schema:
          type: string
      - in: query
        name: orderer__name__icontains
        schema:
          type: string
      - in: query
        name: orderer_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: orderer_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: orderer_id__isnull
        schema:
          type: boolean
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - in: query
        name: owner_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: owner_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: owner_id__isnull
        schema:
          type: boolean
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: position
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: position__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: position__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: position__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: position__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: previous_assignees__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated UUID values supported
        schema:
          type: string
        example: ee49ea31-672b-4f0b-abb9-581558651d9e,ebb4bee2-dab4-4448-bf60-4a9ca2a5789a
      - name: previous_assignees__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated UUID values supported
        schema:
          type: string
        example: ee49ea31-672b-4f0b-abb9-581558651d9e,ebb4bee2-dab4-4448-bf60-4a9ca2a5789a
      - name: previous_assignees__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: previous_assignees__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated UUID values supported
        schema:
          type: string
        example: ee49ea31-672b-4f0b-abb9-581558651d9e,ebb4bee2-dab4-4448-bf60-4a9ca2a5789a
      - in: query
        name: priority
        schema:
          type: integer
      - in: query
        name: priority__gt
        schema:
          type: integer
      - in: query
        name: priority__gte
        schema:
          type: integer
      - in: query
        name: priority__in
        schema:
          type: array
          items:
            type: integer
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: priority__lt
        schema:
          type: integer
      - in: query
        name: priority__lte
        schema:
          type: integer
      - name: receiver
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: receiver__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: receiver_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: receiver_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: receiver_id__isnull
        schema:
          type: boolean
      - in: query
        name: reference
        schema:
          type: string
      - in: query
        name: reference__icontains
        schema:
          type: string
      - in: query
        name: reference__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: reference__iregex
        schema:
          type: string
      - in: query
        name: reference__istartswith
        schema:
          type: string
      - in: query
        name: reference__search
        schema:
          type: string
      - name: route
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - in: query
        name: route__account
        schema:
          type: string
          format: uuid
      - in: query
        name: route__account__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__account__isnull
        schema:
          type: boolean
      - in: query
        name: route__assignee
        schema:
          type: string
          format: uuid
      - in: query
        name: route__assignee__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__assignee__isnull
        schema:
          type: boolean
      - in: query
        name: route__code
        schema:
          type: string
      - in: query
        name: route__code__icontains
        schema:
          type: string
      - in: query
        name: route__code__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__code__iregex
        schema:
          type: string
      - in: query
        name: route__code__isnull
        schema:
          type: boolean
      - in: query
        name: route__code__istartswith
        schema:
          type: string
      - in: query
        name: route__code__search
        schema:
          type: string
      - in: query
        name: route__description
        schema:
          type: string
      - in: query
        name: route__description__icontains
        schema:
          type: string
      - in: query
        name: route__description__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__description__iregex
        schema:
          type: string
      - in: query
        name: route__description__isnull
        schema:
          type: boolean
      - in: query
        name: route__description__istartswith
        schema:
          type: string
      - in: query
        name: route__description__search
        schema:
          type: string
      - in: query
        name: route__end_address
        schema:
          type: string
          format: uuid
      - in: query
        name: route__end_address__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__end_address__isnull
        schema:
          type: boolean
      - in: query
        name: route__end_time
        schema:
          type: string
          format: date-time
      - in: query
        name: route__end_time__gt
        schema:
          type: string
          format: date-time
      - in: query
        name: route__end_time__gte
        schema:
          type: string
          format: date-time
      - in: query
        name: route__end_time__isnull
        schema:
          type: boolean
      - in: query
        name: route__end_time__lt
        schema:
          type: string
          format: date-time
      - in: query
        name: route__end_time__lte
        schema:
          type: string
          format: date-time
      - in: query
        name: route__external_id
        schema:
          type: string
      - in: query
        name: route__external_id__icontains
        schema:
          type: string
      - in: query
        name: route__external_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__external_id__isnull
        schema:
          type: boolean
      - name: route__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: route__metafields
        required: false
        in: query
        description: Django ORM lookups can be used. Metafield `is_searchable` must
          be True.
        schema:
          type: string
      - in: query
        name: route__name
        schema:
          type: string
      - in: query
        name: route__name__icontains
        schema:
          type: string
      - in: query
        name: route__name__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__name__iregex
        schema:
          type: string
      - in: query
        name: route__name__isnull
        schema:
          type: boolean
      - in: query
        name: route__name__istartswith
        schema:
          type: string
      - in: query
        name: route__name__search
        schema:
          type: string
      - in: query
        name: route__start_address
        schema:
          type: string
          format: uuid
      - in: query
        name: route__start_address__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route__start_address__isnull
        schema:
          type: boolean
      - in: query
        name: route__start_time
        schema:
          type: string
          format: date-time
      - in: query
        name: route__start_time__gt
        schema:
          type: string
          format: date-time
      - in: query
        name: route__start_time__gte
        schema:
          type: string
          format: date-time
      - in: query
        name: route__start_time__isnull
        schema:
          type: boolean
      - in: query
        name: route__start_time__lt
        schema:
          type: string
          format: date-time
      - in: query
        name: route__start_time__lte
        schema:
          type: string
          format: date-time
      - in: query
        name: route_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: route_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: route_id__isnull
        schema:
          type: boolean
      - name: scheduled_time
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: scheduled_time__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: scheduled_time__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: scheduled_time__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: scheduled_time__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - name: size__contained_by
        required: false
        in: query
        description: Filter the returned list where all target array values contained
          in filter values. Comma separated integer values supported
        schema:
          type: string
        example: 11,23
      - name: size__contains
        required: false
        in: query
        description: Filter the returned list where filter_value in field values.
          Comma separated integer values supported
        schema:
          type: string
        example: 11,23
      - name: size__isnull
        required: false
        in: query
        description: Filter the returned list where the array is null
        schema:
          type: boolean
      - name: size__overlap
        required: false
        in: query
        description: Filter the returned list where at least one filter value in target
          array. Comma separated integer values supported
        schema:
          type: string
        example: 11,23
      - in: query
        name: state
        schema:
          type: string
          enum:
          - accepted
          - active
          - assigned
          - cancelled
          - completed
          - draft
          - failed
          - scheduled
          - transit
          - unassigned
        description: |-
          * `draft` - Draft
          * `scheduled` - Scheduled
          * `unassigned` - Unassigned
          * `assigned` - Assigned
          * `accepted` - Accepted
          * `transit` - Transit
          * `active` - Active
          * `completed` - Completed
          * `failed` - Failed
          * `cancelled` - Cancelled
      - name: state__in
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: state__in_or_isnull
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: state__not_in
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: state__not_in_or_isnull
        required: false
        in: query
        description: ''
        schema:
          type: string
      - name: task_import
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: task_import__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - in: query
        name: unassignee_id
        schema:
          type: string
          format: uuid
          nullable: true
      - in: query
        name: unassignee_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
            nullable: true
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: unassignee_id__isnull
        schema:
          type: boolean
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at_delay_latest
        required: false
        in: query
        description: 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__gte`is used.
        example: true
        schema:
          type: boolean
      tags:
      - tasks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskListReorderRequest'
        required: true
      security:
      - tokenAuth: []
      deprecated: true
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedTaskListReorderResponseTaskList'
          description: ''
  /time_location_features/:
    get:
      operationId: time_location_features_list
      parameters:
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: state
        schema:
          type: string
          enum:
          - moving
          - stopped
          - unknown
        description: |-
          * `unknown` - Unknown
          * `stopped` - Stopped
          * `moving` - Moving
      - name: time
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: time__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: time__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: time__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: time__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: time__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: time__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: time__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: time__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: time__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: time__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: user
        schema:
          type: string
          format: uuid
      tags:
      - time_location_features
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedTimeLocationFeatureList'
          description: ''
    post:
      operationId: time_location_features_create
      tags:
      - time_location_features
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TimeLocationFeature'
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TimeLocationFeature'
          description: ''
  /time_location_features/{id}/:
    get:
      operationId: time_location_features_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this time location.
        required: true
      tags:
      - time_location_features
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TimeLocationFeature'
          description: ''
    put:
      operationId: time_location_features_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this time location.
        required: true
      tags:
      - time_location_features
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TimeLocationFeature'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TimeLocationFeature'
          description: ''
    patch:
      operationId: time_location_features_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this time location.
        required: true
      tags:
      - time_location_features
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedTimeLocationFeature'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TimeLocationFeature'
          description: ''
    delete:
      operationId: time_location_features_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this time location.
        required: true
      tags:
      - time_location_features
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /time_locations/:
    get:
      operationId: time_locations_list
      parameters:
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: state
        schema:
          type: string
          enum:
          - moving
          - stopped
          - unknown
        description: |-
          * `unknown` - Unknown
          * `stopped` - Stopped
          * `moving` - Moving
      - name: time
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: time__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: time__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: time__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: time__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: time__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: time__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: time__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: time__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: time__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: time__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: user
        schema:
          type: string
          format: uuid
      tags:
      - time_locations
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedTimeLocationList'
          description: ''
    post:
      operationId: time_locations_create
      tags:
      - time_locations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TimeLocation'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TimeLocation'
          description: ''
  /time_locations/{id}/:
    get:
      operationId: time_locations_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this time location.
        required: true
      tags:
      - time_locations
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TimeLocation'
          description: ''
  /trackers/:
    get:
      operationId: trackers_list
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - trackers
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedTrackerList'
          description: ''
    post:
      operationId: trackers_create
      tags:
      - trackers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Tracker'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Tracker'
          description: ''
  /trackers/{id}/:
    get:
      operationId: trackers_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this tracker.
        required: true
      tags:
      - trackers
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Tracker'
          description: ''
    put:
      operationId: trackers_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this tracker.
        required: true
      tags:
      - trackers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Tracker'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Tracker'
          description: ''
    patch:
      operationId: trackers_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this tracker.
        required: true
      tags:
      - trackers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedTracker'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Tracker'
          description: ''
  /trackers/{id}/public/:
    get:
      operationId: trackers_public_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this tracker.
        required: true
      tags:
      - trackers
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/TrackerPublic'
          description: ''
  /users/:
    get:
      operationId: users_list
      parameters:
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: email
        schema:
          type: string
      - in: query
        name: first_name
        schema:
          type: string
      - in: query
        name: last_name
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: phone
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - users
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedReadableUserList'
          description: ''
    post:
      operationId: users_create
      tags:
      - users
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthenticatedUserCreate'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/AuthenticatedUserCreate'
          description: ''
  /users/{id}/:
    get:
      operationId: users_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this user.
        required: true
      tags:
      - users
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/ReadableUser'
          description: ''
    put:
      operationId: users_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this user.
        required: true
      tags:
      - users
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthenticatedUserUpdate'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/AuthenticatedUserUpdate'
          description: ''
    patch:
      operationId: users_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this user.
        required: true
      tags:
      - users
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedAuthenticatedUserUpdate'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/AuthenticatedUserUpdate'
          description: ''
  /users/{id}/hijack/:
    post:
      operationId: users_hijack_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this user.
        required: true
      tags:
      - users
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReadableUser'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/ReadableUser'
          description: ''
  /users/{id}/on_duty/:
    get:
      operationId: users_on_duty_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this user.
        required: true
      tags:
      - users
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/OnDuty'
          description: ''
    put:
      operationId: users_on_duty_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this user.
        required: true
      tags:
      - users
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OnDuty'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/OnDuty'
          description: ''
    delete:
      operationId: users_on_duty_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this user.
        required: true
      tags:
      - users
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /users/verify_email/:
    post:
      operationId: users_verify_email_create
      tags:
      - users
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserEmailVerification'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                type: object
                additionalProperties: {}
                description: Unspecified response body
          description: ''
  /users_on_duty_log/:
    get:
      operationId: users_on_duty_log_list
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - in: query
        name: account_role
        schema:
          type: string
          format: uuid
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: mode
        schema:
          type: string
          enum:
          - offline
          - online
        description: |-
          * `online` - Online
          * `offline` - Offline
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: status
        schema:
          type: string
          enum:
          - off_duty
          - on_duty
        description: |-
          * `on_duty` - On duty
          * `off_duty` - Off duty
      - name: timestamp
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: timestamp__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: timestamp__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: timestamp__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: timestamp__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: timestamp__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: timestamp__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: timestamp__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: timestamp__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: timestamp__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: timestamp__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: user
        schema:
          type: string
          format: uuid
      tags:
      - users_on_duty_log
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedWorkingStateList'
          description: ''
    post:
      operationId: users_on_duty_log_create
      tags:
      - users_on_duty_log
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkingState'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/WorkingState'
          description: ''
  /users_on_duty_log/{id}/:
    get:
      operationId: users_on_duty_log_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this working state.
        required: true
      tags:
      - users_on_duty_log
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/WorkingState'
          description: ''
  /webhooks/:
    get:
      operationId: webhooks_list
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: document_events
        schema:
          type: boolean
      - in: query
        name: form_response_events
        schema:
          type: boolean
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: review_events
        schema:
          type: boolean
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: signature_events
        schema:
          type: boolean
      - in: query
        name: state
        schema:
          type: string
          enum:
          - active
          - failed
          - inactive
        description: |-
          * `inactive` - inactive
          * `active` - active
          * `failed` - failed
      - in: query
        name: task_events
        schema:
          type: boolean
      - in: query
        name: version
        schema:
          type: string
      tags:
      - webhooks
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedWebhookList'
          description: ''
    post:
      operationId: webhooks_create
      tags:
      - webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Webhook'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Webhook'
          description: ''
  /webhooks/{id}/:
    get:
      operationId: webhooks_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this webhook.
        required: true
      tags:
      - webhooks
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Webhook'
          description: ''
    put:
      operationId: webhooks_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this webhook.
        required: true
      tags:
      - webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Webhook'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Webhook'
          description: ''
    patch:
      operationId: webhooks_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this webhook.
        required: true
      tags:
      - webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedWebhook'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Webhook'
          description: ''
    delete:
      operationId: webhooks_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this webhook.
        required: true
      tags:
      - webhooks
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /webhooks/{id}/active/:
    post:
      operationId: webhooks_active_create
      description: This action allows the user to activate the webhook.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this webhook.
        required: true
      tags:
      - webhooks
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Webhook'
          description: ''
  /webhooks/{id}/inactive/:
    post:
      operationId: webhooks_inactive_create
      description: This action allows the user to deactivate the webhook.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this webhook.
        required: true
      tags:
      - webhooks
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/Webhook'
          description: ''
  /worker_features/:
    get:
      operationId: worker_features_list
      parameters:
      - name: account
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: account__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: state
        schema:
          type: string
          enum:
          - moving
          - stopped
          - unknown
        description: |-
          * `unknown` - Unknown
          * `stopped` - Stopped
          * `moving` - Moving
      - name: time
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: time__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: time__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: time__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: time__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: time__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: time__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: time__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: time__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: time__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: time__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: user
        required: false
        in: query
        schema:
          type: string
          format: uuid
      - name: user__in
        required: false
        in: query
        description: comma separated value
        schema:
          type: string
      tags:
      - worker_features
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedWorkerFeatureList'
          description: ''
  /worker_features/{user_id}/:
    get:
      operationId: worker_features_retrieve
      parameters:
      - in: path
        name: user_id
        schema:
          type: string
          format: uuid
        required: true
      tags:
      - worker_features
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/WorkerFeature'
          description: ''
  /worker_tracks/:
    get:
      operationId: worker_tracks_list
      parameters:
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: end_time__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: end_time__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: end_time__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: end_time__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: start_time__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: start_time__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: start_time__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: start_time__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: updated_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: updated_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      tags:
      - worker_tracks
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/WorkerTrackList'
          description: ''
  /working_state/:
    get:
      operationId: working_state_list
      parameters:
      - in: query
        name: account
        schema:
          type: string
          format: uuid
      - in: query
        name: account_role
        schema:
          type: string
          format: uuid
      - name: created_at
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: created_at__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: created_at__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: mode
        schema:
          type: string
          enum:
          - offline
          - online
        description: |-
          * `online` - Online
          * `offline` - Offline
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: status
        schema:
          type: string
          enum:
          - off_duty
          - on_duty
        description: |-
          * `on_duty` - On duty
          * `off_duty` - Off duty
      - name: timestamp
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: timestamp__date
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: timestamp__date_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: date
      - name: timestamp__gt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: timestamp__gt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: timestamp__gte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: timestamp__gte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: timestamp__lt
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: timestamp__lt_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: timestamp__lte
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - name: timestamp__lte_or_isnull
        required: false
        in: query
        example: '2026-10-31T03:49:23+00:00'
        schema:
          type: string
          format: datetime
      - in: query
        name: user
        schema:
          type: string
          format: uuid
      tags:
      - working_state
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/PaginatedWorkingStateList'
          description: ''
    post:
      operationId: working_state_create
      tags:
      - working_state
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkingState'
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/WorkingState'
          description: ''
  /working_state/{id}/:
    get:
      operationId: working_state_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this working state.
        required: true
      tags:
      - working_state
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json; version=2.11.9:
              schema:
                $ref: '#/components/schemas/WorkingState'
          description: ''
components:
  schemas:
    Account:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        name:
          type: string
          maxLength: 100
        state:
          allOf:
          - $ref: '#/components/schemas/AccountStateEnum'
          readOnly: true
        type:
          oneOf:
          - $ref: '#/components/schemas/AccountTypeEnum'
          - $ref: '#/components/schemas/BlankEnum'
        slug:
          type: string
          readOnly: true
          pattern: ^[-a-zA-Z0-9_]+$
        owner:
          type: string
          format: uri
          readOnly: true
        email:
          type: string
          format: email
          maxLength: 254
        notification_emails:
          type: array
          items:
            type: string
            format: email
            maxLength: 254
        review_emails:
          type: array
          items:
            type: string
            format: email
            maxLength: 254
        review_emails_to_assignee:
          type: boolean
        website:
          type: string
          maxLength: 200
        registry_code:
          type: string
          maxLength: 20
        vatin:
          type: string
          maxLength: 20
        language:
          allOf:
          - $ref: '#/components/schemas/LanguageEnum'
          title: Prefered language
        timezone:
          $ref: '#/components/schemas/TimezoneEnum'
        country_code:
          oneOf:
          - $ref: '#/components/schemas/CountryCodeEnum'
          - $ref: '#/components/schemas/BlankEnum'
        address:
          allOf:
          - $ref: '#/components/schemas/NestedAddress'
          nullable: true
        custom_integration_url:
          type: string
          format: uri
          readOnly: true
        failed_reasons:
          type: array
          items:
            type: string
            maxLength: 200
          nullable: true
        route_default_state:
          $ref: '#/components/schemas/RouteDefaultStateEnum'
        distance_units:
          $ref: '#/components/schemas/DistanceUnitsEnum'
        task_duration:
          type: object
          title: Default task duration
          default: 4 10:55:34.12
        task_expiry_duration_from_complete_after:
          type: object
          nullable: true
          description: HH:mm:ss
          default: 4 10:55:34.12
        task_expiry_duration_from_complete_before:
          type: object
          nullable: true
          description: HH:mm:ss
          default: 4 10:55:34.12
        task_expiry_state:
          $ref: '#/components/schemas/TaskExpiryStateEnum'
        assignee_proximity_radius:
          type: integer
          maximum: 2147483647
          minimum: 0
        default_task_category:
          type: string
        transit_active_limit:
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
        default_create_contact_address:
          type: boolean
        date_format:
          $ref: '#/components/schemas/DateFormatEnum'
        time_format:
          $ref: '#/components/schemas/TimeFormatEnum'
        route_start_address:
          allOf:
          - $ref: '#/components/schemas/NestedAddress'
          nullable: true
        route_end_address:
          allOf:
          - $ref: '#/components/schemas/NestedAddress'
          nullable: true
        optimize_after_create:
          type: boolean
        optimization_objective:
          allOf:
          - $ref: '#/components/schemas/ObjectiveEnum'
          title: Default optimization objective
          description: |-
            Specify the default objective for your optimizationions

            * `vehicles` - Vehicles
            * `transport_time` - Transport Time
            * `completion_time` - Completion Time
        reference_autogenerate:
          type: boolean
        reference_offset:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        reference_prefix:
          type: string
          maxLength: 50
        reference_length:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        feature_show_unassigned_to_workers:
          type: boolean
        feature_task_created_sound:
          type: boolean
        feature_change_task_account:
          type: boolean
        feature_show_tutorial:
          type: boolean
        feature_navigation_app_selection:
          type: boolean
        feature_navigation_use_address:
          type: boolean
        feature_task_accept:
          type: boolean
        feature_task_reject:
          type: boolean
        feature_app_task_search:
          type: boolean
        feature_address_autosuggest_provider:
          $ref: '#/components/schemas/FeatureAddressAutosuggestProviderEnum'
        feature_geocoding_country_code:
          allOf:
          - $ref: '#/components/schemas/CountryCodeEnum'
          readOnly: true
          description: |-
            Limit geocoding to the selected country.

            * `AW` - Aruba
            * `AF` - Afghanistan
            * `AO` - Angola
            * `AI` - Anguilla
            * `AX` - Åland Islands
            * `AL` - Albania
            * `AD` - Andorra
            * `AE` - United Arab Emirates
            * `AR` - Argentina
            * `AM` - Armenia
            * `AS` - American Samoa
            * `AQ` - Antarctica
            * `TF` - French Southern Territories
            * `AG` - Antigua and Barbuda
            * `AU` - Australia
            * `AT` - Austria
            * `AZ` - Azerbaijan
            * `BI` - Burundi
            * `BE` - Belgium
            * `BJ` - Benin
            * `BQ` - Bonaire, Sint Eustatius and Saba
            * `BF` - Burkina Faso
            * `BD` - Bangladesh
            * `BG` - Bulgaria
            * `BH` - Bahrain
            * `BS` - Bahamas
            * `BA` - Bosnia and Herzegovina
            * `BL` - Saint Barthélemy
            * `BY` - Belarus
            * `BZ` - Belize
            * `BM` - Bermuda
            * `BO` - Bolivia, Plurinational State of
            * `BR` - Brazil
            * `BB` - Barbados
            * `BN` - Brunei Darussalam
            * `BT` - Bhutan
            * `BV` - Bouvet Island
            * `BW` - Botswana
            * `CF` - Central African Republic
            * `CA` - Canada
            * `CC` - Cocos (Keeling) Islands
            * `CH` - Switzerland
            * `CL` - Chile
            * `CN` - China
            * `CI` - Côte d'Ivoire
            * `CM` - Cameroon
            * `CD` - Congo, The Democratic Republic of the
            * `CG` - Congo
            * `CK` - Cook Islands
            * `CO` - Colombia
            * `KM` - Comoros
            * `CV` - Cabo Verde
            * `CR` - Costa Rica
            * `CU` - Cuba
            * `CW` - Curaçao
            * `CX` - Christmas Island
            * `KY` - Cayman Islands
            * `CY` - Cyprus
            * `CZ` - Czechia
            * `DE` - Germany
            * `DJ` - Djibouti
            * `DM` - Dominica
            * `DK` - Denmark
            * `DO` - Dominican Republic
            * `DZ` - Algeria
            * `EC` - Ecuador
            * `EG` - Egypt
            * `ER` - Eritrea
            * `EH` - Western Sahara
            * `ES` - Spain
            * `EE` - Estonia
            * `ET` - Ethiopia
            * `FI` - Finland
            * `FJ` - Fiji
            * `FK` - Falkland Islands (Malvinas)
            * `FR` - France
            * `FO` - Faroe Islands
            * `FM` - Micronesia, Federated States of
            * `GA` - Gabon
            * `GB` - United Kingdom
            * `GE` - Georgia
            * `GG` - Guernsey
            * `GH` - Ghana
            * `GI` - Gibraltar
            * `GN` - Guinea
            * `GP` - Guadeloupe
            * `GM` - Gambia
            * `GW` - Guinea-Bissau
            * `GQ` - Equatorial Guinea
            * `GR` - Greece
            * `GD` - Grenada
            * `GL` - Greenland
            * `GT` - Guatemala
            * `GF` - French Guiana
            * `GU` - Guam
            * `GY` - Guyana
            * `HK` - Hong Kong
            * `HM` - Heard Island and McDonald Islands
            * `HN` - Honduras
            * `HR` - Croatia
            * `HT` - Haiti
            * `HU` - Hungary
            * `ID` - Indonesia
            * `IM` - Isle of Man
            * `IN` - India
            * `IO` - British Indian Ocean Territory
            * `IE` - Ireland
            * `IR` - Iran, Islamic Republic of
            * `IQ` - Iraq
            * `IS` - Iceland
            * `IL` - Israel
            * `IT` - Italy
            * `JM` - Jamaica
            * `JE` - Jersey
            * `JO` - Jordan
            * `JP` - Japan
            * `KZ` - Kazakhstan
            * `KE` - Kenya
            * `KG` - Kyrgyzstan
            * `KH` - Cambodia
            * `KI` - Kiribati
            * `KN` - Saint Kitts and Nevis
            * `KR` - Korea, Republic of
            * `KW` - Kuwait
            * `LA` - Lao People's Democratic Republic
            * `LB` - Lebanon
            * `LR` - Liberia
            * `LY` - Libya
            * `LC` - Saint Lucia
            * `LI` - Liechtenstein
            * `LK` - Sri Lanka
            * `LS` - Lesotho
            * `LT` - Lithuania
            * `LU` - Luxembourg
            * `LV` - Latvia
            * `MO` - Macao
            * `MF` - Saint Martin (French part)
            * `MA` - Morocco
            * `MC` - Monaco
            * `MD` - Moldova, Republic of
            * `MG` - Madagascar
            * `MV` - Maldives
            * `MX` - Mexico
            * `MH` - Marshall Islands
            * `MK` - North Macedonia
            * `ML` - Mali
            * `MT` - Malta
            * `MM` - Myanmar
            * `ME` - Montenegro
            * `MN` - Mongolia
            * `MP` - Northern Mariana Islands
            * `MZ` - Mozambique
            * `MR` - Mauritania
            * `MS` - Montserrat
            * `MQ` - Martinique
            * `MU` - Mauritius
            * `MW` - Malawi
            * `MY` - Malaysia
            * `YT` - Mayotte
            * `NA` - Namibia
            * `NC` - New Caledonia
            * `NE` - Niger
            * `NF` - Norfolk Island
            * `NG` - Nigeria
            * `NI` - Nicaragua
            * `NU` - Niue
            * `NL` - Netherlands
            * `NO` - Norway
            * `NP` - Nepal
            * `NR` - Nauru
            * `NZ` - New Zealand
            * `OM` - Oman
            * `PK` - Pakistan
            * `PA` - Panama
            * `PN` - Pitcairn
            * `PE` - Peru
            * `PH` - Philippines
            * `PW` - Palau
            * `PG` - Papua New Guinea
            * `PL` - Poland
            * `PR` - Puerto Rico
            * `KP` - Korea, Democratic People's Republic of
            * `PT` - Portugal
            * `PY` - Paraguay
            * `PS` - Palestine, State of
            * `PF` - French Polynesia
            * `QA` - Qatar
            * `RE` - Réunion
            * `RO` - Romania
            * `RU` - Russian Federation
            * `RW` - Rwanda
            * `SA` - Saudi Arabia
            * `SD` - Sudan
            * `SN` - Senegal
            * `SG` - Singapore
            * `GS` - South Georgia and the South Sandwich Islands
            * `SH` - Saint Helena, Ascension and Tristan da Cunha
            * `SJ` - Svalbard and Jan Mayen
            * `SB` - Solomon Islands
            * `SL` - Sierra Leone
            * `SV` - El Salvador
            * `SM` - San Marino
            * `SO` - Somalia
            * `PM` - Saint Pierre and Miquelon
            * `RS` - Serbia
            * `SS` - South Sudan
            * `ST` - Sao Tome and Principe
            * `SR` - Suriname
            * `SK` - Slovakia
            * `SI` - Slovenia
            * `SE` - Sweden
            * `SZ` - Eswatini
            * `SX` - Sint Maarten (Dutch part)
            * `SC` - Seychelles
            * `SY` - Syrian Arab Republic
            * `TC` - Turks and Caicos Islands
            * `TD` - Chad
            * `TG` - Togo
            * `TH` - Thailand
            * `TJ` - Tajikistan
            * `TK` - Tokelau
            * `TM` - Turkmenistan
            * `TL` - Timor-Leste
            * `TO` - Tonga
            * `TT` - Trinidad and Tobago
            * `TN` - Tunisia
            * `TR` - Türkiye
            * `TV` - Tuvalu
            * `TW` - Taiwan, Province of China
            * `TZ` - Tanzania, United Republic of
            * `UG` - Uganda
            * `UA` - Ukraine
            * `UM` - United States Minor Outlying Islands
            * `UY` - Uruguay
            * `US` - United States
            * `UZ` - Uzbekistan
            * `VA` - Holy See (Vatican City State)
            * `VC` - Saint Vincent and the Grenadines
            * `VE` - Venezuela, Bolivarian Republic of
            * `VG` - Virgin Islands, British
            * `VI` - Virgin Islands, U.S.
            * `VN` - Viet Nam
            * `VU` - Vanuatu
            * `WF` - Wallis and Futuna
            * `WS` - Samoa
            * `YE` - Yemen
            * `ZA` - South Africa
            * `ZM` - Zambia
            * `ZW` - Zimbabwe
        feature_google_maps_region:
          allOf:
          - $ref: '#/components/schemas/CountryCodeEnum'
          readOnly: true
          description: |-
            Google Maps region code for map tiles and territorial display (e.g. MA for Morocco).

            * `AW` - Aruba
            * `AF` - Afghanistan
            * `AO` - Angola
            * `AI` - Anguilla
            * `AX` - Åland Islands
            * `AL` - Albania
            * `AD` - Andorra
            * `AE` - United Arab Emirates
            * `AR` - Argentina
            * `AM` - Armenia
            * `AS` - American Samoa
            * `AQ` - Antarctica
            * `TF` - French Southern Territories
            * `AG` - Antigua and Barbuda
            * `AU` - Australia
            * `AT` - Austria
            * `AZ` - Azerbaijan
            * `BI` - Burundi
            * `BE` - Belgium
            * `BJ` - Benin
            * `BQ` - Bonaire, Sint Eustatius and Saba
            * `BF` - Burkina Faso
            * `BD` - Bangladesh
            * `BG` - Bulgaria
            * `BH` - Bahrain
            * `BS` - Bahamas
            * `BA` - Bosnia and Herzegovina
            * `BL` - Saint Barthélemy
            * `BY` - Belarus
            * `BZ` - Belize
            * `BM` - Bermuda
            * `BO` - Bolivia, Plurinational State of
            * `BR` - Brazil
            * `BB` - Barbados
            * `BN` - Brunei Darussalam
            * `BT` - Bhutan
            * `BV` - Bouvet Island
            * `BW` - Botswana
            * `CF` - Central African Republic
            * `CA` - Canada
            * `CC` - Cocos (Keeling) Islands
            * `CH` - Switzerland
            * `CL` - Chile
            * `CN` - China
            * `CI` - Côte d'Ivoire
            * `CM` - Cameroon
            * `CD` - Congo, The Democratic Republic of the
            * `CG` - Congo
            * `CK` - Cook Islands
            * `CO` - Colombia
            * `KM` - Comoros
            * `CV` - Cabo Verde
            * `CR` - Costa Rica
            * `CU` - Cuba
            * `CW` - Curaçao
            * `CX` - Christmas Island
            * `KY` - Cayman Islands
            * `CY` - Cyprus
            * `CZ` - Czechia
            * `DE` - Germany
            * `DJ` - Djibouti
            * `DM` - Dominica
            * `DK` - Denmark
            * `DO` - Dominican Republic
            * `DZ` - Algeria
            * `EC` - Ecuador
            * `EG` - Egypt
            * `ER` - Eritrea
            * `EH` - Western Sahara
            * `ES` - Spain
            * `EE` - Estonia
            * `ET` - Ethiopia
            * `FI` - Finland
            * `FJ` - Fiji
            * `FK` - Falkland Islands (Malvinas)
            * `FR` - France
            * `FO` - Faroe Islands
            * `FM` - Micronesia, Federated States of
            * `GA` - Gabon
            * `GB` - United Kingdom
            * `GE` - Georgia
            * `GG` - Guernsey
            * `GH` - Ghana
            * `GI` - Gibraltar
            * `GN` - Guinea
            * `GP` - Guadeloupe
            * `GM` - Gambia
            * `GW` - Guinea-Bissau
            * `GQ` - Equatorial Guinea
            * `GR` - Greece
            * `GD` - Grenada
            * `GL` - Greenland
            * `GT` - Guatemala
            * `GF` - French Guiana
            * `GU` - Guam
            * `GY` - Guyana
            * `HK` - Hong Kong
            * `HM` - Heard Island and McDonald Islands
            * `HN` - Honduras
            * `HR` - Croatia
            * `HT` - Haiti
            * `HU` - Hungary
            * `ID` - Indonesia
            * `IM` - Isle of Man
            * `IN` - India
            * `IO` - British Indian Ocean Territory
            * `IE` - Ireland
            * `IR` - Iran, Islamic Republic of
            * `IQ` - Iraq
            * `IS` - Iceland
            * `IL` - Israel
            * `IT` - Italy
            * `JM` - Jamaica
            * `JE` - Jersey
            * `JO` - Jordan
            * `JP` - Japan
            * `KZ` - Kazakhstan
            * `KE` - Kenya
            * `KG` - Kyrgyzstan
            * `KH` - Cambodia
            * `KI` - Kiribati
            * `KN` - Saint Kitts and Nevis
            * `KR` - Korea, Republic of
            * `KW` - Kuwait
            * `LA` - Lao People's Democratic Republic
            * `LB` - Lebanon
            * `LR` - Liberia
            * `LY` - Libya
            * `LC` - Saint Lucia
            * `LI` - Liechtenstein
            * `LK` - Sri Lanka
            * `LS` - Lesotho
            * `LT` - Lithuania
            * `LU` - Luxembourg
            * `LV` - Latvia
            * `MO` - Macao
            * `MF` - Saint Martin (French part)
            * `MA` - Morocco
            * `MC` - Monaco
            * `MD` - Moldova, Republic of
            * `MG` - Madagascar
            * `MV` - Maldives
            * `MX` - Mexico
            * `MH` - Marshall Islands
            * `MK` - North Macedonia
            * `ML` - Mali
            * `MT` - Malta
            * `MM` - Myanmar
            * `ME` - Montenegro
            * `MN` - Mongolia
            * `MP` - Northern Mariana Islands
            * `MZ` - Mozambique
            * `MR` - Mauritania
            * `MS` - Montserrat
            * `MQ` - Martinique
            * `MU` - Mauritius
            * `MW` - Malawi
            * `MY` - Malaysia
            * `YT` - Mayotte
            * `NA` - Namibia
            * `NC` - New Caledonia
            * `NE` - Niger
            * `NF` - Norfolk Island
            * `NG` - Nigeria
            * `NI` - Nicaragua
            * `NU` - Niue
            * `NL` - Netherlands
            * `NO` - Norway
            * `NP` - Nepal
            * `NR` - Nauru
            * `NZ` - New Zealand
            * `OM` - Oman
            * `PK` - Pakistan
            * `PA` - Panama
            * `PN` - Pitcairn
            * `PE` - Peru
            * `PH` - Philippines
            * `PW` - Palau
            * `PG` - Papua New Guinea
            * `PL` - Poland
            * `PR` - Puerto Rico
            * `KP` - Korea, Democratic People's Republic of
            * `PT` - Portugal
            * `PY` - Paraguay
            * `PS` - Palestine, State of
            * `PF` - French Polynesia
            * `QA` - Qatar
            * `RE` - Réunion
            * `RO` - Romania
            * `RU` - Russian Federation
            * `RW` - Rwanda
            * `SA` - Saudi Arabia
            * `SD` - Sudan
            * `SN` - Senegal
            * `SG` - Singapore
            * `GS` - South Georgia and the South Sandwich Islands
            * `SH` - Saint Helena, Ascension and Tristan da Cunha
            * `SJ` - Svalbard and Jan Mayen
            * `SB` - Solomon Islands
            * `SL` - Sierra Leone
            * `SV` - El Salvador
            * `SM` - San Marino
            * `SO` - Somalia
            * `PM` - Saint Pierre and Miquelon
            * `RS` - Serbia
            * `SS` - South Sudan
            * `ST` - Sao Tome and Principe
            * `SR` - Suriname
            * `SK` - Slovakia
            * `SI` - Slovenia
            * `SE` - Sweden
            * `SZ` - Eswatini
            * `SX` - Sint Maarten (Dutch part)
            * `SC` - Seychelles
            * `SY` - Syrian Arab Republic
            * `TC` - Turks and Caicos Islands
            * `TD` - Chad
            * `TG` - Togo
            * `TH` - Thailand
            * `TJ` - Tajikistan
            * `TK` - Tokelau
            * `TM` - Turkmenistan
            * `TL` - Timor-Leste
            * `TO` - Tonga
            * `TT` - Trinidad and Tobago
            * `TN` - Tunisia
            * `TR` - Türkiye
            * `TV` - Tuvalu
            * `TW` - Taiwan, Province of China
            * `TZ` - Tanzania, United Republic of
            * `UG` - Uganda
            * `UA` - Ukraine
            * `UM` - United States Minor Outlying Islands
            * `UY` - Uruguay
            * `US` - United States
            * `UZ` - Uzbekistan
            * `VA` - Holy See (Vatican City State)
            * `VC` - Saint Vincent and the Grenadines
            * `VE` - Venezuela, Bolivarian Republic of
            * `VG` - Virgin Islands, British
            * `VI` - Virgin Islands, U.S.
            * `VN` - Viet Nam
            * `VU` - Vanuatu
            * `WF` - Wallis and Futuna
            * `WS` - Samoa
            * `YE` - Yemen
            * `ZA` - South Africa
            * `ZM` - Zambia
            * `ZW` - Zimbabwe
        feature_document_signing:
          type: boolean
          description: Allow choosing documents to sign.
        feature_tracker_map_provider:
          oneOf:
          - $ref: '#/components/schemas/FeatureTrackerMapProviderEnum'
          - $ref: '#/components/schemas/BlankEnum'
        feature_tracker_reviews_allowed:
          type: boolean
        feature_tracker_url:
          type: string
          readOnly: true
        feature_contact_address_related_tasks_visibility:
          type: boolean
          description: 'Enable contact address visibility features: task history and
            document sideloading for workers'
        feature_route_folders:
          type: boolean
          readOnly: true
          description: Allow tasks to be grouped into routes.
        feature_route_auto_archive:
          type: boolean
          readOnly: true
          description: Auto archive the route when all tasks in that route are archived
        feature_signature_required:
          type: boolean
        feature_signature_required_task_category:
          type: array
          items:
            $ref: '#/components/schemas/TaskCategoryEnum'
        feature_picture_required:
          type: boolean
        feature_picture_required_task_category:
          type: array
          items:
            $ref: '#/components/schemas/TaskCategoryEnum'
        feature_signer_name_required:
          type: boolean
        feature_signer_name_required_task_category:
          type: array
          items:
            $ref: '#/components/schemas/TaskCategoryEnum'
        feature_notes_required:
          type: boolean
        feature_allow_worker_reordering:
          type: boolean
          nullable: true
        pod_show_reference:
          type: boolean
        pod_show_description:
          type: boolean
        pod_show_task_events:
          type: boolean
        pod_show_task_event_creators:
          type: boolean
        pod_show_signatures:
          type: boolean
        pod_show_images:
          type: boolean
        feature_show_unassigned_capacity:
          type: boolean
          description: Show unassigned capacity.
        capacity_divisor:
          type: array
          items:
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          nullable: true
          description: Capacity divisors for calculations.
        capacity_units:
          type: array
          items:
            type: string
            maxLength: 100
          nullable: true
          description: Capacity unit names.
        auto_assign_orders:
          type: boolean
        auto_assign_max_tasks:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          nullable: true
          title: Maximum tasks per worker
          description: How many tasks can be auto assigned to a worker?
        auto_assign_max_distance:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          nullable: true
          title: Maximum distance from task
          description: How far can a task be auto assigned to a worker in meters?
        auto_assign_time_before:
          type: string
          nullable: true
        auto_assign_rotate:
          type: object
          nullable: true
          title: Rotate assignee
          description: Time after non-accepted task assignees will be rotated. Leave
            empty in case the orders should not be rotated
          default: 4 10:55:34.12
        auto_assign_optimize:
          type: boolean
          title: Optimize auto assignments
          description: Check the optimizer results before assignment?
        dashboard_task_template:
          type: string
          readOnly: true
        calendar_task_template:
          type: string
          readOnly: true
        tracker_task_popup_template:
          type: string
          readOnly: true
        dashboard_worker_limit:
          type: integer
          readOnly: true
        stripe_customer_id:
          type: string
          readOnly: true
          nullable: true
        stripe_payment_method_id:
          type: string
          readOnly: true
          nullable: true
          description: 'Reflects current default payment method. For reference only. '
        billing_method:
          allOf:
          - $ref: '#/components/schemas/AccountBillingMethodEnum'
          readOnly: true
        billing_name:
          type: string
          maxLength: 100
        billing_company:
          type: string
          maxLength: 100
        billing_address:
          type: string
          maxLength: 200
        billing_country:
          type: string
          maxLength: 100
        billing_email:
          type: string
          format: email
          title: Billing email address
          maxLength: 254
        billing_phone:
          type: string
          maxLength: 20
        billing_vatin:
          type: string
          maxLength: 20
      required:
      - billing_method
      - calendar_task_template
      - custom_integration_url
      - dashboard_task_template
      - dashboard_worker_limit
      - feature_geocoding_country_code
      - feature_google_maps_region
      - feature_route_auto_archive
      - feature_route_folders
      - feature_tracker_url
      - id
      - name
      - owner
      - slug
      - state
      - stripe_customer_id
      - stripe_payment_method_id
      - tracker_task_popup_template
      - url
    AccountBillingMethodEnum:
      enum:
      - braintree
      - free
      - invoice
      - stripe
      - trial
      type: string
      description: |-
        * `braintree` - Braintree
        * `free` - Free
        * `invoice` - Invoice
        * `stripe` - Stripe
        * `trial` - Trial
    AccountOwnerChange:
      type: object
      properties:
        owner:
          type: string
          format: uri
      required:
      - owner
    AccountRole:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        user:
          type: string
          format: uri
        state:
          allOf:
          - $ref: '#/components/schemas/StateD63Enum'
          readOnly: true
        email:
          type: string
          format: email
          readOnly: true
        display_name:
          type: string
          nullable: true
          maxLength: 100
        phone:
          type: string
          maxLength: 128
        require_sequential_completion:
          type: boolean
        vehicle_registration_number:
          type: string
          title: Vehicle registration
          maxLength: 32
        vehicle_profile:
          $ref: '#/components/schemas/VehicleProfileEnum'
        vehicle_capacity:
          type: array
          items:
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          nullable: true
        vehicle_capacity_divisor:
          type: array
          items:
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          nullable: true
        vehicle_capacity_units:
          type: array
          items:
            type: string
            maxLength: 100
          nullable: true
        show_vehicle_capacity:
          type: boolean
        vehicle_speed_factor:
          type: string
          format: decimal
          pattern: ^-?\d{0,1}(?:\.\d{0,1})?$
        vehicle_service_time_factor:
          type: string
          format: decimal
          pattern: ^-?\d{0,1}(?:\.\d{0,1})?$
        optimize_return_to_depot:
          type: boolean
        optimize_earliest_start:
          type: string
          format: time
          nullable: true
          description: 'Earliest start of vehicle '
        optimize_latest_end:
          type: string
          format: time
          nullable: true
          description: the time the vehicle needs to be at its end location at latest.
        route_start_address:
          allOf:
          - $ref: '#/components/schemas/NestedAddress'
          nullable: true
        route_end_address:
          allOf:
          - $ref: '#/components/schemas/NestedAddress'
          nullable: true
        signature_image:
          type: string
          format: uri
          readOnly: true
        is_admin:
          type: boolean
          title: Admin status
        is_manager:
          type: boolean
          title: Manager status
        is_worker:
          type: boolean
          title: Worker status
        is_integration:
          type: boolean
          title: Integration status
        is_active:
          type: boolean
          readOnly: true
        is_on_duty:
          type: boolean
          readOnly: true
        show_unassigned:
          type: boolean
          title: Show unassigned tasks
        show_travel_estimates:
          type: boolean
        last_time_location:
          type: string
          format: uri
          readOnly: true
        activated_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        deleted_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - account
      - activated_at
      - created_at
      - deleted_at
      - email
      - id
      - is_active
      - is_on_duty
      - last_time_location
      - signature_image
      - state
      - updated_at
      - url
    AccountRoleActivation:
      type: object
      properties:
        token:
          type: string
          format: uuid
          writeOnly: true
        password:
          type: string
          writeOnly: true
      required:
      - token
    AccountRoleCreate:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        user:
          type: string
          format: uri
        state:
          allOf:
          - $ref: '#/components/schemas/StateD63Enum'
          readOnly: true
        email:
          type: string
          format: email
          readOnly: true
        display_name:
          type: string
          nullable: true
          maxLength: 100
        phone:
          type: string
          maxLength: 128
        require_sequential_completion:
          type: boolean
        vehicle_registration_number:
          type: string
          title: Vehicle registration
          maxLength: 32
        vehicle_profile:
          $ref: '#/components/schemas/VehicleProfileEnum'
        vehicle_capacity:
          type: array
          items:
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          nullable: true
        vehicle_capacity_divisor:
          type: array
          items:
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          nullable: true
        vehicle_capacity_units:
          type: array
          items:
            type: string
            maxLength: 100
          nullable: true
        show_vehicle_capacity:
          type: boolean
        vehicle_speed_factor:
          type: string
          format: decimal
          pattern: ^-?\d{0,1}(?:\.\d{0,1})?$
        vehicle_service_time_factor:
          type: string
          format: decimal
          pattern: ^-?\d{0,1}(?:\.\d{0,1})?$
        optimize_return_to_depot:
          type: boolean
        optimize_earliest_start:
          type: string
          format: time
          nullable: true
          description: 'Earliest start of vehicle '
        optimize_latest_end:
          type: string
          format: time
          nullable: true
          description: the time the vehicle needs to be at its end location at latest.
        route_start_address:
          allOf:
          - $ref: '#/components/schemas/NestedAddress'
          nullable: true
        route_end_address:
          allOf:
          - $ref: '#/components/schemas/NestedAddress'
          nullable: true
        signature_image:
          type: string
          format: uri
          readOnly: true
        is_admin:
          type: boolean
          title: Admin status
        is_manager:
          type: boolean
          title: Manager status
        is_worker:
          type: boolean
          title: Worker status
        is_integration:
          type: boolean
          title: Integration status
        is_active:
          type: boolean
          readOnly: true
        is_on_duty:
          type: boolean
          readOnly: true
        show_unassigned:
          type: boolean
          title: Show unassigned tasks
        show_travel_estimates:
          type: boolean
        last_time_location:
          type: string
          format: uri
          readOnly: true
        activated_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        deleted_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        token:
          type: string
          readOnly: true
      required:
      - account
      - activated_at
      - created_at
      - deleted_at
      - email
      - id
      - is_active
      - is_on_duty
      - last_time_location
      - signature_image
      - state
      - token
      - updated_at
      - url
    AccountStateEnum:
      enum:
      - active
      - deactive
      - trial_expired
      - payment_overdue
      type: string
      description: |-
        * `active` - Active
        * `deactive` - Deactive
        * `trial_expired` - Trial expired
        * `payment_overdue` - Payment overdue
    AccountStripePaymentMethodAttach:
      type: object
      properties:
        stripe_customer_id:
          type: string
          maxLength: 255
        stripe_payment_method_id:
          type: string
          description: 'Reflects current default payment method. For reference only. '
          maxLength: 255
        set_default:
          type: boolean
          default: true
      required:
      - stripe_payment_method_id
    AccountStripePaymentMethodDetach:
      type: object
      properties:
        stripe_payment_method_id:
          type: string
          description: 'Reflects current default payment method. For reference only. '
          maxLength: 255
      required:
      - stripe_payment_method_id
    AccountStripePaymentMethodSetDefault:
      type: object
      properties:
        stripe_payment_method_id:
          type: string
          description: 'Reflects current default payment method. For reference only. '
          maxLength: 255
      required:
      - stripe_payment_method_id
    AccountStripeSetupAttemptGet:
      type: object
      properties:
        setup_attempt_id:
          type: string
          maxLength: 100
      required:
      - setup_attempt_id
    AccountStripeSetupIntentCreate:
      type: object
      properties:
        payment_method_id:
          type: string
          maxLength: 100
      required:
      - payment_method_id
    AccountStripeSetupIntentsGet:
      type: object
      properties:
        payment_method_id:
          type: string
          nullable: true
          maxLength: 100
    AccountTypeEnum:
      enum:
      - service
      - delivery
      type: string
      description: |-
        * `service` - Service
        * `delivery` - Pickup & delivery
    ActionEnum:
      enum:
      - update
      - reassign
      - restart
      - assign
      - accept
      - unaccept
      - reject
      - unassign
      - transit
      - activate
      - complete
      - fail
      - cancel
      - assignee_near
      - assignee_away
      type: string
      description: |-
        * `update` - Update
        * `reassign` - Reassign
        * `restart` - Restart
        * `assign` - Assign
        * `accept` - Accept
        * `unaccept` - Un-accept
        * `reject` - Reject
        * `unassign` - Un-assign
        * `transit` - Transit
        * `activate` - Activate
        * `complete` - Complete
        * `fail` - Fail
        * `cancel` - Cancel
        * `assignee_near` - Assignee near
        * `assignee_away` - Assignee away
    Addon:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          type: string
          maxLength: 100
        short_description:
          type: string
        description:
          type: string
        price:
          type: string
          maxLength: 50
        unit:
          type: string
          maxLength: 50
        icon:
          type: string
      required:
      - description
      - icon
      - id
      - name
      - price
      - short_description
      - unit
    AppEnum:
      enum:
      - android
      - ios
      - web
      type: string
      description: |-
        * `android` - Android
        * `ios` - iOS
        * `web` - Web
    AppliesToEnum:
      enum:
      - tasks
      - routes
      - contact_addresses
      type: string
      description: |-
        * `tasks` - Tasks
        * `routes` - Routes
        * `contact_addresses` - Contact Addresses
    AssigneeProximityEnum:
      enum:
      - away
      - near
      type: string
      description: |-
        * `away` - Away
        * `near` - Near
    Authenticate:
      type: object
      properties:
        username:
          type: string
          format: email
          writeOnly: true
        password:
          type: string
          writeOnly: true
          maxLength: 128
        client_id:
          type: string
          writeOnly: true
          minLength: 14
          maxLength: 40
      required:
      - client_id
      - password
      - username
    AuthenticatedUserCreate:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        first_name:
          type: string
          maxLength: 30
        last_name:
          type: string
          maxLength: 30
        display_name:
          type: string
          readOnly: true
        email:
          type: string
          format: email
        phone:
          type: string
          maxLength: 128
        password:
          type: string
          writeOnly: true
        address:
          $ref: '#/components/schemas/NestedAddress'
      required:
      - display_name
      - email
      - id
      - url
    AuthenticatedUserUpdate:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        first_name:
          type: string
          maxLength: 30
        last_name:
          type: string
          maxLength: 30
        display_name:
          type: string
          readOnly: true
        email:
          type: string
          format: email
        phone:
          type: string
          maxLength: 128
        address:
          $ref: '#/components/schemas/NestedAddress'
      required:
      - display_name
      - email
      - id
      - url
    Authorize:
      type: object
      properties:
        account:
          type: string
          format: uri
    BlankEnum:
      enum:
      - ''
    Client:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        name:
          type: string
          maxLength: 200
        slug:
          type: string
          readOnly: true
          pattern: ^[-a-zA-Z0-9_]+$
        archived:
          type: boolean
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        contact_addresses:
          type: array
          items:
            type: object
            additionalProperties: {}
          readOnly: true
      required:
      - account
      - contact_addresses
      - created_at
      - id
      - name
      - slug
      - updated_at
      - url
    ClientRole:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        client:
          type: string
          format: uri
        user:
          type: string
          format: uri
        phone:
          type: string
          maxLength: 128
        is_manager:
          type: boolean
          title: Manager status
        is_active:
          type: boolean
          title: Active
          description: Designates whether this Client Role should be treated as active.
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - account
      - client
      - created_at
      - id
      - updated_at
      - url
      - user
    ConfigurationDefaults:
      type: object
      properties:
        task_category:
          type: string
        task_duration:
          type: object
          default: 4 10:55:34.12
        distance_units:
          type: string
        create_contact_address:
          type: boolean
        transit_active_limit:
          type: integer
      required:
      - create_contact_address
      - distance_units
      - task_category
      - task_duration
      - transit_active_limit
    ConfigurationEnvironment:
      type: object
      properties:
        web_app_release_track:
          allOf:
          - $ref: '#/components/schemas/WebAppReleaseTrackEnum'
          readOnly: true
        web_app_url:
          type: string
          format: uri
        gsmtasks_api_url:
          type: string
          format: uri
        mobile_app_locale_url:
          type: string
          format: uri
          nullable: true
      required:
      - gsmtasks_api_url
      - mobile_app_locale_url
      - web_app_release_track
      - web_app_url
    ConfigurationNotification:
      type: object
      properties:
        level:
          $ref: '#/components/schemas/LevelEnum'
        message:
          type: string
        url:
          type: string
          format: uri
          nullable: true
        persist:
          type: boolean
          default: false
        open_in_new_window:
          type: boolean
          default: false
      required:
      - level
      - message
      - url
    ConfigurationSerializerV2:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        account:
          allOf:
          - $ref: '#/components/schemas/Account'
          readOnly: true
        user:
          allOf:
          - $ref: '#/components/schemas/ReadableUser'
          readOnly: true
        is_staff:
          type: boolean
          default: false
        app:
          allOf:
          - $ref: '#/components/schemas/AppEnum'
          readOnly: true
        version:
          type: string
          readOnly: true
        auth:
          type: object
          additionalProperties: {}
          readOnly: true
        settings:
          allOf:
          - $ref: '#/components/schemas/ConfigurationSettings'
          readOnly: true
        defaults:
          allOf:
          - $ref: '#/components/schemas/ConfigurationDefaults'
          readOnly: true
        features:
          type: object
          additionalProperties: {}
          readOnly: true
        templates:
          type: object
          additionalProperties: {}
          readOnly: true
        tracking:
          type: object
          additionalProperties: {}
          readOnly: true
        notifications:
          type: array
          items:
            $ref: '#/components/schemas/ConfigurationNotification'
          readOnly: true
        permissions:
          type: object
          additionalProperties: {}
          readOnly: true
        legacy_views:
          type: object
          additionalProperties: {}
          readOnly: true
        services:
          type: object
          additionalProperties: {}
          readOnly: true
        environment:
          allOf:
          - $ref: '#/components/schemas/ConfigurationEnvironment'
          readOnly: true
        is_client_role:
          type: boolean
          default: false
        billing:
          type: object
          additionalProperties: {}
          readOnly: true
      required:
      - account
      - app
      - auth
      - billing
      - defaults
      - environment
      - features
      - id
      - legacy_views
      - notifications
      - permissions
      - services
      - settings
      - templates
      - tracking
      - user
      - version
    ConfigurationSettings:
      type: object
      properties:
        task_command_queue_limit:
          type: object
          default: 4 10:55:34.12
        date_format:
          type: string
        time_format:
          type: string
      required:
      - date_format
      - task_command_queue_limit
      - time_format
    ContactAddress:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        external_id:
          type: string
          nullable: true
          maxLength: 100
        account:
          type: string
          format: uri
        client:
          type: string
          format: uri
        contact:
          $ref: '#/components/schemas/NestedContact'
        address:
          $ref: '#/components/schemas/NestedAddress'
        is_orderer:
          type: boolean
        is_receiver:
          type: boolean
        source:
          type: string
          maxLength: 100
        metafields: {}
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - account
      - address
      - contact
      - created_at
      - id
      - updated_at
      - url
    ContactAddressBackgroundImport:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        created_by:
          type: string
          format: uri
          readOnly: true
        contact_addresses_data:
          type: array
          items:
            type: object
            additionalProperties: {}
          writeOnly: true
        state:
          allOf:
          - $ref: '#/components/schemas/TasksBackgroundImportStateEnum'
          readOnly: true
        started_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        completed_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        failed_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        errors:
          readOnly: true
        celery_task_id:
          type: string
          readOnly: true
          nullable: true
        contact_addresses_created:
          type: array
          items:
            type: string
            format: uri
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - account
      - celery_task_id
      - completed_at
      - contact_addresses_created
      - contact_addresses_data
      - created_at
      - created_by
      - errors
      - failed_at
      - id
      - started_at
      - state
      - updated_at
      - url
    ContactAddressExport:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        external_id:
          type: string
          nullable: true
          maxLength: 100
        account__name:
          type: string
          default: ''
        contact__name:
          type: string
          default: ''
        contact__company:
          type: string
          default: ''
        contact__phones:
          type: array
          items:
            type: string
            default: ''
        contact__emails:
          type: array
          items:
            type: string
            default: ''
        contact__notes:
          type: string
          default: ''
        address__raw_address:
          type: string
          default: ''
        address__formatted_address:
          type: string
          default: ''
        address__location:
          $ref: '#/components/schemas/Location'
        address__google_place_id:
          type: string
          default: ''
        address__point_of_interest:
          type: string
          default: ''
        address__street:
          type: string
          default: ''
        address__house_number:
          type: string
          default: ''
        address__apartment_number:
          type: string
          default: ''
        address__city:
          type: string
          default: ''
        address__state:
          type: string
          default: ''
        address__postal_code:
          type: string
          default: ''
        address__country:
          type: string
          default: ''
        address__country_code:
          type: string
          default: ''
        is_orderer:
          type: boolean
        is_receiver:
          type: boolean
        source:
          type: string
          maxLength: 100
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - address__location
      - created_at
      - id
      - updated_at
    CountryCodeEnum:
      enum:
      - AW
      - AF
      - AO
      - AI
      - AX
      - AL
      - AD
      - AE
      - AR
      - AM
      - AS
      - AQ
      - TF
      - AG
      - AU
      - AT
      - AZ
      - BI
      - BE
      - BJ
      - BQ
      - BF
      - BD
      - BG
      - BH
      - BS
      - BA
      - BL
      - BY
      - BZ
      - BM
      - BO
      - BR
      - BB
      - BN
      - BT
      - BV
      - BW
      - CF
      - CA
      - CC
      - CH
      - CL
      - CN
      - CI
      - CM
      - CD
      - CG
      - CK
      - CO
      - KM
      - CV
      - CR
      - CU
      - CW
      - CX
      - KY
      - CY
      - CZ
      - DE
      - DJ
      - DM
      - DK
      - DO
      - DZ
      - EC
      - EG
      - ER
      - EH
      - ES
      - EE
      - ET
      - FI
      - FJ
      - FK
      - FR
      - FO
      - FM
      - GA
      - GB
      - GE
      - GG
      - GH
      - GI
      - GN
      - GP
      - GM
      - GW
      - GQ
      - GR
      - GD
      - GL
      - GT
      - GF
      - GU
      - GY
      - HK
      - HM
      - HN
      - HR
      - HT
      - HU
      - ID
      - IM
      - IN
      - IO
      - IE
      - IR
      - IQ
      - IS
      - IL
      - IT
      - JM
      - JE
      - JO
      - JP
      - KZ
      - KE
      - KG
      - KH
      - KI
      - KN
      - KR
      - KW
      - LA
      - LB
      - LR
      - LY
      - LC
      - LI
      - LK
      - LS
      - LT
      - LU
      - LV
      - MO
      - MF
      - MA
      - MC
      - MD
      - MG
      - MV
      - MX
      - MH
      - MK
      - ML
      - MT
      - MM
      - ME
      - MN
      - MP
      - MZ
      - MR
      - MS
      - MQ
      - MU
      - MW
      - MY
      - YT
      - NA
      - NC
      - NE
      - NF
      - NG
      - NI
      - NU
      - NL
      - 'NO'
      - NP
      - NR
      - NZ
      - OM
      - PK
      - PA
      - PN
      - PE
      - PH
      - PW
      - PG
      - PL
      - PR
      - KP
      - PT
      - PY
      - PS
      - PF
      - QA
      - RE
      - RO
      - RU
      - RW
      - SA
      - SD
      - SN
      - SG
      - GS
      - SH
      - SJ
      - SB
      - SL
      - SV
      - SM
      - SO
      - PM
      - RS
      - SS
      - ST
      - SR
      - SK
      - SI
      - SE
      - SZ
      - SX
      - SC
      - SY
      - TC
      - TD
      - TG
      - TH
      - TJ
      - TK
      - TM
      - TL
      - TO
      - TT
      - TN
      - TR
      - TV
      - TW
      - TZ
      - UG
      - UA
      - UM
      - UY
      - US
      - UZ
      - VA
      - VC
      - VE
      - VG
      - VI
      - VN
      - VU
      - WF
      - WS
      - YE
      - ZA
      - ZM
      - ZW
      type: string
      description: |-
        * `AW` - Aruba
        * `AF` - Afghanistan
        * `AO` - Angola
        * `AI` - Anguilla
        * `AX` - Åland Islands
        * `AL` - Albania
        * `AD` - Andorra
        * `AE` - United Arab Emirates
        * `AR` - Argentina
        * `AM` - Armenia
        * `AS` - American Samoa
        * `AQ` - Antarctica
        * `TF` - French Southern Territories
        * `AG` - Antigua and Barbuda
        * `AU` - Australia
        * `AT` - Austria
        * `AZ` - Azerbaijan
        * `BI` - Burundi
        * `BE` - Belgium
        * `BJ` - Benin
        * `BQ` - Bonaire, Sint Eustatius and Saba
        * `BF` - Burkina Faso
        * `BD` - Bangladesh
        * `BG` - Bulgaria
        * `BH` - Bahrain
        * `BS` - Bahamas
        * `BA` - Bosnia and Herzegovina
        * `BL` - Saint Barthélemy
        * `BY` - Belarus
        * `BZ` - Belize
        * `BM` - Bermuda
        * `BO` - Bolivia, Plurinational State of
        * `BR` - Brazil
        * `BB` - Barbados
        * `BN` - Brunei Darussalam
        * `BT` - Bhutan
        * `BV` - Bouvet Island
        * `BW` - Botswana
        * `CF` - Central African Republic
        * `CA` - Canada
        * `CC` - Cocos (Keeling) Islands
        * `CH` - Switzerland
        * `CL` - Chile
        * `CN` - China
        * `CI` - Côte d'Ivoire
        * `CM` - Cameroon
        * `CD` - Congo, The Democratic Republic of the
        * `CG` - Congo
        * `CK` - Cook Islands
        * `CO` - Colombia
        * `KM` - Comoros
        * `CV` - Cabo Verde
        * `CR` - Costa Rica
        * `CU` - Cuba
        * `CW` - Curaçao
        * `CX` - Christmas Island
        * `KY` - Cayman Islands
        * `CY` - Cyprus
        * `CZ` - Czechia
        * `DE` - Germany
        * `DJ` - Djibouti
        * `DM` - Dominica
        * `DK` - Denmark
        * `DO` - Dominican Republic
        * `DZ` - Algeria
        * `EC` - Ecuador
        * `EG` - Egypt
        * `ER` - Eritrea
        * `EH` - Western Sahara
        * `ES` - Spain
        * `EE` - Estonia
        * `ET` - Ethiopia
        * `FI` - Finland
        * `FJ` - Fiji
        * `FK` - Falkland Islands (Malvinas)
        * `FR` - France
        * `FO` - Faroe Islands
        * `FM` - Micronesia, Federated States of
        * `GA` - Gabon
        * `GB` - United Kingdom
        * `GE` - Georgia
        * `GG` - Guernsey
        * `GH` - Ghana
        * `GI` - Gibraltar
        * `GN` - Guinea
        * `GP` - Guadeloupe
        * `GM` - Gambia
        * `GW` - Guinea-Bissau
        * `GQ` - Equatorial Guinea
        * `GR` - Greece
        * `GD` - Grenada
        * `GL` - Greenland
        * `GT` - Guatemala
        * `GF` - French Guiana
        * `GU` - Guam
        * `GY` - Guyana
        * `HK` - Hong Kong
        * `HM` - Heard Island and McDonald Islands
        * `HN` - Honduras
        * `HR` - Croatia
        * `HT` - Haiti
        * `HU` - Hungary
        * `ID` - Indonesia
        * `IM` - Isle of Man
        * `IN` - India
        * `IO` - British Indian Ocean Territory
        * `IE` - Ireland
        * `IR` - Iran, Islamic Republic of
        * `IQ` - Iraq
        * `IS` - Iceland
        * `IL` - Israel
        * `IT` - Italy
        * `JM` - Jamaica
        * `JE` - Jersey
        * `JO` - Jordan
        * `JP` - Japan
        * `KZ` - Kazakhstan
        * `KE` - Kenya
        * `KG` - Kyrgyzstan
        * `KH` - Cambodia
        * `KI` - Kiribati
        * `KN` - Saint Kitts and Nevis
        * `KR` - Korea, Republic of
        * `KW` - Kuwait
        * `LA` - Lao People's Democratic Republic
        * `LB` - Lebanon
        * `LR` - Liberia
        * `LY` - Libya
        * `LC` - Saint Lucia
        * `LI` - Liechtenstein
        * `LK` - Sri Lanka
        * `LS` - Lesotho
        * `LT` - Lithuania
        * `LU` - Luxembourg
        * `LV` - Latvia
        * `MO` - Macao
        * `MF` - Saint Martin (French part)
        * `MA` - Morocco
        * `MC` - Monaco
        * `MD` - Moldova, Republic of
        * `MG` - Madagascar
        * `MV` - Maldives
        * `MX` - Mexico
        * `MH` - Marshall Islands
        * `MK` - North Macedonia
        * `ML` - Mali
        * `MT` - Malta
        * `MM` - Myanmar
        * `ME` - Montenegro
        * `MN` - Mongolia
        * `MP` - Northern Mariana Islands
        * `MZ` - Mozambique
        * `MR` - Mauritania
        * `MS` - Montserrat
        * `MQ` - Martinique
        * `MU` - Mauritius
        * `MW` - Malawi
        * `MY` - Malaysia
        * `YT` - Mayotte
        * `NA` - Namibia
        * `NC` - New Caledonia
        * `NE` - Niger
        * `NF` - Norfolk Island
        * `NG` - Nigeria
        * `NI` - Nicaragua
        * `NU` - Niue
        * `NL` - Netherlands
        * `NO` - Norway
        * `NP` - Nepal
        * `NR` - Nauru
        * `NZ` - New Zealand
        * `OM` - Oman
        * `PK` - Pakistan
        * `PA` - Panama
        * `PN` - Pitcairn
        * `PE` - Peru
        * `PH` - Philippines
        * `PW` - Palau
        * `PG` - Papua New Guinea
        * `PL` - Poland
        * `PR` - Puerto Rico
        * `KP` - Korea, Democratic People's Republic of
        * `PT` - Portugal
        * `PY` - Paraguay
        * `PS` - Palestine, State of
        * `PF` - French Polynesia
        * `QA` - Qatar
        * `RE` - Réunion
        * `RO` - Romania
        * `RU` - Russian Federation
        * `RW` - Rwanda
        * `SA` - Saudi Arabia
        * `SD` - Sudan
        * `SN` - Senegal
        * `SG` - Singapore
        * `GS` - South Georgia and the South Sandwich Islands
        * `SH` - Saint Helena, Ascension and Tristan da Cunha
        * `SJ` - Svalbard and Jan Mayen
        * `SB` - Solomon Islands
        * `SL` - Sierra Leone
        * `SV` - El Salvador
        * `SM` - San Marino
        * `SO` - Somalia
        * `PM` - Saint Pierre and Miquelon
        * `RS` - Serbia
        * `SS` - South Sudan
        * `ST` - Sao Tome and Principe
        * `SR` - Suriname
        * `SK` - Slovakia
        * `SI` - Slovenia
        * `SE` - Sweden
        * `SZ` - Eswatini
        * `SX` - Sint Maarten (Dutch part)
        * `SC` - Seychelles
        * `SY` - Syrian Arab Republic
        * `TC` - Turks and Caicos Islands
        * `TD` - Chad
        * `TG` - Togo
        * `TH` - Thailand
        * `TJ` - Tajikistan
        * `TK` - Tokelau
        * `TM` - Turkmenistan
        * `TL` - Timor-Leste
        * `TO` - Tonga
        * `TT` - Trinidad and Tobago
        * `TN` - Tunisia
        * `TR` - Türkiye
        * `TV` - Tuvalu
        * `TW` - Taiwan, Province of China
        * `TZ` - Tanzania, United Republic of
        * `UG` - Uganda
        * `UA` - Ukraine
        * `UM` - United States Minor Outlying Islands
        * `UY` - Uruguay
        * `US` - United States
        * `UZ` - Uzbekistan
        * `VA` - Holy See (Vatican City State)
        * `VC` - Saint Vincent and the Grenadines
        * `VE` - Venezuela, Bolivarian Republic of
        * `VG` - Virgin Islands, British
        * `VI` - Virgin Islands, U.S.
        * `VN` - Viet Nam
        * `VU` - Vanuatu
        * `WF` - Wallis and Futuna
        * `WS` - Samoa
        * `YE` - Yemen
        * `ZA` - South Africa
        * `ZM` - Zambia
        * `ZW` - Zimbabwe
    DateFormatEnum:
      enum:
      - DD.MM.YYYY
      - YYYY-MM-DD
      - DD/MM/YYYY
      - MM/DD/YYYY
      type: string
      description: |-
        * `DD.MM.YYYY` - DD.MM.YYYY
        * `YYYY-MM-DD` - YYYY-MM-DD
        * `DD/MM/YYYY` - DD/MM/YYYY
        * `MM/DD/YYYY` - MM/DD/YYYY
    Device:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        user:
          type: string
          format: uri
        brand:
          type: string
          nullable: true
          maxLength: 100
        build_number:
          type: string
          nullable: true
          maxLength: 100
        device_country:
          type: string
          nullable: true
          maxLength: 2
        device_id:
          type: string
          nullable: true
          maxLength: 100
        device_locale:
          type: string
          nullable: true
          maxLength: 100
        free_disk_storage:
          type: integer
          maximum: 9223372036854775807
          minimum: -9223372036854775808
          format: int64
          nullable: true
        manufacturer:
          type: string
          nullable: true
          maxLength: 100
        model:
          type: string
          nullable: true
          maxLength: 100
        readable_version:
          type: string
          nullable: true
          maxLength: 100
        system_name:
          type: string
          nullable: true
          maxLength: 100
        system_version:
          type: string
          nullable: true
          maxLength: 100
        timezone:
          oneOf:
          - $ref: '#/components/schemas/TimezoneEnum'
          - $ref: '#/components/schemas/BlankEnum'
        version:
          type: string
          nullable: true
          maxLength: 100
        location_permission:
          type: string
          nullable: true
          maxLength: 100
        notification_permission:
          type: string
          nullable: true
          maxLength: 100
        motion_permission:
          type: string
          nullable: true
          maxLength: 100
        ios_app_tracking_permission:
          type: string
          nullable: true
          maxLength: 100
        battery_level:
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
        is_charging:
          type: boolean
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - created_at
      - id
      - url
      - user
    DistanceUnitsEnum:
      enum:
      - kilometers
      - miles
      type: string
      description: |-
        * `kilometers` - Kilometers
        * `miles` - Miles
    Document:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        external_id:
          type: string
          nullable: true
          maxLength: 100
        order:
          type: string
          format: uri
          nullable: true
        task:
          type: string
          format: uri
          nullable: true
        recurrence:
          type: string
          format: uri
          nullable: true
        contact_address:
          type: string
          format: uri
          nullable: true
        file_upload:
          type: string
          format: uri
          writeOnly: true
          nullable: true
        file:
          type: string
          format: uri
          readOnly: true
        file_name:
          type: string
          readOnly: true
        mimetype:
          type: string
          readOnly: true
          nullable: true
        thumbnail:
          type: string
          format: uri
          readOnly: true
        description:
          type: string
        s3_response_headers:
          writeOnly: true
        created_by:
          type: string
          format: uri
          readOnly: true
        source:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/Source265Enum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        visible_to_worker:
          type: boolean
        visible_to_client:
          type: boolean
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - created_at
      - created_by
      - file
      - file_name
      - id
      - mimetype
      - thumbnail
      - updated_at
      - url
    DocumentDeleteAction:
      type: object
      properties:
        account:
          type: string
          format: uri
        documents:
          type: array
          items:
            type: string
            format: uri
      required:
      - account
      - documents
    DocumentTaskInline:
      type: object
      description: Document serializer with inlined task data (API version >= 2.6.0)
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        external_id:
          type: string
          nullable: true
          maxLength: 100
        order:
          type: string
          format: uri
          nullable: true
        task:
          $ref: '#/components/schemas/TaskSerializerV2'
        recurrence:
          type: string
          format: uri
          nullable: true
        contact_address:
          type: string
          format: uri
          nullable: true
        file_upload:
          type: string
          format: uri
          writeOnly: true
          nullable: true
        file:
          type: string
          format: uri
          readOnly: true
        file_name:
          type: string
          readOnly: true
        mimetype:
          type: string
          readOnly: true
          nullable: true
        thumbnail:
          type: string
          format: uri
          readOnly: true
        description:
          type: string
        s3_response_headers:
          writeOnly: true
        created_by:
          type: string
          format: uri
          readOnly: true
        source:
          enum:
          - web
          - mobile
          - integration
          - ''
          - null
          type: string
          description: |-
            * `web` - Web
            * `mobile` - Mobile
            * `integration` - Integration
          nullable: true
        visible_to_worker:
          type: boolean
        visible_to_client:
          type: boolean
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - created_at
      - created_by
      - file
      - file_name
      - id
      - mimetype
      - task
      - thumbnail
      - updated_at
      - url
    DocumentUpdate:
      type: object
      description: |-
        Serializer for updating only the visibility fields of a document.

        - visible_to_client: Can be updated by any authenticated user with document access
        - visible_to_worker: Can only be updated by managers
      properties:
        visible_to_client:
          type: boolean
        visible_to_worker:
          type: boolean
    Email:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        external_id:
          type: string
          maxLength: 34
        state:
          allOf:
          - $ref: '#/components/schemas/EmailStateEnum'
          readOnly: true
        notification:
          type: string
          format: uri
          readOnly: true
        sender:
          type: string
          format: uri
          readOnly: true
        from_email:
          type: string
          format: email
          maxLength: 254
        reply_to_email:
          type: string
          format: email
          maxLength: 254
        to_emails:
          type: array
          items:
            type: string
            format: email
            maxLength: 254
        subject:
          type: string
          maxLength: 250
        message:
          type: string
        sent_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        failed_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        received_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - account
      - created_at
      - failed_at
      - id
      - message
      - notification
      - received_at
      - sender
      - sent_at
      - state
      - subject
      - url
    EmailStateEnum:
      enum:
      - queued
      - over_quota
      - sent
      - failed
      - received
      type: string
      description: |-
        * `queued` - Queued
        * `over_quota` - Over quota
        * `sent` - Sent
        * `failed` - Failed
        * `received` - Received
    EventEnum:
      enum:
      - create
      - assign
      - unassign
      - reject
      - restart
      - accept
      - unaccept
      - transit
      - activate
      - complete
      - fail
      - cancel
      - assignee_near
      - assignee_away
      - updated
      type: string
      description: |-
        * `create` - Create
        * `assign` - Assign
        * `unassign` - Unassign
        * `reject` - Reject
        * `restart` - Restart
        * `accept` - Accept
        * `unaccept` - Unaccept
        * `transit` - Transit
        * `activate` - Activate
        * `complete` - Complete
        * `fail` - Fail
        * `cancel` - Cancel
        * `assignee_near` - Assignee near
        * `assignee_away` - Assignee away
        * `updated` - Updated
    Export:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        export_model:
          $ref: '#/components/schemas/ExportModelEnum'
        field_names:
          type: array
          items:
            type: string
            maxLength: 100
          nullable: true
        format:
          $ref: '#/components/schemas/FormatEnum'
        link:
          type: string
          format: uri
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - account
      - created_at
      - export_model
      - format
      - id
      - link
      - updated_at
      - url
    ExportModelEnum:
      enum:
      - tasks
      type: string
      description: '* `tasks` - Tasks'
    FeatureAddressAutosuggestProviderEnum:
      enum:
      - google
      - regio-ee
      - janaseta
      - reach-u
      - nominatim
      - in-ads
      type: string
      description: |-
        * `google` - Google
        * `regio-ee` - Regio-Ee
        * `janaseta` - Jana Seta
        * `reach-u` - Reach-U
        * `nominatim` - Nominatim
        * `in-ads` - In-ADS
    FeatureTrackerMapProviderEnum:
      enum:
      - google
      - open-street-maps
      type: string
      description: |-
        * `google` - Google
        * `open-street-maps` - OpenStreetMap
    FieldEnum:
      enum:
      - state
      - assignee_proximity
      type: string
      description: "* `` - \n* `state` - State\n* `assignee_proximity` - Assignee\
        \ proximity"
    FieldTypeEnum:
      enum:
      - text_input
      - text_area
      - boolean
      - single_select
      - multi_select
      - array
      - integer
      - decimal
      type: string
      description: |-
        * `text_input` - Text input
        * `text_area` - Text area
        * `boolean` - Boolean
        * `single_select` - Single select
        * `multi_select` - Multi select
        * `array` - Array
        * `integer` - Integer
        * `decimal` - Decimal
    Form:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        name:
          type: string
          maxLength: 100
        description:
          type: string
        default_values:
          description: 'Default form field values as {slug: value}'
        created_by:
          type: string
          format: uri
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - account
      - created_at
      - created_by
      - id
      - name
      - updated_at
      - url
    FormField:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        form:
          type: string
          format: uri
        field_type:
          $ref: '#/components/schemas/FieldTypeEnum'
        field_name:
          type: string
          maxLength: 100
        parent_field:
          type: string
          format: uri
          nullable: true
        slug:
          type: string
          maxLength: 100
          pattern: ^[-a-zA-Z0-9_]+$
        description:
          type: string
        read_only:
          type: boolean
        order:
          type: integer
          maximum: 2147483647
          minimum: 0
        choices:
          description: 'For single_select/multi_select: ["Choice A", "Choice B", ...]'
        can_add_rows:
          type: boolean
          description: Whether users can add rows to this array field.
        can_delete_rows:
          type: boolean
          description: Whether users can delete rows from this array field.
        collapsed:
          type: boolean
          nullable: true
          description: Whether this array field is collapsed by default in the form
            UI.
        layout:
          nullable: true
          description: |-
            Row layout for this array field: 'list' (fields stacked) or 'table' (compact, one line).

            * `list` - List
            * `table` - Table
          oneOf:
          - $ref: '#/components/schemas/LayoutEnum'
          - $ref: '#/components/schemas/NullEnum'
        visible_to_worker:
          type: boolean
          nullable: true
          description: Whether this field is shown to workers (drivers) in the product
            UI. The API still returns the field and its values; clients are responsible
            for hiding it.
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - created_at
      - field_name
      - field_type
      - form
      - id
      - slug
      - updated_at
      - url
    FormResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        form:
          type: string
          format: uri
        task:
          type: string
          format: uri
        answers:
          description: 'Form answers as {slug: value}'
        state:
          allOf:
          - $ref: '#/components/schemas/FormResponseStateEnum'
          readOnly: true
        form_schema:
          readOnly: true
          description: Snapshot of form + fields at time of completion
        completed_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        completed_by:
          type: string
          format: uri
          readOnly: true
        created_by:
          type: string
          format: uri
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - completed_at
      - completed_by
      - created_at
      - created_by
      - form
      - form_schema
      - id
      - state
      - task
      - updated_at
      - url
    FormResponseCompleteError:
      type: object
      properties:
        non_field_errors:
          type: array
          items:
            type: string
      required:
      - non_field_errors
    FormResponseStateEnum:
      enum:
      - draft
      - completed
      type: string
      description: |-
        * `draft` - Draft
        * `completed` - Completed
    FormRule:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        is_active:
          type: boolean
        name:
          type: string
          maxLength: 50
        edit_url:
          type: string
          format: uri
          maxLength: 2048
        view_url:
          type: string
          format: uri
          nullable: true
          maxLength: 2048
        pdf_url:
          type: string
          format: uri
          nullable: true
          maxLength: 2048
        rules: {}
        open_in:
          $ref: '#/components/schemas/OpenInEnum'
        form:
          type: string
          format: uri
          nullable: true
      required:
      - account
      - id
      - name
      - url
    FormatEnum:
      enum:
      - json
      - xlsx
      type: string
      description: |-
        * `json` - JSON
        * `xlsx` - XLSX
    GeocodingProviderEnum:
      enum:
      - google
      - regio-ee
      - janaseta
      - reach-u
      - nominatim
      - in-ads
      type: string
      description: |-
        * `google` - Google
        * `regio-ee` - Regio-Ee
        * `janaseta` - Jana Seta
        * `reach-u` - Reach-U
        * `nominatim` - Nominatim
        * `in-ads` - In-ADS
    GisFeatureCollectionEnum:
      type: string
      enum:
      - FeatureCollection
    GisFeatureEnum:
      type: string
      enum:
      - Feature
    ImportMapping:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        field_names:
          type: array
          items:
            type: string
          writeOnly: true
        lines:
          type: array
          items:
            $ref: '#/components/schemas/ImportMappingLine'
        created_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - account
      - created_at
      - field_names
      - id
      - lines
      - url
    ImportMappingLine:
      type: object
      properties:
        from_field:
          type: string
          maxLength: 100
        to_field:
          type: string
          maxLength: 100
        format:
          type: string
          nullable: true
          maxLength: 200
      required:
      - from_field
    IntegrationRequest:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        account:
          type: string
          format: uri
        name:
          type: string
          maxLength: 200
        notes:
          type: string
        user:
          type: string
          format: uri
          readOnly: true
      required:
      - account
      - id
      - name
      - user
    Invoice:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          allOf:
          - $ref: '#/components/schemas/InvoiceAccount'
          readOnly: true
        billing_method:
          allOf:
          - $ref: '#/components/schemas/InvoiceBillingMethodEnum'
          readOnly: true
        state:
          allOf:
          - $ref: '#/components/schemas/InvoiceStateEnum'
          readOnly: true
        period:
          type: array
          items:
            type: string
            format: date
          readOnly: true
          nullable: true
          description: Indicates what period the price was calculated for
        total_no_vat:
          type: string
          format: decimal
          pattern: ^-?\d{0,7}(?:\.\d{0,2})?$
          readOnly: true
          nullable: true
        total_vat:
          type: string
          format: decimal
          pattern: ^-?\d{0,7}(?:\.\d{0,2})?$
          readOnly: true
        total_with_vat:
          type: string
          format: decimal
          pattern: ^-?\d{0,7}(?:\.\d{0,2})?$
          readOnly: true
        currency:
          type: string
          readOnly: true
        vat:
          type: boolean
          readOnly: true
        due_date:
          type: string
          format: date
          nullable: true
        paid_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        items:
          type: array
          items:
            $ref: '#/components/schemas/InvoiceItem'
          readOnly: true
        pricing:
          type: string
          format: uuid
          readOnly: true
        confirmed_by:
          type: string
          format: uri
          readOnly: true
        confirmed_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - account
      - billing_method
      - confirmed_at
      - confirmed_by
      - created_at
      - currency
      - id
      - items
      - paid_at
      - period
      - pricing
      - state
      - total_no_vat
      - total_vat
      - total_with_vat
      - updated_at
      - url
      - vat
    InvoiceAccount:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        slug:
          type: string
          readOnly: true
          pattern: ^[-a-zA-Z0-9_]+$
        name:
          type: string
          maxLength: 100
        registry_code:
          type: string
          maxLength: 20
        vatin:
          type: string
          maxLength: 20
        billing_reference:
          type: string
          maxLength: 20
        billing_email:
          type: string
          format: email
          title: Billing email address
          maxLength: 254
        billing_vat:
          type: boolean
      required:
      - id
      - name
      - slug
    InvoiceBillingMethodEnum:
      enum:
      - braintree
      - invoice
      - stripe
      type: string
      description: |-
        * `braintree` - Braintree
        * `invoice` - Invoice
        * `stripe` - Stripe
    InvoiceItem:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        invoice:
          type: string
          format: uri
        name:
          type: string
          maxLength: 200
        unit_price:
          type: string
          format: decimal
          pattern: ^-?\d{0,7}(?:\.\d{0,2})?$
        quantity:
          type: string
          format: decimal
          pattern: ^-?\d{0,7}(?:\.\d{0,4})?$
        unit:
          type: string
          maxLength: 50
        total:
          type: string
          format: decimal
          pattern: ^-?\d{0,7}(?:\.\d{0,2})?$
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - created_at
      - id
      - invoice
      - name
      - quantity
      - total
      - unit_price
      - updated_at
    InvoicePayment:
      type: object
      properties:
        paid_at:
          type: string
          format: date-time
          nullable: true
    InvoiceStateEnum:
      enum:
      - draft
      - confirmed
      - overdue
      - paid
      - cancelled
      type: string
      description: |-
        * `draft` - Draft
        * `confirmed` - Confirmed
        * `overdue` - Overdue
        * `paid` - Paid
        * `cancelled` - Cancelled
    LanguageEnum:
      enum:
      - af
      - ar
      - ar-dz
      - ast
      - az
      - bg
      - be
      - bn
      - br
      - bs
      - ca
      - ckb
      - cs
      - cy
      - da
      - de
      - dsb
      - el
      - en
      - en-au
      - en-gb
      - eo
      - es
      - es-ar
      - es-co
      - es-mx
      - es-ni
      - es-ve
      - et
      - eu
      - fa
      - fi
      - fr
      - fy
      - ga
      - gd
      - gl
      - he
      - hi
      - hr
      - hsb
      - hu
      - hy
      - ia
      - id
      - ig
      - io
      - is
      - it
      - ja
      - ka
      - kab
      - kk
      - km
      - kn
      - ko
      - ky
      - lb
      - lt
      - lv
      - mk
      - ml
      - mn
      - mr
      - ms
      - my
      - nb
      - ne
      - nl
      - nn
      - os
      - pa
      - pl
      - pt
      - pt-br
      - ro
      - ru
      - sk
      - sl
      - sq
      - sr
      - sr-latn
      - sv
      - sw
      - ta
      - te
      - tg
      - th
      - tk
      - tr
      - tt
      - udm
      - ug
      - uk
      - ur
      - uz
      - vi
      - zh-hans
      - zh-hant
      type: string
      description: |-
        * `af` - Afrikaans
        * `ar` - Arabic
        * `ar-dz` - Algerian Arabic
        * `ast` - Asturian
        * `az` - Azerbaijani
        * `bg` - Bulgarian
        * `be` - Belarusian
        * `bn` - Bengali
        * `br` - Breton
        * `bs` - Bosnian
        * `ca` - Catalan
        * `ckb` - Central Kurdish (Sorani)
        * `cs` - Czech
        * `cy` - Welsh
        * `da` - Danish
        * `de` - German
        * `dsb` - Lower Sorbian
        * `el` - Greek
        * `en` - English
        * `en-au` - Australian English
        * `en-gb` - British English
        * `eo` - Esperanto
        * `es` - Spanish
        * `es-ar` - Argentinian Spanish
        * `es-co` - Colombian Spanish
        * `es-mx` - Mexican Spanish
        * `es-ni` - Nicaraguan Spanish
        * `es-ve` - Venezuelan Spanish
        * `et` - Estonian
        * `eu` - Basque
        * `fa` - Persian
        * `fi` - Finnish
        * `fr` - French
        * `fy` - Frisian
        * `ga` - Irish
        * `gd` - Scottish Gaelic
        * `gl` - Galician
        * `he` - Hebrew
        * `hi` - Hindi
        * `hr` - Croatian
        * `hsb` - Upper Sorbian
        * `hu` - Hungarian
        * `hy` - Armenian
        * `ia` - Interlingua
        * `id` - Indonesian
        * `ig` - Igbo
        * `io` - Ido
        * `is` - Icelandic
        * `it` - Italian
        * `ja` - Japanese
        * `ka` - Georgian
        * `kab` - Kabyle
        * `kk` - Kazakh
        * `km` - Khmer
        * `kn` - Kannada
        * `ko` - Korean
        * `ky` - Kyrgyz
        * `lb` - Luxembourgish
        * `lt` - Lithuanian
        * `lv` - Latvian
        * `mk` - Macedonian
        * `ml` - Malayalam
        * `mn` - Mongolian
        * `mr` - Marathi
        * `ms` - Malay
        * `my` - Burmese
        * `nb` - Norwegian Bokmål
        * `ne` - Nepali
        * `nl` - Dutch
        * `nn` - Norwegian Nynorsk
        * `os` - Ossetic
        * `pa` - Punjabi
        * `pl` - Polish
        * `pt` - Portuguese
        * `pt-br` - Brazilian Portuguese
        * `ro` - Romanian
        * `ru` - Russian
        * `sk` - Slovak
        * `sl` - Slovenian
        * `sq` - Albanian
        * `sr` - Serbian
        * `sr-latn` - Serbian Latin
        * `sv` - Swedish
        * `sw` - Swahili
        * `ta` - Tamil
        * `te` - Telugu
        * `tg` - Tajik
        * `th` - Thai
        * `tk` - Turkmen
        * `tr` - Turkish
        * `tt` - Tatar
        * `udm` - Udmurt
        * `ug` - Uyghur
        * `uk` - Ukrainian
        * `ur` - Urdu
        * `uz` - Uzbek
        * `vi` - Vietnamese
        * `zh-hans` - Simplified Chinese
        * `zh-hant` - Traditional Chinese
    LayoutEnum:
      enum:
      - list
      - table
      type: string
      description: |-
        * `list` - List
        * `table` - Table
    LevelEnum:
      enum:
      - danger
      - warning
      - success
      type: string
      description: |-
        * `danger` - Danger
        * `warning` - warning
        * `success` - success
    Location:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/LocationTypeEnum'
        coordinates:
          type: array
          items:
            type: number
            format: double
          maxItems: 2
          minItems: 2
      required:
      - coordinates
      - type
    LocationTypeEnum:
      enum:
      - Point
      type: string
      description: '* `Point` - Point'
    Metafield:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        ordering:
          type: integer
          maximum: 2147483647
          minimum: 0
        namespace:
          type: string
          default: gsmtasks
          pattern: ^[a-z0-9_]+$
          maxLength: 20
        key:
          type: string
          pattern: ^[a-z0-9_]+$
          maxLength: 20
        field_name:
          type: string
          readOnly: true
        value_type:
          $ref: '#/components/schemas/ValueTypeEnum'
        label:
          type: string
          maxLength: 40
        choices:
          type: array
          items:
            type: string
            maxLength: 100
          nullable: true
        choices_url:
          type: string
          format: uri
          nullable: true
          maxLength: 2048
        is_editable:
          type: boolean
          description: Editable by manager
        is_editable_assignee:
          type: boolean
          description: Editable by assignee
        is_editable_when_archived:
          type: boolean
          description: Editable when task is completed or cancelled
        is_required:
          type: boolean
        is_required_before_complete:
          type: boolean
          title: Required before complete
        is_persistent:
          type: boolean
          description: Metadata, that will be copied during recurrence.
        is_cloned:
          type: boolean
          description: Metadata, that will be copied during cloning.
        source:
          type: string
          format: uuid
          nullable: true
        is_searchable:
          type: boolean
        show_in_list_view:
          type: boolean
        show_in_detail_view:
          type: boolean
        show_in_mobile_app:
          type: boolean
        show_in_form:
          type: boolean
        show_in_pod:
          type: boolean
          title: Show in proof of delivery
        show_when_task_type_assignment:
          type: boolean
        show_when_task_type_pick_up:
          type: boolean
        show_when_task_type_drop_off:
          type: boolean
        hide_when_empty:
          type: boolean
        applies_to:
          allOf:
          - $ref: '#/components/schemas/AppliesToEnum'
          description: |-
            What model this metafield applies to

            * `tasks` - Tasks
            * `routes` - Routes
            * `contact_addresses` - Contact Addresses
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - account
      - created_at
      - field_name
      - id
      - key
      - label
      - updated_at
      - url
    MethodEnum:
      enum:
      - app
      - email
      - sms
      type: string
      description: |-
        * `app` - app
        * `email` - email
        * `sms` - sms
    ModeEnum:
      enum:
      - online
      - offline
      type: string
      description: |-
        * `online` - Online
        * `offline` - Offline
    NestedAddress:
      type: object
      properties:
        raw_address:
          type: string
          maxLength: 250
        formatted_address:
          type: string
          maxLength: 250
        location:
          allOf:
          - $ref: '#/components/schemas/Location'
          nullable: true
        google_place_id:
          type: string
          maxLength: 250
        point_of_interest:
          type: string
          maxLength: 100
        street:
          type: string
          maxLength: 200
        geocoding_provider:
          readOnly: true
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/GeocodingProviderEnum'
          - $ref: '#/components/schemas/NullEnum'
        house_number:
          type: string
          maxLength: 100
        apartment_number:
          type: string
          nullable: true
          maxLength: 100
        city:
          type: string
          maxLength: 100
        state:
          type: string
          maxLength: 100
        postal_code:
          type: string
          maxLength: 100
        country:
          type: string
          maxLength: 100
        country_code:
          type: string
          maxLength: 2
        geocoded_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        geocode_failed_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
      required:
      - geocode_failed_at
      - geocoded_at
      - geocoding_provider
    NestedContact:
      type: object
      properties:
        name:
          type: string
          maxLength: 200
        company:
          type: string
          maxLength: 200
        phones:
          type: array
          items:
            type: string
            maxLength: 100
        emails:
          type: array
          items:
            type: string
            maxLength: 100
        notes:
          type: string
    NestedContactAddress:
      type: object
      properties:
        address:
          $ref: '#/components/schemas/NestedAddress'
      required:
      - address
    Notification:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        method:
          allOf:
          - $ref: '#/components/schemas/MethodEnum'
          readOnly: true
        task:
          type: string
          format: uri
        template:
          type: string
          format: uri
          nullable: true
        event:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/EventEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        state:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/TaskStateEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        assignee_proximity:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/AssigneeProximityEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        recipient:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/RecipientEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        emails:
          type: array
          items:
            type: string
            format: email
          nullable: true
        phones:
          type: array
          items:
            type: string
            maxLength: 128
        message:
          type: string
        add_tracking_link:
          type: boolean
        sms_count:
          type: integer
          readOnly: true
        sent_at:
          type: string
          format: date-time
          nullable: true
        via_app:
          type: boolean
          readOnly: true
        via_email:
          type: boolean
          readOnly: true
        via_sms:
          type: boolean
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - created_at
      - id
      - method
      - sms_count
      - task
      - updated_at
      - url
      - via_app
      - via_email
      - via_sms
    NotificationTemplate:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        name:
          type: string
          maxLength: 100
        event:
          oneOf:
          - $ref: '#/components/schemas/EventEnum'
          - $ref: '#/components/schemas/BlankEnum'
        state:
          oneOf:
          - $ref: '#/components/schemas/TaskStateEnum'
          - $ref: '#/components/schemas/BlankEnum'
        task_category:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/TaskCategoryEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        scheduled_time_added:
          type: boolean
        scheduled_time_change:
          type: boolean
        recipient:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/RecipientEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        emails:
          type: array
          items:
            type: string
            format: email
            maxLength: 254
        phones:
          type: array
          items:
            type: string
            maxLength: 128
        via_sms:
          type: boolean
        via_email:
          type: boolean
        via_app:
          type: boolean
        is_active:
          type: boolean
        message:
          type: string
        subject:
          type: string
          maxLength: 300
        email_reply_to:
          type: string
          format: email
          maxLength: 254
        pod_attach_to_email:
          type: boolean
        pod_show_images:
          type: boolean
        pod_show_signatures:
          type: boolean
        pod_show_task_events:
          type: boolean
        pod_show_task_event_creators:
          type: boolean
        pod_show_reference:
          type: boolean
          nullable: true
        pod_show_description:
          type: boolean
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - account
      - created_at
      - id
      - message
      - name
      - updated_at
      - url
    NullEnum:
      enum:
      - null
    ObjectiveEnum:
      enum:
      - vehicles
      - transport_time
      - completion_time
      type: string
      description: |-
        * `vehicles` - Vehicles
        * `transport_time` - Transport Time
        * `completion_time` - Completion Time
    OnDuty:
      type: object
      properties:
        account:
          type: string
          format: uri
      required:
      - account
    OpenInEnum:
      enum:
      - webview
      - in-app-browser
      type: string
      description: |-
        * `webview` - Webview
        * `in-app-browser` - In app browser
    OrderData:
      type: object
      properties:
        auto_assign:
          type: boolean
          default: false
        description:
          type: string
        reference:
          type: string
          default: ''
          maxLength: 100
        client:
          type: string
          format: uri
          nullable: true
        orderer: {}
    OrderSerializerV2:
      type: object
      properties:
        id:
          type: string
          format: uuid
          nullable: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        external_id:
          type: string
          nullable: true
          maxLength: 100
        reference:
          type: string
          maxLength: 100
        client:
          type: string
          format: uri
          nullable: true
        orderer:
          $ref: '#/components/schemas/NestedContact'
        tasks:
          type: array
          items:
            type: string
            format: uri
        tasks_data:
          type: array
          items:
            $ref: '#/components/schemas/TaskSerializerV2'
          writeOnly: true
        documents:
          type: array
          items:
            type: string
            format: uri
          readOnly: true
        auto_assign:
          type: boolean
        description:
          type: string
        created_by:
          type: string
          format: uri
          readOnly: true
        recurrence:
          type: string
          format: uri
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - account
      - created_at
      - created_by
      - documents
      - recurrence
      - updated_at
      - url
    PaginatedAccountList:
      type: array
      items:
        $ref: '#/components/schemas/Account'
    PaginatedAccountRoleList:
      type: array
      items:
        $ref: '#/components/schemas/AccountRole'
    PaginatedAddonList:
      type: array
      items:
        $ref: '#/components/schemas/Addon'
    PaginatedClientList:
      type: array
      items:
        $ref: '#/components/schemas/Client'
    PaginatedClientRoleList:
      type: array
      items:
        $ref: '#/components/schemas/ClientRole'
    PaginatedConfigurationSerializerV2List:
      type: array
      items:
        $ref: '#/components/schemas/ConfigurationSerializerV2'
    PaginatedContactAddressBackgroundImportList:
      type: array
      items:
        $ref: '#/components/schemas/ContactAddressBackgroundImport'
    PaginatedContactAddressExportList:
      type: array
      items:
        $ref: '#/components/schemas/ContactAddressExport'
    PaginatedContactAddressList:
      type: array
      items:
        $ref: '#/components/schemas/ContactAddress'
    PaginatedDeviceList:
      type: array
      items:
        $ref: '#/components/schemas/Device'
    PaginatedDocumentList:
      type: array
      items:
        $ref: '#/components/schemas/Document'
    PaginatedEmailList:
      type: array
      items:
        $ref: '#/components/schemas/Email'
    PaginatedExportList:
      type: array
      items:
        $ref: '#/components/schemas/Export'
    PaginatedFormFieldList:
      type: array
      items:
        $ref: '#/components/schemas/FormField'
    PaginatedFormList:
      type: array
      items:
        $ref: '#/components/schemas/Form'
    PaginatedFormResponseList:
      type: array
      items:
        $ref: '#/components/schemas/FormResponse'
    PaginatedFormRuleList:
      type: array
      items:
        $ref: '#/components/schemas/FormRule'
    PaginatedImportMappingList:
      type: array
      items:
        $ref: '#/components/schemas/ImportMapping'
    PaginatedInvoiceList:
      type: array
      items:
        $ref: '#/components/schemas/Invoice'
    PaginatedMetafieldList:
      type: array
      items:
        $ref: '#/components/schemas/Metafield'
    PaginatedNotificationList:
      type: array
      items:
        $ref: '#/components/schemas/Notification'
    PaginatedNotificationTemplateList:
      type: array
      items:
        $ref: '#/components/schemas/NotificationTemplate'
    PaginatedOrderSerializerV2List:
      type: array
      items:
        $ref: '#/components/schemas/OrderSerializerV2'
    PaginatedPushNotificationList:
      type: array
      items:
        $ref: '#/components/schemas/PushNotification'
    PaginatedReadableUserList:
      type: array
      items:
        $ref: '#/components/schemas/ReadableUser'
    PaginatedRecurrenceList:
      type: array
      items:
        $ref: '#/components/schemas/Recurrence'
    PaginatedReviewList:
      type: array
      items:
        $ref: '#/components/schemas/Review'
    PaginatedRouteList:
      type: array
      items:
        $ref: '#/components/schemas/Route'
    PaginatedRouteOptimizationSerializerV2List:
      type: array
      items:
        $ref: '#/components/schemas/RouteOptimizationSerializerV2'
    PaginatedS3FileUploadList:
      type: array
      items:
        $ref: '#/components/schemas/S3FileUpload'
    PaginatedSMSList:
      type: array
      items:
        $ref: '#/components/schemas/SMS'
    PaginatedSessionTokenList:
      type: array
      items:
        $ref: '#/components/schemas/SessionToken'
    PaginatedSignatureList:
      type: array
      items:
        $ref: '#/components/schemas/Signature'
    PaginatedStripePaymentList:
      type: array
      items:
        $ref: '#/components/schemas/StripePayment'
    PaginatedTaskAddressFeatureList:
      $ref: '#/components/schemas/TaskAddressFeatureList'
    PaginatedTaskCommandList:
      type: array
      items:
        $ref: '#/components/schemas/TaskCommand'
    PaginatedTaskEventList:
      type: array
      items:
        $ref: '#/components/schemas/TaskEvent'
    PaginatedTaskEventSerializerV2List:
      type: array
      items:
        $ref: '#/components/schemas/TaskEventSerializerV2'
    PaginatedTaskEventTrackList:
      $ref: '#/components/schemas/TaskEventTrackList'
    PaginatedTaskExportList:
      type: array
      items:
        $ref: '#/components/schemas/TaskExport'
    PaginatedTaskFormList:
      type: array
      items:
        $ref: '#/components/schemas/TaskForm'
    PaginatedTaskListReorderResponseTaskList:
      type: array
      items:
        $ref: '#/components/schemas/TaskListReorderResponseTask'
    PaginatedTaskMetadataList:
      type: array
      items:
        $ref: '#/components/schemas/TaskMetadata'
    PaginatedTaskSerializerV2List:
      type: array
      items:
        $ref: '#/components/schemas/TaskSerializerV2'
    PaginatedTasksBackgroundImportList:
      type: array
      items:
        $ref: '#/components/schemas/TasksBackgroundImport'
    PaginatedTimeLocationFeatureList:
      $ref: '#/components/schemas/TimeLocationFeatureList'
    PaginatedTimeLocationList:
      type: array
      items:
        $ref: '#/components/schemas/TimeLocation'
    PaginatedTrackerList:
      type: array
      items:
        $ref: '#/components/schemas/Tracker'
    PaginatedWebhookList:
      type: array
      items:
        $ref: '#/components/schemas/Webhook'
    PaginatedWorkerFeatureList:
      $ref: '#/components/schemas/WorkerFeatureList'
    PaginatedWorkingStateList:
      type: array
      items:
        $ref: '#/components/schemas/WorkingState'
    PasswordChange:
      type: object
      properties:
        old_password:
          type: string
        new_password1:
          type: string
        new_password2:
          type: string
      required:
      - new_password1
      - new_password2
      - old_password
    PasswordReset:
      type: object
      properties:
        email:
          type: string
          format: email
      required:
      - email
    PasswordResetConfirm:
      type: object
      properties:
        uid:
          type: string
        token:
          type: string
        new_password1:
          type: string
        new_password2:
          type: string
      required:
      - new_password1
      - new_password2
      - token
      - uid
    PatchedAccount:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        name:
          type: string
          maxLength: 100
        state:
          allOf:
          - $ref: '#/components/schemas/AccountStateEnum'
          readOnly: true
        type:
          oneOf:
          - $ref: '#/components/schemas/AccountTypeEnum'
          - $ref: '#/components/schemas/BlankEnum'
        slug:
          type: string
          readOnly: true
          pattern: ^[-a-zA-Z0-9_]+$
        owner:
          type: string
          format: uri
          readOnly: true
        email:
          type: string
          format: email
          maxLength: 254
        notification_emails:
          type: array
          items:
            type: string
            format: email
            maxLength: 254
        review_emails:
          type: array
          items:
            type: string
            format: email
            maxLength: 254
        review_emails_to_assignee:
          type: boolean
        website:
          type: string
          maxLength: 200
        registry_code:
          type: string
          maxLength: 20
        vatin:
          type: string
          maxLength: 20
        language:
          allOf:
          - $ref: '#/components/schemas/LanguageEnum'
          title: Prefered language
        timezone:
          $ref: '#/components/schemas/TimezoneEnum'
        country_code:
          oneOf:
          - $ref: '#/components/schemas/CountryCodeEnum'
          - $ref: '#/components/schemas/BlankEnum'
        address:
          allOf:
          - $ref: '#/components/schemas/NestedAddress'
          nullable: true
        custom_integration_url:
          type: string
          format: uri
          readOnly: true
        failed_reasons:
          type: array
          items:
            type: string
            maxLength: 200
          nullable: true
        route_default_state:
          $ref: '#/components/schemas/RouteDefaultStateEnum'
        distance_units:
          $ref: '#/components/schemas/DistanceUnitsEnum'
        task_duration:
          type: object
          title: Default task duration
          default: 4 10:55:34.12
        task_expiry_duration_from_complete_after:
          type: object
          nullable: true
          description: HH:mm:ss
          default: 4 10:55:34.12
        task_expiry_duration_from_complete_before:
          type: object
          nullable: true
          description: HH:mm:ss
          default: 4 10:55:34.12
        task_expiry_state:
          $ref: '#/components/schemas/TaskExpiryStateEnum'
        assignee_proximity_radius:
          type: integer
          maximum: 2147483647
          minimum: 0
        default_task_category:
          type: string
        transit_active_limit:
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
        default_create_contact_address:
          type: boolean
        date_format:
          $ref: '#/components/schemas/DateFormatEnum'
        time_format:
          $ref: '#/components/schemas/TimeFormatEnum'
        route_start_address:
          allOf:
          - $ref: '#/components/schemas/NestedAddress'
          nullable: true
        route_end_address:
          allOf:
          - $ref: '#/components/schemas/NestedAddress'
          nullable: true
        optimize_after_create:
          type: boolean
        optimization_objective:
          allOf:
          - $ref: '#/components/schemas/ObjectiveEnum'
          title: Default optimization objective
          description: |-
            Specify the default objective for your optimizationions

            * `vehicles` - Vehicles
            * `transport_time` - Transport Time
            * `completion_time` - Completion Time
        reference_autogenerate:
          type: boolean
        reference_offset:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        reference_prefix:
          type: string
          maxLength: 50
        reference_length:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        feature_show_unassigned_to_workers:
          type: boolean
        feature_task_created_sound:
          type: boolean
        feature_change_task_account:
          type: boolean
        feature_show_tutorial:
          type: boolean
        feature_navigation_app_selection:
          type: boolean
        feature_navigation_use_address:
          type: boolean
        feature_task_accept:
          type: boolean
        feature_task_reject:
          type: boolean
        feature_app_task_search:
          type: boolean
        feature_address_autosuggest_provider:
          $ref: '#/components/schemas/FeatureAddressAutosuggestProviderEnum'
        feature_geocoding_country_code:
          allOf:
          - $ref: '#/components/schemas/CountryCodeEnum'
          readOnly: true
          description: |-
            Limit geocoding to the selected country.

            * `AW` - Aruba
            * `AF` - Afghanistan
            * `AO` - Angola
            * `AI` - Anguilla
            * `AX` - Åland Islands
            * `AL` - Albania
            * `AD` - Andorra
            * `AE` - United Arab Emirates
            * `AR` - Argentina
            * `AM` - Armenia
            * `AS` - American Samoa
            * `AQ` - Antarctica
            * `TF` - French Southern Territories
            * `AG` - Antigua and Barbuda
            * `AU` - Australia
            * `AT` - Austria
            * `AZ` - Azerbaijan
            * `BI` - Burundi
            * `BE` - Belgium
            * `BJ` - Benin
            * `BQ` - Bonaire, Sint Eustatius and Saba
            * `BF` - Burkina Faso
            * `BD` - Bangladesh
            * `BG` - Bulgaria
            * `BH` - Bahrain
            * `BS` - Bahamas
            * `BA` - Bosnia and Herzegovina
            * `BL` - Saint Barthélemy
            * `BY` - Belarus
            * `BZ` - Belize
            * `BM` - Bermuda
            * `BO` - Bolivia, Plurinational State of
            * `BR` - Brazil
            * `BB` - Barbados
            * `BN` - Brunei Darussalam
            * `BT` - Bhutan
            * `BV` - Bouvet Island
            * `BW` - Botswana
            * `CF` - Central African Republic
            * `CA` - Canada
            * `CC` - Cocos (Keeling) Islands
            * `CH` - Switzerland
            * `CL` - Chile
            * `CN` - China
            * `CI` - Côte d'Ivoire
            * `CM` - Cameroon
            * `CD` - Congo, The Democratic Republic of the
            * `CG` - Congo
            * `CK` - Cook Islands
            * `CO` - Colombia
            * `KM` - Comoros
            * `CV` - Cabo Verde
            * `CR` - Costa Rica
            * `CU` - Cuba
            * `CW` - Curaçao
            * `CX` - Christmas Island
            * `KY` - Cayman Islands
            * `CY` - Cyprus
            * `CZ` - Czechia
            * `DE` - Germany
            * `DJ` - Djibouti
            * `DM` - Dominica
            * `DK` - Denmark
            * `DO` - Dominican Republic
            * `DZ` - Algeria
            * `EC` - Ecuador
            * `EG` - Egypt
            * `ER` - Eritrea
            * `EH` - Western Sahara
            * `ES` - Spain
            * `EE` - Estonia
            * `ET` - Ethiopia
            * `FI` - Finland
            * `FJ` - Fiji
            * `FK` - Falkland Islands (Malvinas)
            * `FR` - France
            * `FO` - Faroe Islands
            * `FM` - Micronesia, Federated States of
            * `GA` - Gabon
            * `GB` - United Kingdom
            * `GE` - Georgia
            * `GG` - Guernsey
            * `GH` - Ghana
            * `GI` - Gibraltar
            * `GN` - Guinea
            * `GP` - Guadeloupe
            * `GM` - Gambia
            * `GW` - Guinea-Bissau
            * `GQ` - Equatorial Guinea
            * `GR` - Greece
            * `GD` - Grenada
            * `GL` - Greenland
            * `GT` - Guatemala
            * `GF` - French Guiana
            * `GU` - Guam
            * `GY` - Guyana
            * `HK` - Hong Kong
            * `HM` - Heard Island and McDonald Islands
            * `HN` - Honduras
            * `HR` - Croatia
            * `HT` - Haiti
            * `HU` - Hungary
            * `ID` - Indonesia
            * `IM` - Isle of Man
            * `IN` - India
            * `IO` - British Indian Ocean Territory
            * `IE` - Ireland
            * `IR` - Iran, Islamic Republic of
            * `IQ` - Iraq
            * `IS` - Iceland
            * `IL` - Israel
            * `IT` - Italy
            * `JM` - Jamaica
            * `JE` - Jersey
            * `JO` - Jordan
            * `JP` - Japan
            * `KZ` - Kazakhstan
            * `KE` - Kenya
            * `KG` - Kyrgyzstan
            * `KH` - Cambodia
            * `KI` - Kiribati
            * `KN` - Saint Kitts and Nevis
            * `KR` - Korea, Republic of
            * `KW` - Kuwait
            * `LA` - Lao People's Democratic Republic
            * `LB` - Lebanon
            * `LR` - Liberia
            * `LY` - Libya
            * `LC` - Saint Lucia
            * `LI` - Liechtenstein
            * `LK` - Sri Lanka
            * `LS` - Lesotho
            * `LT` - Lithuania
            * `LU` - Luxembourg
            * `LV` - Latvia
            * `MO` - Macao
            * `MF` - Saint Martin (French part)
            * `MA` - Morocco
            * `MC` - Monaco
            * `MD` - Moldova, Republic of
            * `MG` - Madagascar
            * `MV` - Maldives
            * `MX` - Mexico
            * `MH` - Marshall Islands
            * `MK` - North Macedonia
            * `ML` - Mali
            * `MT` - Malta
            * `MM` - Myanmar
            * `ME` - Montenegro
            * `MN` - Mongolia
            * `MP` - Northern Mariana Islands
            * `MZ` - Mozambique
            * `MR` - Mauritania
            * `MS` - Montserrat
            * `MQ` - Martinique
            * `MU` - Mauritius
            * `MW` - Malawi
            * `MY` - Malaysia
            * `YT` - Mayotte
            * `NA` - Namibia
            * `NC` - New Caledonia
            * `NE` - Niger
            * `NF` - Norfolk Island
            * `NG` - Nigeria
            * `NI` - Nicaragua
            * `NU` - Niue
            * `NL` - Netherlands
            * `NO` - Norway
            * `NP` - Nepal
            * `NR` - Nauru
            * `NZ` - New Zealand
            * `OM` - Oman
            * `PK` - Pakistan
            * `PA` - Panama
            * `PN` - Pitcairn
            * `PE` - Peru
            * `PH` - Philippines
            * `PW` - Palau
            * `PG` - Papua New Guinea
            * `PL` - Poland
            * `PR` - Puerto Rico
            * `KP` - Korea, Democratic People's Republic of
            * `PT` - Portugal
            * `PY` - Paraguay
            * `PS` - Palestine, State of
            * `PF` - French Polynesia
            * `QA` - Qatar
            * `RE` - Réunion
            * `RO` - Romania
            * `RU` - Russian Federation
            * `RW` - Rwanda
            * `SA` - Saudi Arabia
            * `SD` - Sudan
            * `SN` - Senegal
            * `SG` - Singapore
            * `GS` - South Georgia and the South Sandwich Islands
            * `SH` - Saint Helena, Ascension and Tristan da Cunha
            * `SJ` - Svalbard and Jan Mayen
            * `SB` - Solomon Islands
            * `SL` - Sierra Leone
            * `SV` - El Salvador
            * `SM` - San Marino
            * `SO` - Somalia
            * `PM` - Saint Pierre and Miquelon
            * `RS` - Serbia
            * `SS` - South Sudan
            * `ST` - Sao Tome and Principe
            * `SR` - Suriname
            * `SK` - Slovakia
            * `SI` - Slovenia
            * `SE` - Sweden
            * `SZ` - Eswatini
            * `SX` - Sint Maarten (Dutch part)
            * `SC` - Seychelles
            * `SY` - Syrian Arab Republic
            * `TC` - Turks and Caicos Islands
            * `TD` - Chad
            * `TG` - Togo
            * `TH` - Thailand
            * `TJ` - Tajikistan
            * `TK` - Tokelau
            * `TM` - Turkmenistan
            * `TL` - Timor-Leste
            * `TO` - Tonga
            * `TT` - Trinidad and Tobago
            * `TN` - Tunisia
            * `TR` - Türkiye
            * `TV` - Tuvalu
            * `TW` - Taiwan, Province of China
            * `TZ` - Tanzania, United Republic of
            * `UG` - Uganda
            * `UA` - Ukraine
            * `UM` - United States Minor Outlying Islands
            * `UY` - Uruguay
            * `US` - United States
            * `UZ` - Uzbekistan
            * `VA` - Holy See (Vatican City State)
            * `VC` - Saint Vincent and the Grenadines
            * `VE` - Venezuela, Bolivarian Republic of
            * `VG` - Virgin Islands, British
            * `VI` - Virgin Islands, U.S.
            * `VN` - Viet Nam
            * `VU` - Vanuatu
            * `WF` - Wallis and Futuna
            * `WS` - Samoa
            * `YE` - Yemen
            * `ZA` - South Africa
            * `ZM` - Zambia
            * `ZW` - Zimbabwe
        feature_google_maps_region:
          allOf:
          - $ref: '#/components/schemas/CountryCodeEnum'
          readOnly: true
          description: |-
            Google Maps region code for map tiles and territorial display (e.g. MA for Morocco).

            * `AW` - Aruba
            * `AF` - Afghanistan
            * `AO` - Angola
            * `AI` - Anguilla
            * `AX` - Åland Islands
            * `AL` - Albania
            * `AD` - Andorra
            * `AE` - United Arab Emirates
            * `AR` - Argentina
            * `AM` - Armenia
            * `AS` - American Samoa
            * `AQ` - Antarctica
            * `TF` - French Southern Territories
            * `AG` - Antigua and Barbuda
            * `AU` - Australia
            * `AT` - Austria
            * `AZ` - Azerbaijan
            * `BI` - Burundi
            * `BE` - Belgium
            * `BJ` - Benin
            * `BQ` - Bonaire, Sint Eustatius and Saba
            * `BF` - Burkina Faso
            * `BD` - Bangladesh
            * `BG` - Bulgaria
            * `BH` - Bahrain
            * `BS` - Bahamas
            * `BA` - Bosnia and Herzegovina
            * `BL` - Saint Barthélemy
            * `BY` - Belarus
            * `BZ` - Belize
            * `BM` - Bermuda
            * `BO` - Bolivia, Plurinational State of
            * `BR` - Brazil
            * `BB` - Barbados
            * `BN` - Brunei Darussalam
            * `BT` - Bhutan
            * `BV` - Bouvet Island
            * `BW` - Botswana
            * `CF` - Central African Republic
            * `CA` - Canada
            * `CC` - Cocos (Keeling) Islands
            * `CH` - Switzerland
            * `CL` - Chile
            * `CN` - China
            * `CI` - Côte d'Ivoire
            * `CM` - Cameroon
            * `CD` - Congo, The Democratic Republic of the
            * `CG` - Congo
            * `CK` - Cook Islands
            * `CO` - Colombia
            * `KM` - Comoros
            * `CV` - Cabo Verde
            * `CR` - Costa Rica
            * `CU` - Cuba
            * `CW` - Curaçao
            * `CX` - Christmas Island
            * `KY` - Cayman Islands
            * `CY` - Cyprus
            * `CZ` - Czechia
            * `DE` - Germany
            * `DJ` - Djibouti
            * `DM` - Dominica
            * `DK` - Denmark
            * `DO` - Dominican Republic
            * `DZ` - Algeria
            * `EC` - Ecuador
            * `EG` - Egypt
            * `ER` - Eritrea
            * `EH` - Western Sahara
            * `ES` - Spain
            * `EE` - Estonia
            * `ET` - Ethiopia
            * `FI` - Finland
            * `FJ` - Fiji
            * `FK` - Falkland Islands (Malvinas)
            * `FR` - France
            * `FO` - Faroe Islands
            * `FM` - Micronesia, Federated States of
            * `GA` - Gabon
            * `GB` - United Kingdom
            * `GE` - Georgia
            * `GG` - Guernsey
            * `GH` - Ghana
            * `GI` - Gibraltar
            * `GN` - Guinea
            * `GP` - Guadeloupe
            * `GM` - Gambia
            * `GW` - Guinea-Bissau
            * `GQ` - Equatorial Guinea
            * `GR` - Greece
            * `GD` - Grenada
            * `GL` - Greenland
            * `GT` - Guatemala
            * `GF` - French Guiana
            * `GU` - Guam
            * `GY` - Guyana
            * `HK` - Hong Kong
            * `HM` - Heard Island and McDonald Islands
            * `HN` - Honduras
            * `HR` - Croatia
            * `HT` - Haiti
            * `HU` - Hungary
            * `ID` - Indonesia
            * `IM` - Isle of Man
            * `IN` - India
            * `IO` - British Indian Ocean Territory
            * `IE` - Ireland
            * `IR` - Iran, Islamic Republic of
            * `IQ` - Iraq
            * `IS` - Iceland
            * `IL` - Israel
            * `IT` - Italy
            * `JM` - Jamaica
            * `JE` - Jersey
            * `JO` - Jordan
            * `JP` - Japan
            * `KZ` - Kazakhstan
            * `KE` - Kenya
            * `KG` - Kyrgyzstan
            * `KH` - Cambodia
            * `KI` - Kiribati
            * `KN` - Saint Kitts and Nevis
            * `KR` - Korea, Republic of
            * `KW` - Kuwait
            * `LA` - Lao People's Democratic Republic
            * `LB` - Lebanon
            * `LR` - Liberia
            * `LY` - Libya
            * `LC` - Saint Lucia
            * `LI` - Liechtenstein
            * `LK` - Sri Lanka
            * `LS` - Lesotho
            * `LT` - Lithuania
            * `LU` - Luxembourg
            * `LV` - Latvia
            * `MO` - Macao
            * `MF` - Saint Martin (French part)
            * `MA` - Morocco
            * `MC` - Monaco
            * `MD` - Moldova, Republic of
            * `MG` - Madagascar
            * `MV` - Maldives
            * `MX` - Mexico
            * `MH` - Marshall Islands
            * `MK` - North Macedonia
            * `ML` - Mali
            * `MT` - Malta
            * `MM` - Myanmar
            * `ME` - Montenegro
            * `MN` - Mongolia
            * `MP` - Northern Mariana Islands
            * `MZ` - Mozambique
            * `MR` - Mauritania
            * `MS` - Montserrat
            * `MQ` - Martinique
            * `MU` - Mauritius
            * `MW` - Malawi
            * `MY` - Malaysia
            * `YT` - Mayotte
            * `NA` - Namibia
            * `NC` - New Caledonia
            * `NE` - Niger
            * `NF` - Norfolk Island
            * `NG` - Nigeria
            * `NI` - Nicaragua
            * `NU` - Niue
            * `NL` - Netherlands
            * `NO` - Norway
            * `NP` - Nepal
            * `NR` - Nauru
            * `NZ` - New Zealand
            * `OM` - Oman
            * `PK` - Pakistan
            * `PA` - Panama
            * `PN` - Pitcairn
            * `PE` - Peru
            * `PH` - Philippines
            * `PW` - Palau
            * `PG` - Papua New Guinea
            * `PL` - Poland
            * `PR` - Puerto Rico
            * `KP` - Korea, Democratic People's Republic of
            * `PT` - Portugal
            * `PY` - Paraguay
            * `PS` - Palestine, State of
            * `PF` - French Polynesia
            * `QA` - Qatar
            * `RE` - Réunion
            * `RO` - Romania
            * `RU` - Russian Federation
            * `RW` - Rwanda
            * `SA` - Saudi Arabia
            * `SD` - Sudan
            * `SN` - Senegal
            * `SG` - Singapore
            * `GS` - South Georgia and the South Sandwich Islands
            * `SH` - Saint Helena, Ascension and Tristan da Cunha
            * `SJ` - Svalbard and Jan Mayen
            * `SB` - Solomon Islands
            * `SL` - Sierra Leone
            * `SV` - El Salvador
            * `SM` - San Marino
            * `SO` - Somalia
            * `PM` - Saint Pierre and Miquelon
            * `RS` - Serbia
            * `SS` - South Sudan
            * `ST` - Sao Tome and Principe
            * `SR` - Suriname
            * `SK` - Slovakia
            * `SI` - Slovenia
            * `SE` - Sweden
            * `SZ` - Eswatini
            * `SX` - Sint Maarten (Dutch part)
            * `SC` - Seychelles
            * `SY` - Syrian Arab Republic
            * `TC` - Turks and Caicos Islands
            * `TD` - Chad
            * `TG` - Togo
            * `TH` - Thailand
            * `TJ` - Tajikistan
            * `TK` - Tokelau
            * `TM` - Turkmenistan
            * `TL` - Timor-Leste
            * `TO` - Tonga
            * `TT` - Trinidad and Tobago
            * `TN` - Tunisia
            * `TR` - Türkiye
            * `TV` - Tuvalu
            * `TW` - Taiwan, Province of China
            * `TZ` - Tanzania, United Republic of
            * `UG` - Uganda
            * `UA` - Ukraine
            * `UM` - United States Minor Outlying Islands
            * `UY` - Uruguay
            * `US` - United States
            * `UZ` - Uzbekistan
            * `VA` - Holy See (Vatican City State)
            * `VC` - Saint Vincent and the Grenadines
            * `VE` - Venezuela, Bolivarian Republic of
            * `VG` - Virgin Islands, British
            * `VI` - Virgin Islands, U.S.
            * `VN` - Viet Nam
            * `VU` - Vanuatu
            * `WF` - Wallis and Futuna
            * `WS` - Samoa
            * `YE` - Yemen
            * `ZA` - South Africa
            * `ZM` - Zambia
            * `ZW` - Zimbabwe
        feature_document_signing:
          type: boolean
          description: Allow choosing documents to sign.
        feature_tracker_map_provider:
          oneOf:
          - $ref: '#/components/schemas/FeatureTrackerMapProviderEnum'
          - $ref: '#/components/schemas/BlankEnum'
        feature_tracker_reviews_allowed:
          type: boolean
        feature_tracker_url:
          type: string
          readOnly: true
        feature_contact_address_related_tasks_visibility:
          type: boolean
          description: 'Enable contact address visibility features: task history and
            document sideloading for workers'
        feature_route_folders:
          type: boolean
          readOnly: true
          description: Allow tasks to be grouped into routes.
        feature_route_auto_archive:
          type: boolean
          readOnly: true
          description: Auto archive the route when all tasks in that route are archived
        feature_signature_required:
          type: boolean
        feature_signature_required_task_category:
          type: array
          items:
            $ref: '#/components/schemas/TaskCategoryEnum'
        feature_picture_required:
          type: boolean
        feature_picture_required_task_category:
          type: array
          items:
            $ref: '#/components/schemas/TaskCategoryEnum'
        feature_signer_name_required:
          type: boolean
        feature_signer_name_required_task_category:
          type: array
          items:
            $ref: '#/components/schemas/TaskCategoryEnum'
        feature_notes_required:
          type: boolean
        feature_allow_worker_reordering:
          type: boolean
          nullable: true
        pod_show_reference:
          type: boolean
        pod_show_description:
          type: boolean
        pod_show_task_events:
          type: boolean
        pod_show_task_event_creators:
          type: boolean
        pod_show_signatures:
          type: boolean
        pod_show_images:
          type: boolean
        feature_show_unassigned_capacity:
          type: boolean
          description: Show unassigned capacity.
        capacity_divisor:
          type: array
          items:
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          nullable: true
          description: Capacity divisors for calculations.
        capacity_units:
          type: array
          items:
            type: string
            maxLength: 100
          nullable: true
          description: Capacity unit names.
        auto_assign_orders:
          type: boolean
        auto_assign_max_tasks:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          nullable: true
          title: Maximum tasks per worker
          description: How many tasks can be auto assigned to a worker?
        auto_assign_max_distance:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          nullable: true
          title: Maximum distance from task
          description: How far can a task be auto assigned to a worker in meters?
        auto_assign_time_before:
          type: string
          nullable: true
        auto_assign_rotate:
          type: object
          nullable: true
          title: Rotate assignee
          description: Time after non-accepted task assignees will be rotated. Leave
            empty in case the orders should not be rotated
          default: 4 10:55:34.12
        auto_assign_optimize:
          type: boolean
          title: Optimize auto assignments
          description: Check the optimizer results before assignment?
        dashboard_task_template:
          type: string
          readOnly: true
        calendar_task_template:
          type: string
          readOnly: true
        tracker_task_popup_template:
          type: string
          readOnly: true
        dashboard_worker_limit:
          type: integer
          readOnly: true
        stripe_customer_id:
          type: string
          readOnly: true
          nullable: true
        stripe_payment_method_id:
          type: string
          readOnly: true
          nullable: true
          description: 'Reflects current default payment method. For reference only. '
        billing_method:
          allOf:
          - $ref: '#/components/schemas/AccountBillingMethodEnum'
          readOnly: true
        billing_name:
          type: string
          maxLength: 100
        billing_company:
          type: string
          maxLength: 100
        billing_address:
          type: string
          maxLength: 200
        billing_country:
          type: string
          maxLength: 100
        billing_email:
          type: string
          format: email
          title: Billing email address
          maxLength: 254
        billing_phone:
          type: string
          maxLength: 20
        billing_vatin:
          type: string
          maxLength: 20
    PatchedAccountRole:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        user:
          type: string
          format: uri
        state:
          allOf:
          - $ref: '#/components/schemas/StateD63Enum'
          readOnly: true
        email:
          type: string
          format: email
          readOnly: true
        display_name:
          type: string
          nullable: true
          maxLength: 100
        phone:
          type: string
          maxLength: 128
        require_sequential_completion:
          type: boolean
        vehicle_registration_number:
          type: string
          title: Vehicle registration
          maxLength: 32
        vehicle_profile:
          $ref: '#/components/schemas/VehicleProfileEnum'
        vehicle_capacity:
          type: array
          items:
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          nullable: true
        vehicle_capacity_divisor:
          type: array
          items:
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          nullable: true
        vehicle_capacity_units:
          type: array
          items:
            type: string
            maxLength: 100
          nullable: true
        show_vehicle_capacity:
          type: boolean
        vehicle_speed_factor:
          type: string
          format: decimal
          pattern: ^-?\d{0,1}(?:\.\d{0,1})?$
        vehicle_service_time_factor:
          type: string
          format: decimal
          pattern: ^-?\d{0,1}(?:\.\d{0,1})?$
        optimize_return_to_depot:
          type: boolean
        optimize_earliest_start:
          type: string
          format: time
          nullable: true
          description: 'Earliest start of vehicle '
        optimize_latest_end:
          type: string
          format: time
          nullable: true
          description: the time the vehicle needs to be at its end location at latest.
        route_start_address:
          allOf:
          - $ref: '#/components/schemas/NestedAddress'
          nullable: true
        route_end_address:
          allOf:
          - $ref: '#/components/schemas/NestedAddress'
          nullable: true
        signature_image:
          type: string
          format: uri
          readOnly: true
        is_admin:
          type: boolean
          title: Admin status
        is_manager:
          type: boolean
          title: Manager status
        is_worker:
          type: boolean
          title: Worker status
        is_integration:
          type: boolean
          title: Integration status
        is_active:
          type: boolean
          readOnly: true
        is_on_duty:
          type: boolean
          readOnly: true
        show_unassigned:
          type: boolean
          title: Show unassigned tasks
        show_travel_estimates:
          type: boolean
        last_time_location:
          type: string
          format: uri
          readOnly: true
        activated_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        deleted_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
    PatchedAuthenticatedUserUpdate:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        first_name:
          type: string
          maxLength: 30
        last_name:
          type: string
          maxLength: 30
        display_name:
          type: string
          readOnly: true
        email:
          type: string
          format: email
        phone:
          type: string
          maxLength: 128
        address:
          $ref: '#/components/schemas/NestedAddress'
    PatchedClient:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        name:
          type: string
          maxLength: 200
        slug:
          type: string
          readOnly: true
          pattern: ^[-a-zA-Z0-9_]+$
        archived:
          type: boolean
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        contact_addresses:
          type: array
          items:
            type: object
            additionalProperties: {}
          readOnly: true
    PatchedClientRole:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        client:
          type: string
          format: uri
        user:
          type: string
          format: uri
        phone:
          type: string
          maxLength: 128
        is_manager:
          type: boolean
          title: Manager status
        is_active:
          type: boolean
          title: Active
          description: Designates whether this Client Role should be treated as active.
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
    PatchedContactAddress:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        external_id:
          type: string
          nullable: true
          maxLength: 100
        account:
          type: string
          format: uri
        client:
          type: string
          format: uri
        contact:
          $ref: '#/components/schemas/NestedContact'
        address:
          $ref: '#/components/schemas/NestedAddress'
        is_orderer:
          type: boolean
        is_receiver:
          type: boolean
        source:
          type: string
          maxLength: 100
        metafields: {}
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
    PatchedDocumentUpdate:
      type: object
      description: |-
        Serializer for updating only the visibility fields of a document.

        - visible_to_client: Can be updated by any authenticated user with document access
        - visible_to_worker: Can only be updated by managers
      properties:
        visible_to_client:
          type: boolean
        visible_to_worker:
          type: boolean
    PatchedExport:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        export_model:
          $ref: '#/components/schemas/ExportModelEnum'
        field_names:
          type: array
          items:
            type: string
            maxLength: 100
          nullable: true
        format:
          $ref: '#/components/schemas/FormatEnum'
        link:
          type: string
          format: uri
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
    PatchedForm:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        name:
          type: string
          maxLength: 100
        description:
          type: string
        default_values:
          description: 'Default form field values as {slug: value}'
        created_by:
          type: string
          format: uri
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
    PatchedFormField:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        form:
          type: string
          format: uri
        field_type:
          $ref: '#/components/schemas/FieldTypeEnum'
        field_name:
          type: string
          maxLength: 100
        parent_field:
          type: string
          format: uri
          nullable: true
        slug:
          type: string
          maxLength: 100
          pattern: ^[-a-zA-Z0-9_]+$
        description:
          type: string
        read_only:
          type: boolean
        order:
          type: integer
          maximum: 2147483647
          minimum: 0
        choices:
          description: 'For single_select/multi_select: ["Choice A", "Choice B", ...]'
        can_add_rows:
          type: boolean
          description: Whether users can add rows to this array field.
        can_delete_rows:
          type: boolean
          description: Whether users can delete rows from this array field.
        collapsed:
          type: boolean
          nullable: true
          description: Whether this array field is collapsed by default in the form
            UI.
        layout:
          nullable: true
          description: |-
            Row layout for this array field: 'list' (fields stacked) or 'table' (compact, one line).

            * `list` - List
            * `table` - Table
          oneOf:
          - $ref: '#/components/schemas/LayoutEnum'
          - $ref: '#/components/schemas/NullEnum'
        visible_to_worker:
          type: boolean
          nullable: true
          description: Whether this field is shown to workers (drivers) in the product
            UI. The API still returns the field and its values; clients are responsible
            for hiding it.
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
    PatchedFormResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        form:
          type: string
          format: uri
        task:
          type: string
          format: uri
        answers:
          description: 'Form answers as {slug: value}'
        state:
          allOf:
          - $ref: '#/components/schemas/FormResponseStateEnum'
          readOnly: true
        form_schema:
          readOnly: true
          description: Snapshot of form + fields at time of completion
        completed_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        completed_by:
          type: string
          format: uri
          readOnly: true
        created_by:
          type: string
          format: uri
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
    PatchedFormRule:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        is_active:
          type: boolean
        name:
          type: string
          maxLength: 50
        edit_url:
          type: string
          format: uri
          maxLength: 2048
        view_url:
          type: string
          format: uri
          nullable: true
          maxLength: 2048
        pdf_url:
          type: string
          format: uri
          nullable: true
          maxLength: 2048
        rules: {}
        open_in:
          $ref: '#/components/schemas/OpenInEnum'
        form:
          type: string
          format: uri
          nullable: true
    PatchedInvoice:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          allOf:
          - $ref: '#/components/schemas/InvoiceAccount'
          readOnly: true
        billing_method:
          allOf:
          - $ref: '#/components/schemas/InvoiceBillingMethodEnum'
          readOnly: true
        state:
          allOf:
          - $ref: '#/components/schemas/InvoiceStateEnum'
          readOnly: true
        period:
          type: array
          items:
            type: string
            format: date
          readOnly: true
          nullable: true
          description: Indicates what period the price was calculated for
        total_no_vat:
          type: string
          format: decimal
          pattern: ^-?\d{0,7}(?:\.\d{0,2})?$
          readOnly: true
          nullable: true
        total_vat:
          type: string
          format: decimal
          pattern: ^-?\d{0,7}(?:\.\d{0,2})?$
          readOnly: true
        total_with_vat:
          type: string
          format: decimal
          pattern: ^-?\d{0,7}(?:\.\d{0,2})?$
          readOnly: true
        currency:
          type: string
          readOnly: true
        vat:
          type: boolean
          readOnly: true
        due_date:
          type: string
          format: date
          nullable: true
        paid_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        items:
          type: array
          items:
            $ref: '#/components/schemas/InvoiceItem'
          readOnly: true
        pricing:
          type: string
          format: uuid
          readOnly: true
        confirmed_by:
          type: string
          format: uri
          readOnly: true
        confirmed_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
    PatchedMetafield:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        ordering:
          type: integer
          maximum: 2147483647
          minimum: 0
        namespace:
          type: string
          default: gsmtasks
          pattern: ^[a-z0-9_]+$
          maxLength: 20
        key:
          type: string
          pattern: ^[a-z0-9_]+$
          maxLength: 20
        field_name:
          type: string
          readOnly: true
        value_type:
          $ref: '#/components/schemas/ValueTypeEnum'
        label:
          type: string
          maxLength: 40
        choices:
          type: array
          items:
            type: string
            maxLength: 100
          nullable: true
        choices_url:
          type: string
          format: uri
          nullable: true
          maxLength: 2048
        is_editable:
          type: boolean
          description: Editable by manager
        is_editable_assignee:
          type: boolean
          description: Editable by assignee
        is_editable_when_archived:
          type: boolean
          description: Editable when task is completed or cancelled
        is_required:
          type: boolean
        is_required_before_complete:
          type: boolean
          title: Required before complete
        is_persistent:
          type: boolean
          description: Metadata, that will be copied during recurrence.
        is_cloned:
          type: boolean
          description: Metadata, that will be copied during cloning.
        source:
          type: string
          format: uuid
          nullable: true
        is_searchable:
          type: boolean
        show_in_list_view:
          type: boolean
        show_in_detail_view:
          type: boolean
        show_in_mobile_app:
          type: boolean
        show_in_form:
          type: boolean
        show_in_pod:
          type: boolean
          title: Show in proof of delivery
        show_when_task_type_assignment:
          type: boolean
        show_when_task_type_pick_up:
          type: boolean
        show_when_task_type_drop_off:
          type: boolean
        hide_when_empty:
          type: boolean
        applies_to:
          allOf:
          - $ref: '#/components/schemas/AppliesToEnum'
          description: |-
            What model this metafield applies to

            * `tasks` - Tasks
            * `routes` - Routes
            * `contact_addresses` - Contact Addresses
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
    PatchedNotificationTemplate:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        name:
          type: string
          maxLength: 100
        event:
          oneOf:
          - $ref: '#/components/schemas/EventEnum'
          - $ref: '#/components/schemas/BlankEnum'
        state:
          oneOf:
          - $ref: '#/components/schemas/TaskStateEnum'
          - $ref: '#/components/schemas/BlankEnum'
        task_category:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/TaskCategoryEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        scheduled_time_added:
          type: boolean
        scheduled_time_change:
          type: boolean
        recipient:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/RecipientEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        emails:
          type: array
          items:
            type: string
            format: email
            maxLength: 254
        phones:
          type: array
          items:
            type: string
            maxLength: 128
        via_sms:
          type: boolean
        via_email:
          type: boolean
        via_app:
          type: boolean
        is_active:
          type: boolean
        message:
          type: string
        subject:
          type: string
          maxLength: 300
        email_reply_to:
          type: string
          format: email
          maxLength: 254
        pod_attach_to_email:
          type: boolean
        pod_show_images:
          type: boolean
        pod_show_signatures:
          type: boolean
        pod_show_task_events:
          type: boolean
        pod_show_task_event_creators:
          type: boolean
        pod_show_reference:
          type: boolean
          nullable: true
        pod_show_description:
          type: boolean
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
    PatchedOrderSerializerV2:
      type: object
      properties:
        id:
          type: string
          format: uuid
          nullable: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        external_id:
          type: string
          nullable: true
          maxLength: 100
        reference:
          type: string
          maxLength: 100
        client:
          type: string
          format: uri
          nullable: true
        orderer:
          $ref: '#/components/schemas/NestedContact'
        tasks:
          type: array
          items:
            type: string
            format: uri
        tasks_data:
          type: array
          items:
            $ref: '#/components/schemas/TaskSerializerV2'
          writeOnly: true
        documents:
          type: array
          items:
            type: string
            format: uri
          readOnly: true
        auto_assign:
          type: boolean
        description:
          type: string
        created_by:
          type: string
          format: uri
          readOnly: true
        recurrence:
          type: string
          format: uri
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
    PatchedRecurrence:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        external_id:
          type: string
          nullable: true
          maxLength: 100
        assignee:
          type: string
          format: uri
          nullable: true
        route:
          type: string
          format: uri
          nullable: true
        order_data:
          $ref: '#/components/schemas/OrderData'
        tasks_data: {}
        is_active:
          type: boolean
          default: true
        rrule:
          type: string
        reset_recurrence:
          type: boolean
          writeOnly: true
        timezone:
          $ref: '#/components/schemas/TimezoneEnum'
        last_recurred_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        last_scheduled_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        next_scheduled_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        created_by:
          type: string
          format: uri
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
    PatchedRoute:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        external_id:
          type: string
          nullable: true
          maxLength: 100
        account:
          type: string
          format: uri
        code:
          type: string
          maxLength: 100
        name:
          type: string
          maxLength: 100
        description:
          type: string
        assignee:
          type: string
          format: uri
          nullable: true
        start_time:
          type: string
          format: date-time
          nullable: true
        start_address:
          allOf:
          - $ref: '#/components/schemas/NestedAddress'
          nullable: true
        end_time:
          type: string
          format: date-time
          nullable: true
        end_address:
          allOf:
          - $ref: '#/components/schemas/NestedAddress'
          nullable: true
        state:
          allOf:
          - $ref: '#/components/schemas/State118Enum'
          readOnly: true
        objective:
          $ref: '#/components/schemas/ObjectiveEnum'
        metafields: {}
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
    PatchedTaskForm:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        task:
          type: string
          format: uri
        form:
          type: string
          format: uri
          readOnly: true
          nullable: true
        name:
          type: string
          maxLength: 50
        link:
          type: string
          format: uri
          readOnly: true
        edit_url:
          type: string
          format: uri
          maxLength: 2048
        view_url:
          type: string
          format: uri
          maxLength: 2048
        pdf_url:
          type: string
          format: uri
          maxLength: 2048
        open_in:
          allOf:
          - $ref: '#/components/schemas/OpenInEnum'
          readOnly: true
        completed:
          type: boolean
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
    PatchedTaskSerializerV2:
      type: object
      properties:
        id:
          type: string
          format: uuid
          nullable: true
        external_id:
          type: string
          nullable: true
          maxLength: 100
        reference:
          type: string
          maxLength: 100
        barcodes:
          type: array
          items:
            type: string
            maxLength: 128
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        state:
          allOf:
          - $ref: '#/components/schemas/TaskStateEnum'
          readOnly: true
        assignee:
          type: string
          format: uri
          nullable: true
        order:
          type: string
          format: uri
          nullable: true
        orderer:
          type: string
          format: uri
          writeOnly: true
          nullable: true
        orderer_name:
          type: string
          readOnly: true
        route:
          type: string
          format: uri
          nullable: true
        category:
          $ref: '#/components/schemas/TaskCategoryEnum'
        contact:
          $ref: '#/components/schemas/NestedContact'
        address:
          $ref: '#/components/schemas/NestedAddress'
        contact_address:
          type: string
          format: uri
          nullable: true
        contact_address_external_id:
          type: string
          nullable: true
        description:
          type: string
        calendar_time:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        complete_after:
          type: string
          format: date-time
          nullable: true
        complete_before:
          type: string
          format: date-time
          nullable: true
        scheduled_time:
          type: string
          format: date-time
          nullable: true
        completed_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        cancelled_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        auto_assign:
          type: boolean
        assignee_proximity:
          allOf:
          - $ref: '#/components/schemas/AssigneeProximityEnum'
          readOnly: true
        position:
          type: number
          format: double
          maximum: 253402300799.0
          minimum: 0.0
          nullable: true
        priority:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        duration:
          type: object
          nullable: true
          default: 4 10:55:34.12
        size:
          type: array
          items:
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          nullable: true
        forms:
          readOnly: true
        form_default_values:
          nullable: true
          description: 'Per-form default values: {form_id: {slug: value}}'
        documents:
          type: array
          items:
            type: string
            format: uri
        signatures:
          type: array
          items:
            type: string
            format: uri
        signers:
          type: array
          items:
            $ref: '#/components/schemas/NestedContact'
        metafields: {}
        trackers:
          type: array
          items:
            type: string
            format: uri
          readOnly: true
        recurrence:
          type: string
          format: uri
          readOnly: true
        issues:
          type: array
          items:
            type: string
            readOnly: true
          readOnly: true
        counts:
          type: object
          additionalProperties: {}
          readOnly: true
        actions:
          type: object
          additionalProperties: {}
          readOnly: true
        created_by:
          type: string
          format: uri
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
    PatchedTimeLocationFeature:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/GisFeatureEnum'
        id:
          type: string
          format: uuid
          readOnly: true
        geometry:
          type: object
          properties:
            type:
              type: string
              enum:
              - Point
            coordinates:
              type: array
              items:
                type: number
                format: float
              example:
              - 12.9721
              - 77.5933
              minItems: 2
              maxItems: 3
        properties:
          type: object
          properties:
            model:
              type: string
              readOnly: true
            source:
              type: string
              readOnly: true
              nullable: true
            user:
              type: string
              format: uri
              readOnly: true
            time:
              type: string
              format: date-time
            state:
              enum:
              - unknown
              - stopped
              - moving
              type: string
              description: |-
                * `unknown` - Unknown
                * `stopped` - Stopped
                * `moving` - Moving
            heading:
              type: integer
              maximum: 2147483647
              minimum: -2147483648
              nullable: true
            speed:
              type: integer
              maximum: 2147483647
              minimum: -2147483648
              nullable: true
            altitude:
              type: integer
              maximum: 2147483647
              minimum: -2147483648
              nullable: true
            accuracy:
              type: integer
              maximum: 2147483647
              minimum: -2147483648
              nullable: true
            battery_level:
              type: string
              format: decimal
              pattern: ^-?\d{0,1}(?:\.\d{0,3})?$
              nullable: true
            created_at:
              type: string
              format: date-time
              readOnly: true
            updated_at:
              type: string
              format: date-time
              readOnly: true
    PatchedTracker:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        tasks:
          type: array
          items:
            type: string
            format: uri
        active_from:
          type: string
          format: date-time
          nullable: true
        active_until:
          type: string
          format: date-time
          nullable: true
        queued_states:
          type: array
          items:
            $ref: '#/components/schemas/TaskStateEnum'
        active_states:
          type: array
          items:
            $ref: '#/components/schemas/TaskStateEnum'
        public_task_fields:
          type: array
          items:
            $ref: '#/components/schemas/PublicTaskFieldsEnum'
          description: Task fields returned under tasks[] on the public tracker endpoint
        show_driver_info:
          type: boolean
        show_destination:
          type: boolean
        show_eta:
          type: boolean
        show_sms_action:
          type: boolean
        show_call_action:
          type: boolean
        show_logo:
          type: boolean
        show_path:
          type: boolean
        show_predicted_delivery:
          type: boolean
        autozoom:
          type: boolean
        max_zoom_level:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          nullable: true
        tracking_page_url:
          type: string
          format: uri
          readOnly: true
        reviews_allowed:
          type: boolean
        reviewed_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        created_by:
          type: string
          format: uri
          readOnly: true
    PatchedWebhook:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        name:
          type: string
          maxLength: 100
        version:
          $ref: '#/components/schemas/VersionEnum'
        state:
          allOf:
          - $ref: '#/components/schemas/WebhookStateEnum'
          readOnly: true
        headers: {}
        target:
          type: string
          format: uri
          maxLength: 2048
        task_events:
          type: boolean
        task_event_types:
          type: array
          items:
            $ref: '#/components/schemas/TaskEventTypesEnum'
          description: Available task event types:<br>• create<br>• assign<br>• unassign<br>•
            reject<br>• restart<br>• accept<br>• unaccept<br>• transit<br>• activate<br>•
            complete<br>• fail<br>• cancel<br>• assignee_near<br>• assignee_away<br>•
            updated
        document_events:
          type: boolean
        signature_events:
          type: boolean
        review_events:
          type: boolean
        form_response_events:
          type: boolean
          nullable: true
        notification_emails:
          type: array
          items:
            type: string
            format: email
            maxLength: 254
        fail_message:
          type: string
          readOnly: true
        shared_secret:
          type: string
          maxLength: 40
        activated_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        failed_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
    PublicTaskFieldsEnum:
      enum:
      - id
      - url
      - reference
      - state
      - category
      - assignee
      - contact
      - address
      - duration
      - scheduled_time
      - completed_at
      - cancelled_at
      - failed_at
      type: string
      description: |-
        * `id` - id
        * `url` - url
        * `reference` - reference
        * `state` - state
        * `category` - category
        * `assignee` - assignee
        * `contact` - contact
        * `address` - address
        * `duration` - duration
        * `scheduled_time` - scheduled_time
        * `completed_at` - completed_at
        * `cancelled_at` - cancelled_at
        * `failed_at` - failed_at
    PushNotification:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        external_id:
          type: string
          format: uuid
          nullable: true
        state:
          allOf:
          - $ref: '#/components/schemas/PushNotificationStateEnum'
          readOnly: true
        notification:
          type: string
          format: uri
          readOnly: true
        recipient:
          type: string
          format: uri
          readOnly: true
        task:
          type: string
          format: uri
          readOnly: true
        event:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/EventEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        subject:
          type: string
        message:
          type: string
        error:
          type: string
          nullable: true
        pending_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        failed_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        sent_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - account
      - created_at
      - failed_at
      - id
      - message
      - notification
      - pending_at
      - recipient
      - sent_at
      - state
      - task
      - url
    PushNotificationStateEnum:
      enum:
      - queued
      - pending
      - failed
      - sent
      type: string
      description: |-
        * `queued` - Queued
        * `pending` - Pending
        * `failed` - Failed
        * `sent` - Sent
    ReadableUser:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        first_name:
          type: string
          maxLength: 30
        last_name:
          type: string
          maxLength: 30
        display_name:
          type: string
          readOnly: true
        email:
          type: string
          format: email
        phone:
          type: string
          maxLength: 128
        intercom_hash:
          type: string
          readOnly: true
        signature_image:
          type: string
          format: uri
        password_expires_at:
          type: string
          format: date-time
          nullable: true
          title: Password expired at
      required:
      - display_name
      - email
      - id
      - intercom_hash
      - url
    RecipientEnum:
      enum:
      - account
      - assignee
      - orderer
      - contact
      - client
      type: string
      description: |-
        * `account` - Account
        * `assignee` - Assignee
        * `orderer` - Orderer
        * `contact` - Contact
        * `client` - Client
    Recurrence:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        external_id:
          type: string
          nullable: true
          maxLength: 100
        assignee:
          type: string
          format: uri
          nullable: true
        route:
          type: string
          format: uri
          nullable: true
        order_data:
          $ref: '#/components/schemas/OrderData'
        tasks_data: {}
        is_active:
          type: boolean
          default: true
        rrule:
          type: string
        reset_recurrence:
          type: boolean
          writeOnly: true
        timezone:
          $ref: '#/components/schemas/TimezoneEnum'
        last_recurred_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        last_scheduled_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        next_scheduled_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        created_by:
          type: string
          format: uri
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - account
      - created_at
      - created_by
      - id
      - last_recurred_at
      - last_scheduled_at
      - next_scheduled_at
      - rrule
      - updated_at
      - url
    Registration:
      type: object
      properties:
        account:
          $ref: '#/components/schemas/RegistrationAccount'
        user:
          $ref: '#/components/schemas/RegistrationUser'
        client_id:
          type: string
          writeOnly: true
          minLength: 14
          maxLength: 40
        token:
          type: string
          readOnly: true
      required:
      - account
      - client_id
      - token
      - user
    RegistrationAccount:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        name:
          type: string
          maxLength: 100
        type:
          oneOf:
          - $ref: '#/components/schemas/AccountTypeEnum'
          - $ref: '#/components/schemas/BlankEnum'
        language:
          allOf:
          - $ref: '#/components/schemas/LanguageEnum'
          title: Prefered language
        timezone:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/TimezoneEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        country_code:
          oneOf:
          - $ref: '#/components/schemas/CountryCodeEnum'
          - $ref: '#/components/schemas/BlankEnum'
        website:
          type: string
          maxLength: 200
      required:
      - id
      - name
      - url
    RegistrationUser:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        name:
          type: string
          maxLength: 30
        email:
          type: string
          format: email
          maxLength: 254
        phone:
          type: string
          maxLength: 128
        password:
          type: string
          writeOnly: true
          maxLength: 100
          minLength: 6
      required:
      - email
      - id
      - name
      - password
      - url
    RenderRequest:
      type: object
      properties:
        task:
          type: string
          format: uri
      required:
      - task
    RenderResponse:
      type: object
      properties:
        task:
          type: string
          format: uri
        sender:
          type: string
          format: uri
          nullable: true
        user:
          type: string
          format: uri
          nullable: true
        event:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/EventEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        recipient:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/RecipientEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        emails:
          type: array
          items:
            type: string
            format: email
            maxLength: 254
        phones:
          type: array
          items:
            type: string
            maxLength: 128
        app:
          type: boolean
        message:
          type: string
      required:
      - task
    Review:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        account:
          type: string
          format: uri
          readOnly: true
        tracker:
          type: string
          format: uri
        rating:
          type: integer
          maximum: 5
          minimum: 1
        comment:
          type: string
        last_task:
          type: string
          format: uri
          readOnly: true
        last_assignee:
          type: string
          format: uri
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - account
      - created_at
      - id
      - last_assignee
      - last_task
      - rating
      - tracker
    Route:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        external_id:
          type: string
          nullable: true
          maxLength: 100
        account:
          type: string
          format: uri
        code:
          type: string
          maxLength: 100
        name:
          type: string
          maxLength: 100
        description:
          type: string
        assignee:
          type: string
          format: uri
          nullable: true
        start_time:
          type: string
          format: date-time
          nullable: true
        start_address:
          allOf:
          - $ref: '#/components/schemas/NestedAddress'
          nullable: true
        end_time:
          type: string
          format: date-time
          nullable: true
        end_address:
          allOf:
          - $ref: '#/components/schemas/NestedAddress'
          nullable: true
        state:
          allOf:
          - $ref: '#/components/schemas/State118Enum'
          readOnly: true
        objective:
          $ref: '#/components/schemas/ObjectiveEnum'
        metafields: {}
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - account
      - code
      - created_at
      - id
      - name
      - state
      - updated_at
      - url
    RouteArchive:
      type: object
      properties:
        task_action:
          allOf:
          - $ref: '#/components/schemas/TaskActionEnum'
          default: unlink
    RouteDefaultStateEnum:
      enum:
      - active
      - archived
      - draft
      type: string
      description: |-
        * `active` - Active
        * `archived` - Archived
        * `draft` - Draft
    RouteOptimizationResultRoute:
      type: object
      properties:
        assignee:
          type: string
        distance:
          type: integer
        completion_time:
          type: integer
        service_time:
          type: integer
        transport_time:
          type: integer
        waiting_time:
          type: integer
        tasks:
          type: array
          items:
            $ref: '#/components/schemas/RouteOptimizationResultTask'
      required:
      - assignee
      - completion_time
      - distance
      - service_time
      - tasks
      - transport_time
      - waiting_time
    RouteOptimizationResultSerializerV2:
      type: object
      properties:
        vehicles_count:
          type: integer
        unassigned_count:
          type: integer
        distance:
          type: integer
        completion_time:
          type: integer
        service_time:
          type: integer
        transport_time:
          type: integer
        waiting_time:
          type: integer
        routes:
          type: array
          items:
            $ref: '#/components/schemas/RouteOptimizationResultRoute'
        unoptimized:
          type: array
          items:
            $ref: '#/components/schemas/RouteOptimizationResultTask'
      required:
      - completion_time
      - distance
      - routes
      - service_time
      - transport_time
      - unassigned_count
      - unoptimized
      - vehicles_count
      - waiting_time
    RouteOptimizationResultTask:
      type: object
      properties:
        id:
          type: string
          format: uuid
        task:
          type: string
        reference:
          type: string
        type:
          type: string
        state:
          type: string
        assignee:
          type: string
        address:
          type: string
        location:
          $ref: '#/components/schemas/Location'
        arrival_time:
          type: string
          format: date-time
        actual_arrival_time:
          type: string
          format: date-time
        position:
          type: number
          format: double
          maximum: 253402300799.0
          minimum: 0.0
        departure_time:
          type: string
          format: date-time
        actual_departure_time:
          type: string
          format: date-time
        distance:
          type: integer
        actual_distance:
          type: integer
      required:
      - actual_arrival_time
      - actual_departure_time
      - actual_distance
      - address
      - arrival_time
      - assignee
      - departure_time
      - distance
      - id
      - location
      - position
      - reference
      - state
      - task
      - type
    RouteOptimizationSerializerV2:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        assignees:
          type: array
          items:
            type: string
            format: uri
        state:
          allOf:
          - $ref: '#/components/schemas/RouteOptimizationStateEnum'
          readOnly: true
        objective:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/ObjectiveEnum'
          - $ref: '#/components/schemas/NullEnum'
        tasks:
          type: array
          items:
            type: string
            format: uri
        start_time:
          type: string
          format: date-time
          nullable: true
        start_address:
          allOf:
          - $ref: '#/components/schemas/NestedAddress'
          nullable: true
        end_time:
          type: string
          format: date-time
          nullable: true
        end_address:
          allOf:
          - $ref: '#/components/schemas/NestedAddress'
          nullable: true
        unassign_not_optimal:
          type: boolean
        ignore_time_windows:
          type: boolean
        total_distance:
          type: integer
          readOnly: true
          nullable: true
        total_duration:
          type: object
          readOnly: true
          nullable: true
          default: 4 10:55:34.12
        commit:
          type: boolean
        created_by:
          type: string
          format: uri
        commited_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        scheduled_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        started_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        ready_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        completed_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        failed_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        errors:
          type: string
          format: json-pointer
          readOnly: true
      required:
      - account
      - assignees
      - commited_at
      - completed_at
      - created_at
      - errors
      - failed_at
      - id
      - ready_at
      - scheduled_at
      - started_at
      - state
      - tasks
      - total_distance
      - total_duration
      - updated_at
      - url
    RouteOptimizationStateEnum:
      enum:
      - pending
      - started
      - ready
      - completed
      - over_quota
      - failed
      type: string
      description: |-
        * `pending` - Pending
        * `started` - Started
        * `ready` - Ready
        * `completed` - Completed
        * `over_quota` - Over quota
        * `failed` - Failed
    S3FileUpload:
      type: object
      description: |-
        Saves either a file or file_url.
        in case S3 is used, it requires file name and file type and after save returns an upload url and saves the url.

        This serializer can not be used in other serializers if Amazon S3 upload is used.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        file:
          type: string
          format: uri
          readOnly: true
        file_name:
          type: string
          writeOnly: true
          maxLength: 100
        file_type:
          type: string
          writeOnly: true
          maxLength: 100
        s3_signature:
          nullable: true
          readOnly: true
        created_by:
          type: string
          format: uri
          readOnly: true
        source:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/S3FileUploadSourceEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - created_at
      - created_by
      - file
      - file_name
      - file_type
      - id
      - s3_signature
      - updated_at
      - url
    S3FileUploadSourceEnum:
      enum:
      - web
      - mobile
      - integration
      - tracker-logs
      type: string
      description: |-
        * `web` - Web
        * `mobile` - Mobile
        * `integration` - Integration
        * `tracker-logs` - Tracker logs
    SMS:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        external_id:
          type: string
          maxLength: 34
        state:
          allOf:
          - $ref: '#/components/schemas/EmailStateEnum'
          readOnly: true
        notification:
          type: string
          format: uri
          readOnly: true
        sender:
          type: string
          format: uri
          readOnly: true
        alphanumeric_sender_id:
          type: string
          maxLength: 20
        phone:
          type: string
          maxLength: 128
        message:
          type: string
          nullable: true
        segments_count:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        error:
          type: string
          nullable: true
        sent_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        failed_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        received_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - account
      - created_at
      - failed_at
      - id
      - notification
      - phone
      - received_at
      - sender
      - sent_at
      - state
      - url
    SessionToken:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        user:
          type: string
          format: uri
          readOnly: true
        ip_address:
          type: string
          readOnly: true
          nullable: true
        user_agent:
          type: string
          readOnly: true
        version:
          type: string
          readOnly: true
        last_used_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        last_issued_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        created_by:
          type: string
          format: uri
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        revoked_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
      required:
      - created_at
      - created_by
      - id
      - ip_address
      - last_issued_at
      - last_used_at
      - revoked_at
      - url
      - user
      - user_agent
      - version
    Signature:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        external_id:
          type: string
          nullable: true
          maxLength: 100
        task:
          type: string
          format: uri
        file_upload:
          type: string
          format: uri
          writeOnly: true
        file:
          type: string
          format: uri
          readOnly: true
        file_name:
          type: string
          readOnly: true
        mimetype:
          type: string
          readOnly: true
          nullable: true
        thumbnail:
          type: string
          format: uri
          readOnly: true
        signer:
          $ref: '#/components/schemas/NestedContact'
        documents:
          type: array
          items:
            type: string
            format: uri
        location:
          allOf:
          - $ref: '#/components/schemas/Location'
          nullable: true
        s3_response_headers:
          writeOnly: true
        created_by:
          type: string
          format: uri
          readOnly: true
        source:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/Source265Enum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - created_at
      - created_by
      - file
      - file_name
      - file_upload
      - id
      - mimetype
      - signer
      - task
      - thumbnail
      - updated_at
      - url
    SignatureDeleteAction:
      type: object
      properties:
        account:
          type: string
          format: uri
        signatures:
          type: array
          items:
            type: string
            format: uri
      required:
      - account
      - signatures
    SignatureTaskInline:
      type: object
      description: Signature serializer with inlined task data (API version >= 2.6.0)
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        external_id:
          type: string
          nullable: true
          maxLength: 100
        task:
          $ref: '#/components/schemas/TaskSerializerV2'
        file_upload:
          type: string
          format: uri
          writeOnly: true
        file:
          type: string
          format: uri
          readOnly: true
        file_name:
          type: string
          readOnly: true
        mimetype:
          type: string
          readOnly: true
          nullable: true
        thumbnail:
          type: string
          format: uri
          readOnly: true
        signer:
          $ref: '#/components/schemas/NestedContact'
        documents:
          type: array
          items:
            type: string
            format: uri
        location:
          allOf:
          - $ref: '#/components/schemas/Location'
          nullable: true
        s3_response_headers:
          writeOnly: true
        created_by:
          type: string
          format: uri
          readOnly: true
        source:
          enum:
          - web
          - mobile
          - integration
          - ''
          - null
          type: string
          description: |-
            * `web` - Web
            * `mobile` - Mobile
            * `integration` - Integration
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - created_at
      - created_by
      - file
      - file_name
      - file_upload
      - id
      - mimetype
      - signer
      - task
      - thumbnail
      - updated_at
      - url
    Source265Enum:
      enum:
      - web
      - mobile
      - integration
      type: string
      description: |-
        * `web` - Web
        * `mobile` - Mobile
        * `integration` - Integration
    State118Enum:
      enum:
      - active
      - archived
      - draft
      type: string
      description: |-
        * `active` - Active
        * `archived` - Archived
        * `draft` - Draft
    StateD63Enum:
      enum:
      - inactive
      - active
      - deleted
      type: string
      description: |-
        * `inactive` - Inactive
        * `active` - Active
        * `deleted` - Deleted
    StatusEnum:
      enum:
      - on_duty
      - off_duty
      type: string
      description: |-
        * `on_duty` - On duty
        * `off_duty` - Off duty
    StripePayment:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        billable_account:
          type: string
          format: uri
        invoice:
          type: string
          format: uri
          nullable: true
        state:
          $ref: '#/components/schemas/StripePaymentStateEnum'
        stripe_id:
          type: string
          nullable: true
          maxLength: 36
        stripe_state:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/StripeStateEnum'
          - $ref: '#/components/schemas/NullEnum'
        amount:
          type: string
          format: decimal
          pattern: ^-?\d{0,7}(?:\.\d{0,2})?$
        currency:
          type: string
          maxLength: 3
        timestamp:
          type: string
          format: date-time
          nullable: true
        response:
          type: string
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - amount
      - billable_account
      - created_at
      - id
      - invoice
      - updated_at
      - url
    StripePaymentStateEnum:
      enum:
      - draft
      - failed
      - saved
      - settled
      - rejected
      - retried
      - cancelled
      type: string
      description: |-
        * `draft` - Draft
        * `failed` - Failed to upload
        * `saved` - Saved
        * `settled` - Settled
        * `rejected` - Rejected
        * `retried` - Retried
        * `cancelled` - Cancelled
    StripeStateEnum:
      enum:
      - requires_payment_method
      - requires_confirmation
      - requires_capture
      - requires_action
      - processing
      - succeeded
      - canceled
      description: |-
        * `None` - Unknown
        * `requires_payment_method` - Requires payment method
        * `requires_confirmation` - Requires confirmation
        * `requires_capture` - requires capture
        * `requires_action` - requires action
        * `processing` - Processing
        * `succeeded` - Succeeded
        * `canceled` - Canceled
    Task:
      type: object
      properties:
        id:
          type: string
          format: uuid
          nullable: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        order:
          type: string
          format: uri
          nullable: true
        route:
          type: string
          format: uri
          nullable: true
        order_reference:
          type: string
          readOnly: true
        external_id:
          type: string
          nullable: true
          maxLength: 100
        category:
          $ref: '#/components/schemas/TaskCategoryEnum'
        orderer:
          type: string
          format: uri
          nullable: true
        orderer_name:
          type: string
          readOnly: true
        receiver:
          type: string
          format: uri
          nullable: true
        contact:
          $ref: '#/components/schemas/NestedContact'
        address:
          $ref: '#/components/schemas/NestedAddress'
        description:
          type: string
        reference:
          type: string
          maxLength: 100
        complete_after:
          type: string
          format: date-time
          nullable: true
        complete_before:
          type: string
          format: date-time
          nullable: true
        scheduled_time:
          type: string
          format: date-time
          nullable: true
        state:
          allOf:
          - $ref: '#/components/schemas/TaskStateEnum'
          readOnly: true
        completed_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        cancelled_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        assignee:
          type: string
          format: uri
          nullable: true
        auto_assign:
          type: boolean
        assignee_proximity:
          allOf:
          - $ref: '#/components/schemas/AssigneeProximityEnum'
          readOnly: true
        position:
          type: number
          format: double
          maximum: 253402300799.0
          minimum: 0.0
          nullable: true
        priority:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        duration:
          type: object
          nullable: true
          default: 4 10:55:34.12
        size:
          type: array
          items:
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          nullable: true
        is_full_load:
          type: boolean
        metafields: {}
        forms:
          readOnly: true
        signers:
          type: array
          items:
            $ref: '#/components/schemas/NestedContact'
        created_by:
          type: string
          format: uri
          readOnly: true
        issues:
          type: array
          items:
            type: string
            readOnly: true
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        events:
          type: string
          format: uri
          readOnly: true
        documents:
          type: string
          format: uri
          readOnly: true
        signatures:
          type: string
          format: uri
          readOnly: true
        actions:
          type: object
          additionalProperties: {}
          readOnly: true
        counts:
          type: object
          additionalProperties: {}
          readOnly: true
      required:
      - account
      - actions
      - address
      - assignee_proximity
      - cancelled_at
      - completed_at
      - counts
      - created_at
      - created_by
      - documents
      - events
      - forms
      - issues
      - order_reference
      - orderer_name
      - signatures
      - state
      - updated_at
      - url
    TaskAccountChange:
      type: object
      properties:
        account:
          type: string
          format: uri
      required:
      - account
    TaskAction:
      type: object
      properties:
        notes:
          type: string
        location:
          allOf:
          - $ref: '#/components/schemas/Location'
          nullable: true
    TaskActionEnum:
      enum:
      - unassign
      - unlink
      - complete
      - cancel
      type: string
      description: |-
        * `unassign` - Unassign
        * `unlink` - Unlink
        * `complete` - Complete
        * `cancel` - Cancel
    TaskAddressFeature:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/GisFeatureEnum'
        id:
          type: string
          format: uuid
          readOnly: true
        geometry:
          type: object
          properties:
            type:
              type: string
              enum:
              - Point
            coordinates:
              type: array
              items:
                type: number
                format: float
              example:
              - 12.9721
              - 77.5933
              minItems: 2
              maxItems: 3
        properties:
          type: object
          properties:
            model:
              type: string
              readOnly: true
            task:
              type: string
              format: uri
              readOnly: true
            formatted_address:
              type: string
              readOnly: true
            category:
              enum:
              - assignment
              - pick_up
              - drop_off
              - warehouse
              type: string
              description: |-
                * `assignment` - Assignment
                * `pick_up` - Pick-Up
                * `drop_off` - Drop-Off
                * `warehouse` - Warehouse
            state:
              enum:
              - draft
              - scheduled
              - unassigned
              - assigned
              - accepted
              - transit
              - active
              - completed
              - failed
              - cancelled
              type: string
              description: |-
                * `draft` - Draft
                * `scheduled` - Scheduled
                * `unassigned` - Unassigned
                * `assigned` - Assigned
                * `accepted` - Accepted
                * `transit` - Transit
                * `active` - Active
                * `completed` - Completed
                * `failed` - Failed
                * `cancelled` - Cancelled
    TaskAddressFeatureList:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/GisFeatureCollectionEnum'
        features:
          type: array
          items:
            $ref: '#/components/schemas/TaskAddressFeature'
    TaskAssign:
      type: object
      properties:
        notes:
          type: string
        location:
          allOf:
          - $ref: '#/components/schemas/Location'
          nullable: true
        assignee:
          type: string
          format: uri
      required:
      - assignee
    TaskCategoryEnum:
      enum:
      - assignment
      - pick_up
      - drop_off
      - warehouse
      type: string
      description: |-
        * `assignment` - Assignment
        * `pick_up` - Pick-Up
        * `drop_off` - Drop-Off
        * `warehouse` - Warehouse
    TaskCommand:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
          readOnly: true
        task:
          type: string
          format: uri
        external_id:
          type: string
          nullable: true
          maxLength: 100
        time:
          type: string
          format: date-time
        action:
          $ref: '#/components/schemas/ActionEnum'
        user:
          type: string
          format: uri
          readOnly: true
        notes:
          type: string
          description: Task command notes
        location:
          allOf:
          - $ref: '#/components/schemas/Location'
          nullable: true
        assignee:
          type: string
          format: uri
          nullable: true
        state:
          $ref: '#/components/schemas/TaskCommandStateEnum'
        error_message:
          type: string
        task_data:
          $ref: '#/components/schemas/TaskCommandTaskData'
        accepted_at:
          type: string
          format: date-time
          nullable: true
        rejected_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - account
      - action
      - created_at
      - id
      - task
      - time
      - updated_at
      - url
      - user
    TaskCommandStateEnum:
      enum:
      - pending
      - accepted
      - rejected
      type: string
      description: |-
        * `pending` - Pending
        * `accepted` - Accepted
        * `rejected` - Rejected
    TaskCommandTaskData:
      type: object
      properties:
        scheduled_time:
          type: string
          format: date-time
        position:
          type: number
          format: double
          maximum: 253402300799.0
          minimum: 0.0
        metafields:
          type: object
          additionalProperties: {}
        address:
          $ref: '#/components/schemas/NestedAddress'
        contact_address:
          $ref: '#/components/schemas/NestedContactAddress'
        route:
          type: string
          format: uri
          nullable: true
        duration:
          type: object
          default: 4 10:55:34.12
    TaskEvent:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        task:
          type: string
          format: uri
        task_command:
          type: string
          format: uri
          readOnly: true
        field:
          readOnly: true
          oneOf:
          - $ref: '#/components/schemas/FieldEnum'
          - $ref: '#/components/schemas/BlankEnum'
        event:
          allOf:
          - $ref: '#/components/schemas/EventEnum'
          readOnly: true
        from_state:
          allOf:
          - $ref: '#/components/schemas/TaskEventTransitionStatesEnum'
          readOnly: true
        to_state:
          allOf:
          - $ref: '#/components/schemas/TaskEventTransitionStatesEnum'
          readOnly: true
        user:
          type: string
          format: uri
          readOnly: true
        notes:
          type: string
          description: Event notes
        location:
          allOf:
          - $ref: '#/components/schemas/Location'
          nullable: true
        assignee:
          type: string
          format: uri
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - account
      - assignee
      - created_at
      - event
      - field
      - from_state
      - id
      - task
      - task_command
      - to_state
      - updated_at
      - url
      - user
    TaskEventSerializerV2:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        task:
          $ref: '#/components/schemas/TaskEventTask'
        task_command:
          type: string
          format: uri
          readOnly: true
        field:
          readOnly: true
          oneOf:
          - $ref: '#/components/schemas/FieldEnum'
          - $ref: '#/components/schemas/BlankEnum'
        event:
          allOf:
          - $ref: '#/components/schemas/EventEnum'
          readOnly: true
        from_state:
          allOf:
          - $ref: '#/components/schemas/TaskEventTransitionStatesEnum'
          readOnly: true
        to_state:
          allOf:
          - $ref: '#/components/schemas/TaskEventTransitionStatesEnum'
          readOnly: true
        user:
          type: string
          format: uri
          readOnly: true
        notes:
          type: string
          description: Event notes
        location:
          allOf:
          - $ref: '#/components/schemas/Location'
          nullable: true
        assignee:
          type: string
          format: uri
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - account
      - assignee
      - created_at
      - event
      - field
      - from_state
      - id
      - task
      - task_command
      - to_state
      - updated_at
      - url
      - user
    TaskEventTask:
      type: object
      properties:
        id:
          type: string
          format: uuid
          nullable: true
        external_id:
          type: string
          nullable: true
          maxLength: 100
        reference:
          type: string
          maxLength: 100
        barcodes:
          type: array
          items:
            type: string
            maxLength: 128
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        state:
          allOf:
          - $ref: '#/components/schemas/TaskStateEnum'
          readOnly: true
        assignee:
          type: string
          format: uri
          nullable: true
        order:
          type: string
          format: uri
          nullable: true
        orderer:
          type: string
          format: uri
          writeOnly: true
          nullable: true
        orderer_name:
          type: string
          readOnly: true
        route:
          type: string
          format: uri
          nullable: true
        category:
          $ref: '#/components/schemas/TaskCategoryEnum'
        contact:
          $ref: '#/components/schemas/NestedContact'
        address:
          $ref: '#/components/schemas/NestedAddress'
        contact_address:
          type: string
          format: uri
          nullable: true
        contact_address_external_id:
          type: string
          nullable: true
          readOnly: true
        description:
          type: string
        calendar_time:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        complete_after:
          type: string
          format: date-time
          nullable: true
        complete_before:
          type: string
          format: date-time
          nullable: true
        scheduled_time:
          type: string
          format: date-time
          nullable: true
        completed_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        cancelled_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        auto_assign:
          type: boolean
        assignee_proximity:
          allOf:
          - $ref: '#/components/schemas/AssigneeProximityEnum'
          readOnly: true
        position:
          type: number
          format: double
          maximum: 253402300799.0
          minimum: 0.0
          nullable: true
        priority:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        duration:
          type: object
          nullable: true
          default: 4 10:55:34.12
        size:
          type: array
          items:
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          nullable: true
        forms:
          readOnly: true
        form_default_values:
          nullable: true
          description: 'Per-form default values: {form_id: {slug: value}}'
        documents:
          type: array
          items:
            type: string
            format: uri
        signatures:
          type: array
          items:
            type: string
            format: uri
        signers:
          type: array
          items:
            $ref: '#/components/schemas/NestedContact'
        metafields: {}
        trackers:
          type: array
          items:
            type: string
            format: uri
          readOnly: true
        recurrence:
          type: string
          format: uri
          readOnly: true
        issues:
          type: array
          items:
            type: string
            readOnly: true
          readOnly: true
        counts:
          type: object
          additionalProperties: {}
          readOnly: true
        actions:
          type: object
          additionalProperties: {}
          readOnly: true
        created_by:
          type: string
          format: uri
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - account
      - actions
      - assignee_proximity
      - calendar_time
      - cancelled_at
      - completed_at
      - contact_address_external_id
      - counts
      - created_at
      - created_by
      - forms
      - issues
      - orderer_name
      - recurrence
      - state
      - trackers
      - updated_at
      - url
    TaskEventTrack:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/GisFeatureEnum'
        id:
          type: string
          format: uuid
          readOnly: true
        geometry: {}
        properties:
          type: object
          properties:
            model:
              type: string
              readOnly: true
            url:
              type: string
              format: uri
              readOnly: true
            task:
              type: string
              format: uuid
              readOnly: true
            task_event:
              type: string
              format: uri
              readOnly: true
            event:
              enum:
              - create
              - assign
              - unassign
              - reject
              - restart
              - accept
              - unaccept
              - transit
              - activate
              - complete
              - fail
              - cancel
              - assignee_near
              - assignee_away
              - updated
              type: string
              description: |-
                * `create` - Create
                * `assign` - Assign
                * `unassign` - Unassign
                * `reject` - Reject
                * `restart` - Restart
                * `accept` - Accept
                * `unaccept` - Unaccept
                * `transit` - Transit
                * `activate` - Activate
                * `complete` - Complete
                * `fail` - Fail
                * `cancel` - Cancel
                * `assignee_near` - Assignee near
                * `assignee_away` - Assignee away
                * `updated` - Updated
              readOnly: true
            from_state:
              enum:
              - draft
              - scheduled
              - unassigned
              - assigned
              - accepted
              - transit
              - active
              - completed
              - failed
              - cancelled
              - away
              - near
              type: string
              description: |-
                * `draft` - Draft
                * `scheduled` - Scheduled
                * `unassigned` - Unassigned
                * `assigned` - Assigned
                * `accepted` - Accepted
                * `transit` - Transit
                * `active` - Active
                * `completed` - Completed
                * `failed` - Failed
                * `cancelled` - Cancelled
                * `away` - Away
                * `near` - Near
              readOnly: true
            to_state:
              enum:
              - draft
              - scheduled
              - unassigned
              - assigned
              - accepted
              - transit
              - active
              - completed
              - failed
              - cancelled
              - away
              - near
              type: string
              description: |-
                * `draft` - Draft
                * `scheduled` - Scheduled
                * `unassigned` - Unassigned
                * `assigned` - Assigned
                * `accepted` - Accepted
                * `transit` - Transit
                * `active` - Active
                * `completed` - Completed
                * `failed` - Failed
                * `cancelled` - Cancelled
                * `away` - Away
                * `near` - Near
              readOnly: true
            user:
              type: string
              format: uuid
              readOnly: true
              nullable: true
            notes:
              type: string
              description: Event notes
            assignee:
              type: string
              format: uuid
              nullable: true
            created_at:
              type: string
              format: date-time
              readOnly: true
            updated_at:
              type: string
              format: date-time
              readOnly: true
    TaskEventTrackList:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/GisFeatureCollectionEnum'
        features:
          type: array
          items:
            $ref: '#/components/schemas/TaskEventTrack'
    TaskEventTransitionStatesEnum:
      enum:
      - draft
      - scheduled
      - unassigned
      - assigned
      - accepted
      - transit
      - active
      - completed
      - failed
      - cancelled
      - away
      - near
      type: string
      description: |-
        * `draft` - Draft
        * `scheduled` - Scheduled
        * `unassigned` - Unassigned
        * `assigned` - Assigned
        * `accepted` - Accepted
        * `transit` - Transit
        * `active` - Active
        * `completed` - Completed
        * `failed` - Failed
        * `cancelled` - Cancelled
        * `away` - Away
        * `near` - Near
    TaskEventTypesEnum:
      enum:
      - create
      - assign
      - unassign
      - reject
      - restart
      - accept
      - unaccept
      - transit
      - activate
      - complete
      - fail
      - cancel
      - assignee_near
      - assignee_away
      - updated
      type: string
      description: |-
        * `create` - Create
        * `assign` - Assign
        * `unassign` - Unassign
        * `reject` - Reject
        * `restart` - Restart
        * `accept` - Accept
        * `unaccept` - Unaccept
        * `transit` - Transit
        * `activate` - Activate
        * `complete` - Complete
        * `fail` - Fail
        * `cancel` - Cancel
        * `assignee_near` - Assignee near
        * `assignee_away` - Assignee away
        * `updated` - Updated
    TaskExpiryStateEnum:
      enum:
      - cancelled
      - completed
      type: string
      description: |-
        * `cancelled` - Cancelled
        * `completed` - Completed
    TaskExport:
      type: object
      properties:
        id:
          type: string
          format: uuid
          nullable: true
        external_id:
          type: string
          nullable: true
          maxLength: 100
        category:
          $ref: '#/components/schemas/TaskCategoryEnum'
        description:
          type: string
        reference:
          type: string
          maxLength: 100
        complete_after:
          type: string
          format: date-time
          nullable: true
        complete_before:
          type: string
          format: date-time
          nullable: true
        scheduled_time:
          type: string
          format: date-time
          nullable: true
        state:
          type: string
        position:
          type: number
          format: double
          maximum: 253402300799.0
          minimum: 0.0
          nullable: true
        priority:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        duration:
          type: object
          nullable: true
          default: 4 10:55:34.12
        is_full_load:
          type: boolean
        assignee_proximity:
          $ref: '#/components/schemas/AssigneeProximityEnum'
        auto_assign:
          type: boolean
        issues:
          type: array
          items:
            type: string
            default: ''
        forms:
          readOnly: true
        signers:
          type: array
          items:
            $ref: '#/components/schemas/NestedContact'
        size:
          type: array
          items:
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          nullable: true
        completed_at:
          type: string
          format: date-time
          nullable: true
        cancelled_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        contact_address_external_id:
          type: string
          nullable: true
          readOnly: true
        account__name:
          type: string
        order__id:
          type: string
          default: ''
        order__external_id:
          type: string
          default: ''
        order__reference:
          type: string
          default: ''
        order__auto_assign:
          type: string
          default: ''
        order__description:
          type: string
          default: ''
        order__created_by:
          type: string
          default: ''
        order__created_at:
          type: string
          format: date-time
          default: null
        order__orderer__name:
          type: string
          default: ''
        order__orderer__company:
          type: string
          default: ''
        order__orderer__emails:
          type: array
          items:
            type: string
            default: ''
        order__orderer__phones:
          type: array
          items:
            type: string
            default: ''
        order__orderer__notes:
          type: string
          default: ''
        orderer__name:
          type: string
          default: ''
        contact__name:
          type: string
          default: ''
        contact__company:
          type: string
          default: ''
        contact__emails:
          type: array
          items:
            type: string
            default: ''
        contact__phones:
          type: array
          items:
            type: string
            default: ''
        contact__notes:
          type: string
          default: ''
        assignee__display_name:
          type: string
          readOnly: true
        assignee__email:
          type: string
          format: email
          default: ''
        assignee__phone:
          type: string
          default: ''
        assignee__password_expires_at:
          type: string
          format: date-time
          default: null
        address__raw_address:
          type: string
          default: ''
        address__formatted_address:
          type: string
          default: ''
        address__location:
          $ref: '#/components/schemas/Location'
        address__google_place_id:
          type: string
          default: ''
        address__point_of_interest:
          type: string
          default: ''
        address__street:
          type: string
          default: ''
        address__house_number:
          type: string
          default: ''
        address__apartment_number:
          type: string
          default: ''
        address__city:
          type: string
          default: ''
        address__state:
          type: string
          default: ''
        address__postal_code:
          type: string
          default: ''
        address__country:
          type: string
          default: ''
        address__country_code:
          type: string
          default: ''
        address__geocoding_provider:
          type: string
          default: ''
        address__geocoded_at:
          type: string
          format: date-time
          default: null
        address__geocode_failed_at:
          type: string
          format: date-time
          default: null
        route__external_id:
          type: string
          default: ''
        route__code:
          type: string
          default: ''
        route__name:
          type: string
          default: ''
        route__description:
          type: string
          default: ''
        route__start_time:
          type: string
          format: date-time
          default: null
        route__end_time:
          type: string
          format: date-time
          default: null
        created_by__display_name:
          type: string
          readOnly: true
        created_by__email:
          type: string
          format: email
          default: ''
        created_by__phone:
          type: string
          default: ''
        metadata__events_count:
          type: integer
        metadata__documents_count:
          type: integer
        metadata__signatures_count:
          type: integer
        metadata__forms_count:
          type: integer
        metadata__forms_completed_count:
          type: integer
        metadata__task_event_notes_count:
          type: integer
          default: 0
        metadata__last_task_event_notes:
          type: string
          default: ''
        metadata__unassigned_duration:
          type: object
          default: 4 10:55:34.12
        metadata__assigned_duration:
          type: object
          default: 4 10:55:34.12
        metadata__accepted_duration:
          type: object
          default: 4 10:55:34.12
        metadata__transit_duration:
          type: object
          default: 4 10:55:34.12
        metadata__active_duration:
          type: object
          default: 4 10:55:34.12
        metadata__completed_duration:
          type: object
          default: 4 10:55:34.12
        metadata__failed_duration:
          type: object
          default: 4 10:55:34.12
        metadata__cancelled_duration:
          type: object
          default: 4 10:55:34.12
        metadata__unassigned_distance:
          type: integer
        metadata__assigned_distance:
          type: integer
        metadata__accepted_distance:
          type: integer
        metadata__transit_distance:
          type: integer
        metadata__active_distance:
          type: integer
        metadata__completed_distance:
          type: integer
        metadata__failed_distance:
          type: integer
        metadata__cancelled_distance:
          type: integer
        metadata__last_unassigned_at:
          type: string
          format: date-time
          default: null
        metadata__last_assigned_at:
          type: string
          format: date-time
          default: null
        metadata__last_accepted_at:
          type: string
          format: date-time
          default: null
        metadata__last_transit_at:
          type: string
          format: date-time
          default: null
        metadata__last_active_at:
          type: string
          format: date-time
          default: null
        metadata__last_completed_at:
          type: string
          format: date-time
          default: null
        metadata__last_failed_at:
          type: string
          format: date-time
          default: null
        metadata__last_cancelled_at:
          type: string
          format: date-time
          default: null
        metadata__last_assignee_near_at:
          type: string
          format: date-time
          default: null
        metadata__last_assignee_away_at:
          type: string
          format: date-time
          default: null
      required:
      - account__name
      - address__location
      - assignee__display_name
      - contact_address_external_id
      - created_at
      - created_by__display_name
      - forms
      - metadata__accepted_distance
      - metadata__accepted_duration
      - metadata__active_distance
      - metadata__active_duration
      - metadata__assigned_distance
      - metadata__assigned_duration
      - metadata__cancelled_distance
      - metadata__cancelled_duration
      - metadata__completed_distance
      - metadata__completed_duration
      - metadata__documents_count
      - metadata__events_count
      - metadata__failed_distance
      - metadata__failed_duration
      - metadata__forms_completed_count
      - metadata__forms_count
      - metadata__signatures_count
      - metadata__transit_distance
      - metadata__transit_duration
      - metadata__unassigned_distance
      - metadata__unassigned_duration
      - state
      - updated_at
    TaskForm:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        task:
          type: string
          format: uri
        form:
          type: string
          format: uri
          readOnly: true
          nullable: true
        name:
          type: string
          maxLength: 50
        link:
          type: string
          format: uri
          readOnly: true
        edit_url:
          type: string
          format: uri
          maxLength: 2048
        view_url:
          type: string
          format: uri
          maxLength: 2048
        pdf_url:
          type: string
          format: uri
          maxLength: 2048
        open_in:
          allOf:
          - $ref: '#/components/schemas/OpenInEnum'
          readOnly: true
        completed:
          type: boolean
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - created_at
      - edit_url
      - form
      - id
      - link
      - name
      - open_in
      - task
      - updated_at
      - url
    TaskListReorderRequest:
      type: object
      properties:
        account:
          type: string
          format: uri
        assignee:
          type: string
          format: uri
          nullable: true
        assign_tasks:
          type: array
          items:
            type: string
            format: uri
        reorder_tasks:
          type: array
          items:
            type: string
            format: uri
      required:
      - account
      - assign_tasks
      - assignee
      - reorder_tasks
    TaskListReorderResponseTask:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        state:
          $ref: '#/components/schemas/TaskStateEnum'
        position:
          type: number
          format: double
          maximum: 253402300799.0
          minimum: 0.0
          nullable: true
        assignee:
          type: string
          format: uri
          readOnly: true
      required:
      - assignee
      - id
      - url
    TaskMetadata:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        task:
          type: string
          format: uri
        events_count:
          type: integer
          maximum: 32767
          minimum: 0
          nullable: true
        task_event_notes_count:
          type: integer
          maximum: 32767
          minimum: 0
          nullable: true
        documents_count:
          type: integer
          maximum: 32767
          minimum: 0
          nullable: true
        signatures_count:
          type: integer
          maximum: 32767
          minimum: 0
          nullable: true
        forms_count:
          type: integer
          maximum: 32767
          minimum: 0
          nullable: true
        forms_completed_count:
          type: integer
          maximum: 32767
          minimum: 0
          nullable: true
        last_task_event_notes:
          type: string
        unassigned_duration:
          type: object
          nullable: true
          default: 4 10:55:34.12
        assigned_duration:
          type: object
          nullable: true
          default: 4 10:55:34.12
        accepted_duration:
          type: object
          nullable: true
          default: 4 10:55:34.12
        transit_duration:
          type: object
          nullable: true
          default: 4 10:55:34.12
        active_duration:
          type: object
          nullable: true
          default: 4 10:55:34.12
        completed_duration:
          type: object
          nullable: true
          default: 4 10:55:34.12
        failed_duration:
          type: object
          nullable: true
          default: 4 10:55:34.12
        cancelled_duration:
          type: object
          nullable: true
          default: 4 10:55:34.12
        unassigned_distance:
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
        assigned_distance:
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
        accepted_distance:
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
        transit_distance:
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
        active_distance:
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
        completed_distance:
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
        failed_distance:
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
        cancelled_distance:
          type: integer
          maximum: 2147483647
          minimum: 0
          nullable: true
        last_unassigned_at:
          type: string
          format: date-time
          nullable: true
        last_assigned_at:
          type: string
          format: date-time
          nullable: true
        last_accepted_at:
          type: string
          format: date-time
          nullable: true
        last_transit_at:
          type: string
          format: date-time
          nullable: true
        last_active_at:
          type: string
          format: date-time
          nullable: true
        last_completed_at:
          type: string
          format: date-time
          nullable: true
        last_failed_at:
          type: string
          format: date-time
          nullable: true
        last_cancelled_at:
          type: string
          format: date-time
          nullable: true
        last_assignee_near_at:
          type: string
          format: date-time
          nullable: true
        last_assignee_away_at:
          type: string
          format: date-time
          nullable: true
      required:
      - id
      - task
      - url
    TaskSerializerV2:
      type: object
      properties:
        id:
          type: string
          format: uuid
          nullable: true
        external_id:
          type: string
          nullable: true
          maxLength: 100
        reference:
          type: string
          maxLength: 100
        barcodes:
          type: array
          items:
            type: string
            maxLength: 128
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        state:
          allOf:
          - $ref: '#/components/schemas/TaskStateEnum'
          readOnly: true
        assignee:
          type: string
          format: uri
          nullable: true
        order:
          type: string
          format: uri
          nullable: true
        orderer:
          type: string
          format: uri
          writeOnly: true
          nullable: true
        orderer_name:
          type: string
          readOnly: true
        route:
          type: string
          format: uri
          nullable: true
        category:
          $ref: '#/components/schemas/TaskCategoryEnum'
        contact:
          $ref: '#/components/schemas/NestedContact'
        address:
          $ref: '#/components/schemas/NestedAddress'
        contact_address:
          type: string
          format: uri
          nullable: true
        contact_address_external_id:
          type: string
          nullable: true
        description:
          type: string
        calendar_time:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        complete_after:
          type: string
          format: date-time
          nullable: true
        complete_before:
          type: string
          format: date-time
          nullable: true
        scheduled_time:
          type: string
          format: date-time
          nullable: true
        completed_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        cancelled_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        auto_assign:
          type: boolean
        assignee_proximity:
          allOf:
          - $ref: '#/components/schemas/AssigneeProximityEnum'
          readOnly: true
        position:
          type: number
          format: double
          maximum: 253402300799.0
          minimum: 0.0
          nullable: true
        priority:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        duration:
          type: object
          nullable: true
          default: 4 10:55:34.12
        size:
          type: array
          items:
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          nullable: true
        forms:
          readOnly: true
        form_default_values:
          nullable: true
          description: 'Per-form default values: {form_id: {slug: value}}'
        documents:
          type: array
          items:
            type: string
            format: uri
        signatures:
          type: array
          items:
            type: string
            format: uri
        signers:
          type: array
          items:
            $ref: '#/components/schemas/NestedContact'
        metafields: {}
        trackers:
          type: array
          items:
            type: string
            format: uri
          readOnly: true
        recurrence:
          type: string
          format: uri
          readOnly: true
        issues:
          type: array
          items:
            type: string
            readOnly: true
          readOnly: true
        counts:
          type: object
          additionalProperties: {}
          readOnly: true
        actions:
          type: object
          additionalProperties: {}
          readOnly: true
        created_by:
          type: string
          format: uri
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - account
      - actions
      - assignee_proximity
      - calendar_time
      - cancelled_at
      - completed_at
      - counts
      - created_at
      - created_by
      - forms
      - issues
      - orderer_name
      - recurrence
      - state
      - trackers
      - updated_at
      - url
    TaskStateEnum:
      enum:
      - draft
      - scheduled
      - unassigned
      - assigned
      - accepted
      - transit
      - active
      - completed
      - failed
      - cancelled
      type: string
      description: |-
        * `draft` - Draft
        * `scheduled` - Scheduled
        * `unassigned` - Unassigned
        * `assigned` - Assigned
        * `accepted` - Accepted
        * `transit` - Transit
        * `active` - Active
        * `completed` - Completed
        * `failed` - Failed
        * `cancelled` - Cancelled
    TasksBackgroundImport:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        mapping:
          type: string
          format: uri
          nullable: true
        created_by:
          type: string
          format: uri
          readOnly: true
        tasks_data:
          type: array
          items:
            type: object
            additionalProperties: {}
          writeOnly: true
        state:
          allOf:
          - $ref: '#/components/schemas/TasksBackgroundImportStateEnum'
          readOnly: true
        started_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        completed_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        failed_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        errors: {}
        celery_task_id:
          type: string
          nullable: true
          maxLength: 50
        tasks_created:
          type: array
          items:
            type: string
            format: uri
          readOnly: true
        assignees:
          type: array
          items:
            type: string
            format: uri
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - account
      - assignees
      - completed_at
      - created_at
      - created_by
      - failed_at
      - id
      - started_at
      - state
      - tasks_created
      - tasks_data
      - updated_at
      - url
    TasksBackgroundImportStateEnum:
      enum:
      - pending
      - started
      - completed
      - failed
      type: string
      description: |-
        * `pending` - Pending
        * `started` - Started
        * `completed` - Completed
        * `failed` - Failed
    TasksStatesCount:
      type: object
      properties:
        scheduled:
          type: integer
          readOnly: true
          default: 0
        unassigned:
          type: integer
          readOnly: true
          default: 0
        assigned:
          type: integer
          readOnly: true
          default: 0
        accepted:
          type: integer
          readOnly: true
          default: 0
        transit:
          type: integer
          readOnly: true
          default: 0
        active:
          type: integer
          readOnly: true
          default: 0
        completed:
          type: integer
          readOnly: true
          default: 0
        failed:
          type: integer
          readOnly: true
          default: 0
        cancelled:
          type: integer
          readOnly: true
          default: 0
      required:
      - accepted
      - active
      - assigned
      - cancelled
      - completed
      - failed
      - scheduled
      - transit
      - unassigned
    TasksStatesCountResponse:
      type: object
      properties:
        dates:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/TasksStatesCount'
          readOnly: true
      required:
      - dates
    TimeFormatEnum:
      enum:
      - HH:mm
      - h:mm A
      type: string
      description: |-
        * `HH:mm` - HH:mm (24 hour
        * `h:mm A` - h:mm A (12 hour)
    TimeLocation:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        source:
          type: string
          readOnly: true
          nullable: true
        user:
          type: string
          format: uri
          readOnly: true
        time:
          type: string
          format: date-time
        location:
          $ref: '#/components/schemas/Location'
        is_moving:
          type: boolean
          nullable: true
        event:
          type: string
          nullable: true
          maxLength: 20
        activity_type:
          type: string
          nullable: true
          maxLength: 20
        state:
          $ref: '#/components/schemas/TimeLocationStateEnum'
        heading:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          nullable: true
        speed:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          nullable: true
        altitude:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          nullable: true
        accuracy:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          nullable: true
        battery_level:
          type: string
          format: decimal
          pattern: ^-?\d{0,1}(?:\.\d{0,3})?$
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - created_at
      - id
      - location
      - source
      - time
      - updated_at
      - url
      - user
    TimeLocationFeature:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/GisFeatureEnum'
        id:
          type: string
          format: uuid
          readOnly: true
        geometry:
          type: object
          properties:
            type:
              type: string
              enum:
              - Point
            coordinates:
              type: array
              items:
                type: number
                format: float
              example:
              - 12.9721
              - 77.5933
              minItems: 2
              maxItems: 3
        properties:
          type: object
          properties:
            model:
              type: string
              readOnly: true
            source:
              type: string
              readOnly: true
              nullable: true
            user:
              type: string
              format: uri
              readOnly: true
            time:
              type: string
              format: date-time
            state:
              enum:
              - unknown
              - stopped
              - moving
              type: string
              description: |-
                * `unknown` - Unknown
                * `stopped` - Stopped
                * `moving` - Moving
            heading:
              type: integer
              maximum: 2147483647
              minimum: -2147483648
              nullable: true
            speed:
              type: integer
              maximum: 2147483647
              minimum: -2147483648
              nullable: true
            altitude:
              type: integer
              maximum: 2147483647
              minimum: -2147483648
              nullable: true
            accuracy:
              type: integer
              maximum: 2147483647
              minimum: -2147483648
              nullable: true
            battery_level:
              type: string
              format: decimal
              pattern: ^-?\d{0,1}(?:\.\d{0,3})?$
              nullable: true
            created_at:
              type: string
              format: date-time
              readOnly: true
            updated_at:
              type: string
              format: date-time
              readOnly: true
    TimeLocationFeatureList:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/GisFeatureCollectionEnum'
        features:
          type: array
          items:
            $ref: '#/components/schemas/TimeLocationFeature'
    TimeLocationStateEnum:
      enum:
      - unknown
      - stopped
      - moving
      type: string
      description: |-
        * `unknown` - Unknown
        * `stopped` - Stopped
        * `moving` - Moving
    TimezoneEnum:
      enum:
      - Africa/Abidjan
      - Africa/Accra
      - Africa/Addis_Ababa
      - Africa/Algiers
      - Africa/Asmara
      - Africa/Asmera
      - Africa/Bamako
      - Africa/Bangui
      - Africa/Banjul
      - Africa/Bissau
      - Africa/Blantyre
      - Africa/Brazzaville
      - Africa/Bujumbura
      - Africa/Cairo
      - Africa/Casablanca
      - Africa/Ceuta
      - Africa/Conakry
      - Africa/Dakar
      - Africa/Dar_es_Salaam
      - Africa/Djibouti
      - Africa/Douala
      - Africa/El_Aaiun
      - Africa/Freetown
      - Africa/Gaborone
      - Africa/Harare
      - Africa/Johannesburg
      - Africa/Juba
      - Africa/Kampala
      - Africa/Khartoum
      - Africa/Kigali
      - Africa/Kinshasa
      - Africa/Lagos
      - Africa/Libreville
      - Africa/Lome
      - Africa/Luanda
      - Africa/Lubumbashi
      - Africa/Lusaka
      - Africa/Malabo
      - Africa/Maputo
      - Africa/Maseru
      - Africa/Mbabane
      - Africa/Mogadishu
      - Africa/Monrovia
      - Africa/Nairobi
      - Africa/Ndjamena
      - Africa/Niamey
      - Africa/Nouakchott
      - Africa/Ouagadougou
      - Africa/Porto-Novo
      - Africa/Sao_Tome
      - Africa/Timbuktu
      - Africa/Tripoli
      - Africa/Tunis
      - Africa/Windhoek
      - America/Adak
      - America/Anchorage
      - America/Anguilla
      - America/Antigua
      - America/Araguaina
      - America/Argentina/Buenos_Aires
      - America/Argentina/Catamarca
      - America/Argentina/ComodRivadavia
      - America/Argentina/Cordoba
      - America/Argentina/Jujuy
      - America/Argentina/La_Rioja
      - America/Argentina/Mendoza
      - America/Argentina/Rio_Gallegos
      - America/Argentina/Salta
      - America/Argentina/San_Juan
      - America/Argentina/San_Luis
      - America/Argentina/Tucuman
      - America/Argentina/Ushuaia
      - America/Aruba
      - America/Asuncion
      - America/Atikokan
      - America/Atka
      - America/Bahia
      - America/Bahia_Banderas
      - America/Barbados
      - America/Belem
      - America/Belize
      - America/Blanc-Sablon
      - America/Boa_Vista
      - America/Bogota
      - America/Boise
      - America/Buenos_Aires
      - America/Cambridge_Bay
      - America/Campo_Grande
      - America/Cancun
      - America/Caracas
      - America/Catamarca
      - America/Cayenne
      - America/Cayman
      - America/Chicago
      - America/Chihuahua
      - America/Ciudad_Juarez
      - America/Coral_Harbour
      - America/Cordoba
      - America/Costa_Rica
      - America/Coyhaique
      - America/Creston
      - America/Cuiaba
      - America/Curacao
      - America/Danmarkshavn
      - America/Dawson
      - America/Dawson_Creek
      - America/Denver
      - America/Detroit
      - America/Dominica
      - America/Edmonton
      - America/Eirunepe
      - America/El_Salvador
      - America/Ensenada
      - America/Fort_Nelson
      - America/Fort_Wayne
      - America/Fortaleza
      - America/Glace_Bay
      - America/Godthab
      - America/Goose_Bay
      - America/Grand_Turk
      - America/Grenada
      - America/Guadeloupe
      - America/Guatemala
      - America/Guayaquil
      - America/Guyana
      - America/Halifax
      - America/Havana
      - America/Hermosillo
      - America/Indiana/Indianapolis
      - America/Indiana/Knox
      - America/Indiana/Marengo
      - America/Indiana/Petersburg
      - America/Indiana/Tell_City
      - America/Indiana/Vevay
      - America/Indiana/Vincennes
      - America/Indiana/Winamac
      - America/Indianapolis
      - America/Inuvik
      - America/Iqaluit
      - America/Jamaica
      - America/Jujuy
      - America/Juneau
      - America/Kentucky/Louisville
      - America/Kentucky/Monticello
      - America/Knox_IN
      - America/Kralendijk
      - America/La_Paz
      - America/Lima
      - America/Los_Angeles
      - America/Louisville
      - America/Lower_Princes
      - America/Maceio
      - America/Managua
      - America/Manaus
      - America/Marigot
      - America/Martinique
      - America/Matamoros
      - America/Mazatlan
      - America/Mendoza
      - America/Menominee
      - America/Merida
      - America/Metlakatla
      - America/Mexico_City
      - America/Miquelon
      - America/Moncton
      - America/Monterrey
      - America/Montevideo
      - America/Montreal
      - America/Montserrat
      - America/Nassau
      - America/New_York
      - America/Nipigon
      - America/Nome
      - America/Noronha
      - America/North_Dakota/Beulah
      - America/North_Dakota/Center
      - America/North_Dakota/New_Salem
      - America/Nuuk
      - America/Ojinaga
      - America/Panama
      - America/Pangnirtung
      - America/Paramaribo
      - America/Phoenix
      - America/Port-au-Prince
      - America/Port_of_Spain
      - America/Porto_Acre
      - America/Porto_Velho
      - America/Puerto_Rico
      - America/Punta_Arenas
      - America/Rainy_River
      - America/Rankin_Inlet
      - America/Recife
      - America/Regina
      - America/Resolute
      - America/Rio_Branco
      - America/Rosario
      - America/Santa_Isabel
      - America/Santarem
      - America/Santiago
      - America/Santo_Domingo
      - America/Sao_Paulo
      - America/Scoresbysund
      - America/Shiprock
      - America/Sitka
      - America/St_Barthelemy
      - America/St_Johns
      - America/St_Kitts
      - America/St_Lucia
      - America/St_Thomas
      - America/St_Vincent
      - America/Swift_Current
      - America/Tegucigalpa
      - America/Thule
      - America/Thunder_Bay
      - America/Tijuana
      - America/Toronto
      - America/Tortola
      - America/Vancouver
      - America/Virgin
      - America/Whitehorse
      - America/Winnipeg
      - America/Yakutat
      - America/Yellowknife
      - Antarctica/Casey
      - Antarctica/Davis
      - Antarctica/DumontDUrville
      - Antarctica/Macquarie
      - Antarctica/Mawson
      - Antarctica/McMurdo
      - Antarctica/Palmer
      - Antarctica/Rothera
      - Antarctica/South_Pole
      - Antarctica/Syowa
      - Antarctica/Troll
      - Antarctica/Vostok
      - Arctic/Longyearbyen
      - Asia/Aden
      - Asia/Almaty
      - Asia/Amman
      - Asia/Anadyr
      - Asia/Aqtau
      - Asia/Aqtobe
      - Asia/Ashgabat
      - Asia/Ashkhabad
      - Asia/Atyrau
      - Asia/Baghdad
      - Asia/Bahrain
      - Asia/Baku
      - Asia/Bangkok
      - Asia/Barnaul
      - Asia/Beirut
      - Asia/Bishkek
      - Asia/Brunei
      - Asia/Calcutta
      - Asia/Chita
      - Asia/Choibalsan
      - Asia/Chongqing
      - Asia/Chungking
      - Asia/Colombo
      - Asia/Dacca
      - Asia/Damascus
      - Asia/Dhaka
      - Asia/Dili
      - Asia/Dubai
      - Asia/Dushanbe
      - Asia/Famagusta
      - Asia/Gaza
      - Asia/Harbin
      - Asia/Hebron
      - Asia/Ho_Chi_Minh
      - Asia/Hong_Kong
      - Asia/Hovd
      - Asia/Irkutsk
      - Asia/Istanbul
      - Asia/Jakarta
      - Asia/Jayapura
      - Asia/Jerusalem
      - Asia/Kabul
      - Asia/Kamchatka
      - Asia/Karachi
      - Asia/Kashgar
      - Asia/Kathmandu
      - Asia/Katmandu
      - Asia/Khandyga
      - Asia/Kolkata
      - Asia/Krasnoyarsk
      - Asia/Kuala_Lumpur
      - Asia/Kuching
      - Asia/Kuwait
      - Asia/Macao
      - Asia/Macau
      - Asia/Magadan
      - Asia/Makassar
      - Asia/Manila
      - Asia/Muscat
      - Asia/Nicosia
      - Asia/Novokuznetsk
      - Asia/Novosibirsk
      - Asia/Omsk
      - Asia/Oral
      - Asia/Phnom_Penh
      - Asia/Pontianak
      - Asia/Pyongyang
      - Asia/Qatar
      - Asia/Qostanay
      - Asia/Qyzylorda
      - Asia/Rangoon
      - Asia/Riyadh
      - Asia/Saigon
      - Asia/Sakhalin
      - Asia/Samarkand
      - Asia/Seoul
      - Asia/Shanghai
      - Asia/Singapore
      - Asia/Srednekolymsk
      - Asia/Taipei
      - Asia/Tashkent
      - Asia/Tbilisi
      - Asia/Tehran
      - Asia/Tel_Aviv
      - Asia/Thimbu
      - Asia/Thimphu
      - Asia/Tokyo
      - Asia/Tomsk
      - Asia/Ujung_Pandang
      - Asia/Ulaanbaatar
      - Asia/Ulan_Bator
      - Asia/Urumqi
      - Asia/Ust-Nera
      - Asia/Vientiane
      - Asia/Vladivostok
      - Asia/Yakutsk
      - Asia/Yangon
      - Asia/Yekaterinburg
      - Asia/Yerevan
      - Atlantic/Azores
      - Atlantic/Bermuda
      - Atlantic/Canary
      - Atlantic/Cape_Verde
      - Atlantic/Faeroe
      - Atlantic/Faroe
      - Atlantic/Jan_Mayen
      - Atlantic/Madeira
      - Atlantic/Reykjavik
      - Atlantic/South_Georgia
      - Atlantic/St_Helena
      - Atlantic/Stanley
      - Australia/ACT
      - Australia/Adelaide
      - Australia/Brisbane
      - Australia/Broken_Hill
      - Australia/Canberra
      - Australia/Currie
      - Australia/Darwin
      - Australia/Eucla
      - Australia/Hobart
      - Australia/LHI
      - Australia/Lindeman
      - Australia/Lord_Howe
      - Australia/Melbourne
      - Australia/NSW
      - Australia/North
      - Australia/Perth
      - Australia/Queensland
      - Australia/South
      - Australia/Sydney
      - Australia/Tasmania
      - Australia/Victoria
      - Australia/West
      - Australia/Yancowinna
      - Brazil/Acre
      - Brazil/DeNoronha
      - Brazil/East
      - Brazil/West
      - CET
      - CST6CDT
      - Canada/Atlantic
      - Canada/Central
      - Canada/Eastern
      - Canada/Mountain
      - Canada/Newfoundland
      - Canada/Pacific
      - Canada/Saskatchewan
      - Canada/Yukon
      - Chile/Continental
      - Chile/EasterIsland
      - Cuba
      - EET
      - EST
      - EST5EDT
      - Egypt
      - Eire
      - Etc/GMT
      - Etc/GMT+0
      - Etc/GMT+1
      - Etc/GMT+10
      - Etc/GMT+11
      - Etc/GMT+12
      - Etc/GMT+2
      - Etc/GMT+3
      - Etc/GMT+4
      - Etc/GMT+5
      - Etc/GMT+6
      - Etc/GMT+7
      - Etc/GMT+8
      - Etc/GMT+9
      - Etc/GMT-0
      - Etc/GMT-1
      - Etc/GMT-10
      - Etc/GMT-11
      - Etc/GMT-12
      - Etc/GMT-13
      - Etc/GMT-14
      - Etc/GMT-2
      - Etc/GMT-3
      - Etc/GMT-4
      - Etc/GMT-5
      - Etc/GMT-6
      - Etc/GMT-7
      - Etc/GMT-8
      - Etc/GMT-9
      - Etc/GMT0
      - Etc/Greenwich
      - Etc/UCT
      - Etc/UTC
      - Etc/Universal
      - Etc/Zulu
      - Europe/Amsterdam
      - Europe/Andorra
      - Europe/Astrakhan
      - Europe/Athens
      - Europe/Belfast
      - Europe/Belgrade
      - Europe/Berlin
      - Europe/Bratislava
      - Europe/Brussels
      - Europe/Bucharest
      - Europe/Budapest
      - Europe/Busingen
      - Europe/Chisinau
      - Europe/Copenhagen
      - Europe/Dublin
      - Europe/Gibraltar
      - Europe/Guernsey
      - Europe/Helsinki
      - Europe/Isle_of_Man
      - Europe/Istanbul
      - Europe/Jersey
      - Europe/Kaliningrad
      - Europe/Kiev
      - Europe/Kirov
      - Europe/Kyiv
      - Europe/Lisbon
      - Europe/Ljubljana
      - Europe/London
      - Europe/Luxembourg
      - Europe/Madrid
      - Europe/Malta
      - Europe/Mariehamn
      - Europe/Minsk
      - Europe/Monaco
      - Europe/Moscow
      - Europe/Nicosia
      - Europe/Oslo
      - Europe/Paris
      - Europe/Podgorica
      - Europe/Prague
      - Europe/Riga
      - Europe/Rome
      - Europe/Samara
      - Europe/San_Marino
      - Europe/Sarajevo
      - Europe/Saratov
      - Europe/Simferopol
      - Europe/Skopje
      - Europe/Sofia
      - Europe/Stockholm
      - Europe/Tallinn
      - Europe/Tirane
      - Europe/Tiraspol
      - Europe/Ulyanovsk
      - Europe/Uzhgorod
      - Europe/Vaduz
      - Europe/Vatican
      - Europe/Vienna
      - Europe/Vilnius
      - Europe/Volgograd
      - Europe/Warsaw
      - Europe/Zagreb
      - Europe/Zaporozhye
      - Europe/Zurich
      - Factory
      - GB
      - GB-Eire
      - GMT
      - GMT+0
      - GMT-0
      - GMT0
      - Greenwich
      - HST
      - Hongkong
      - Iceland
      - Indian/Antananarivo
      - Indian/Chagos
      - Indian/Christmas
      - Indian/Cocos
      - Indian/Comoro
      - Indian/Kerguelen
      - Indian/Mahe
      - Indian/Maldives
      - Indian/Mauritius
      - Indian/Mayotte
      - Indian/Reunion
      - Iran
      - Israel
      - Jamaica
      - Japan
      - Kwajalein
      - Libya
      - MET
      - MST
      - MST7MDT
      - Mexico/BajaNorte
      - Mexico/BajaSur
      - Mexico/General
      - NZ
      - NZ-CHAT
      - Navajo
      - PRC
      - PST8PDT
      - Pacific/Apia
      - Pacific/Auckland
      - Pacific/Bougainville
      - Pacific/Chatham
      - Pacific/Chuuk
      - Pacific/Easter
      - Pacific/Efate
      - Pacific/Enderbury
      - Pacific/Fakaofo
      - Pacific/Fiji
      - Pacific/Funafuti
      - Pacific/Galapagos
      - Pacific/Gambier
      - Pacific/Guadalcanal
      - Pacific/Guam
      - Pacific/Honolulu
      - Pacific/Johnston
      - Pacific/Kanton
      - Pacific/Kiritimati
      - Pacific/Kosrae
      - Pacific/Kwajalein
      - Pacific/Majuro
      - Pacific/Marquesas
      - Pacific/Midway
      - Pacific/Nauru
      - Pacific/Niue
      - Pacific/Norfolk
      - Pacific/Noumea
      - Pacific/Pago_Pago
      - Pacific/Palau
      - Pacific/Pitcairn
      - Pacific/Pohnpei
      - Pacific/Ponape
      - Pacific/Port_Moresby
      - Pacific/Rarotonga
      - Pacific/Saipan
      - Pacific/Samoa
      - Pacific/Tahiti
      - Pacific/Tarawa
      - Pacific/Tongatapu
      - Pacific/Truk
      - Pacific/Wake
      - Pacific/Wallis
      - Pacific/Yap
      - Poland
      - Portugal
      - ROC
      - ROK
      - Singapore
      - Turkey
      - UCT
      - US/Alaska
      - US/Aleutian
      - US/Arizona
      - US/Central
      - US/East-Indiana
      - US/Eastern
      - US/Hawaii
      - US/Indiana-Starke
      - US/Michigan
      - US/Mountain
      - US/Pacific
      - US/Samoa
      - UTC
      - Universal
      - W-SU
      - WET
      - Zulu
      - localtime
      type: string
      description: |-
        * `Africa/Abidjan` - Africa/Abidjan
        * `Africa/Accra` - Africa/Accra
        * `Africa/Addis_Ababa` - Africa/Addis_Ababa
        * `Africa/Algiers` - Africa/Algiers
        * `Africa/Asmara` - Africa/Asmara
        * `Africa/Asmera` - Africa/Asmera
        * `Africa/Bamako` - Africa/Bamako
        * `Africa/Bangui` - Africa/Bangui
        * `Africa/Banjul` - Africa/Banjul
        * `Africa/Bissau` - Africa/Bissau
        * `Africa/Blantyre` - Africa/Blantyre
        * `Africa/Brazzaville` - Africa/Brazzaville
        * `Africa/Bujumbura` - Africa/Bujumbura
        * `Africa/Cairo` - Africa/Cairo
        * `Africa/Casablanca` - Africa/Casablanca
        * `Africa/Ceuta` - Africa/Ceuta
        * `Africa/Conakry` - Africa/Conakry
        * `Africa/Dakar` - Africa/Dakar
        * `Africa/Dar_es_Salaam` - Africa/Dar_es_Salaam
        * `Africa/Djibouti` - Africa/Djibouti
        * `Africa/Douala` - Africa/Douala
        * `Africa/El_Aaiun` - Africa/El_Aaiun
        * `Africa/Freetown` - Africa/Freetown
        * `Africa/Gaborone` - Africa/Gaborone
        * `Africa/Harare` - Africa/Harare
        * `Africa/Johannesburg` - Africa/Johannesburg
        * `Africa/Juba` - Africa/Juba
        * `Africa/Kampala` - Africa/Kampala
        * `Africa/Khartoum` - Africa/Khartoum
        * `Africa/Kigali` - Africa/Kigali
        * `Africa/Kinshasa` - Africa/Kinshasa
        * `Africa/Lagos` - Africa/Lagos
        * `Africa/Libreville` - Africa/Libreville
        * `Africa/Lome` - Africa/Lome
        * `Africa/Luanda` - Africa/Luanda
        * `Africa/Lubumbashi` - Africa/Lubumbashi
        * `Africa/Lusaka` - Africa/Lusaka
        * `Africa/Malabo` - Africa/Malabo
        * `Africa/Maputo` - Africa/Maputo
        * `Africa/Maseru` - Africa/Maseru
        * `Africa/Mbabane` - Africa/Mbabane
        * `Africa/Mogadishu` - Africa/Mogadishu
        * `Africa/Monrovia` - Africa/Monrovia
        * `Africa/Nairobi` - Africa/Nairobi
        * `Africa/Ndjamena` - Africa/Ndjamena
        * `Africa/Niamey` - Africa/Niamey
        * `Africa/Nouakchott` - Africa/Nouakchott
        * `Africa/Ouagadougou` - Africa/Ouagadougou
        * `Africa/Porto-Novo` - Africa/Porto-Novo
        * `Africa/Sao_Tome` - Africa/Sao_Tome
        * `Africa/Timbuktu` - Africa/Timbuktu
        * `Africa/Tripoli` - Africa/Tripoli
        * `Africa/Tunis` - Africa/Tunis
        * `Africa/Windhoek` - Africa/Windhoek
        * `America/Adak` - America/Adak
        * `America/Anchorage` - America/Anchorage
        * `America/Anguilla` - America/Anguilla
        * `America/Antigua` - America/Antigua
        * `America/Araguaina` - America/Araguaina
        * `America/Argentina/Buenos_Aires` - America/Argentina/Buenos_Aires
        * `America/Argentina/Catamarca` - America/Argentina/Catamarca
        * `America/Argentina/ComodRivadavia` - America/Argentina/ComodRivadavia
        * `America/Argentina/Cordoba` - America/Argentina/Cordoba
        * `America/Argentina/Jujuy` - America/Argentina/Jujuy
        * `America/Argentina/La_Rioja` - America/Argentina/La_Rioja
        * `America/Argentina/Mendoza` - America/Argentina/Mendoza
        * `America/Argentina/Rio_Gallegos` - America/Argentina/Rio_Gallegos
        * `America/Argentina/Salta` - America/Argentina/Salta
        * `America/Argentina/San_Juan` - America/Argentina/San_Juan
        * `America/Argentina/San_Luis` - America/Argentina/San_Luis
        * `America/Argentina/Tucuman` - America/Argentina/Tucuman
        * `America/Argentina/Ushuaia` - America/Argentina/Ushuaia
        * `America/Aruba` - America/Aruba
        * `America/Asuncion` - America/Asuncion
        * `America/Atikokan` - America/Atikokan
        * `America/Atka` - America/Atka
        * `America/Bahia` - America/Bahia
        * `America/Bahia_Banderas` - America/Bahia_Banderas
        * `America/Barbados` - America/Barbados
        * `America/Belem` - America/Belem
        * `America/Belize` - America/Belize
        * `America/Blanc-Sablon` - America/Blanc-Sablon
        * `America/Boa_Vista` - America/Boa_Vista
        * `America/Bogota` - America/Bogota
        * `America/Boise` - America/Boise
        * `America/Buenos_Aires` - America/Buenos_Aires
        * `America/Cambridge_Bay` - America/Cambridge_Bay
        * `America/Campo_Grande` - America/Campo_Grande
        * `America/Cancun` - America/Cancun
        * `America/Caracas` - America/Caracas
        * `America/Catamarca` - America/Catamarca
        * `America/Cayenne` - America/Cayenne
        * `America/Cayman` - America/Cayman
        * `America/Chicago` - America/Chicago
        * `America/Chihuahua` - America/Chihuahua
        * `America/Ciudad_Juarez` - America/Ciudad_Juarez
        * `America/Coral_Harbour` - America/Coral_Harbour
        * `America/Cordoba` - America/Cordoba
        * `America/Costa_Rica` - America/Costa_Rica
        * `America/Coyhaique` - America/Coyhaique
        * `America/Creston` - America/Creston
        * `America/Cuiaba` - America/Cuiaba
        * `America/Curacao` - America/Curacao
        * `America/Danmarkshavn` - America/Danmarkshavn
        * `America/Dawson` - America/Dawson
        * `America/Dawson_Creek` - America/Dawson_Creek
        * `America/Denver` - America/Denver
        * `America/Detroit` - America/Detroit
        * `America/Dominica` - America/Dominica
        * `America/Edmonton` - America/Edmonton
        * `America/Eirunepe` - America/Eirunepe
        * `America/El_Salvador` - America/El_Salvador
        * `America/Ensenada` - America/Ensenada
        * `America/Fort_Nelson` - America/Fort_Nelson
        * `America/Fort_Wayne` - America/Fort_Wayne
        * `America/Fortaleza` - America/Fortaleza
        * `America/Glace_Bay` - America/Glace_Bay
        * `America/Godthab` - America/Godthab
        * `America/Goose_Bay` - America/Goose_Bay
        * `America/Grand_Turk` - America/Grand_Turk
        * `America/Grenada` - America/Grenada
        * `America/Guadeloupe` - America/Guadeloupe
        * `America/Guatemala` - America/Guatemala
        * `America/Guayaquil` - America/Guayaquil
        * `America/Guyana` - America/Guyana
        * `America/Halifax` - America/Halifax
        * `America/Havana` - America/Havana
        * `America/Hermosillo` - America/Hermosillo
        * `America/Indiana/Indianapolis` - America/Indiana/Indianapolis
        * `America/Indiana/Knox` - America/Indiana/Knox
        * `America/Indiana/Marengo` - America/Indiana/Marengo
        * `America/Indiana/Petersburg` - America/Indiana/Petersburg
        * `America/Indiana/Tell_City` - America/Indiana/Tell_City
        * `America/Indiana/Vevay` - America/Indiana/Vevay
        * `America/Indiana/Vincennes` - America/Indiana/Vincennes
        * `America/Indiana/Winamac` - America/Indiana/Winamac
        * `America/Indianapolis` - America/Indianapolis
        * `America/Inuvik` - America/Inuvik
        * `America/Iqaluit` - America/Iqaluit
        * `America/Jamaica` - America/Jamaica
        * `America/Jujuy` - America/Jujuy
        * `America/Juneau` - America/Juneau
        * `America/Kentucky/Louisville` - America/Kentucky/Louisville
        * `America/Kentucky/Monticello` - America/Kentucky/Monticello
        * `America/Knox_IN` - America/Knox_IN
        * `America/Kralendijk` - America/Kralendijk
        * `America/La_Paz` - America/La_Paz
        * `America/Lima` - America/Lima
        * `America/Los_Angeles` - America/Los_Angeles
        * `America/Louisville` - America/Louisville
        * `America/Lower_Princes` - America/Lower_Princes
        * `America/Maceio` - America/Maceio
        * `America/Managua` - America/Managua
        * `America/Manaus` - America/Manaus
        * `America/Marigot` - America/Marigot
        * `America/Martinique` - America/Martinique
        * `America/Matamoros` - America/Matamoros
        * `America/Mazatlan` - America/Mazatlan
        * `America/Mendoza` - America/Mendoza
        * `America/Menominee` - America/Menominee
        * `America/Merida` - America/Merida
        * `America/Metlakatla` - America/Metlakatla
        * `America/Mexico_City` - America/Mexico_City
        * `America/Miquelon` - America/Miquelon
        * `America/Moncton` - America/Moncton
        * `America/Monterrey` - America/Monterrey
        * `America/Montevideo` - America/Montevideo
        * `America/Montreal` - America/Montreal
        * `America/Montserrat` - America/Montserrat
        * `America/Nassau` - America/Nassau
        * `America/New_York` - America/New_York
        * `America/Nipigon` - America/Nipigon
        * `America/Nome` - America/Nome
        * `America/Noronha` - America/Noronha
        * `America/North_Dakota/Beulah` - America/North_Dakota/Beulah
        * `America/North_Dakota/Center` - America/North_Dakota/Center
        * `America/North_Dakota/New_Salem` - America/North_Dakota/New_Salem
        * `America/Nuuk` - America/Nuuk
        * `America/Ojinaga` - America/Ojinaga
        * `America/Panama` - America/Panama
        * `America/Pangnirtung` - America/Pangnirtung
        * `America/Paramaribo` - America/Paramaribo
        * `America/Phoenix` - America/Phoenix
        * `America/Port-au-Prince` - America/Port-au-Prince
        * `America/Port_of_Spain` - America/Port_of_Spain
        * `America/Porto_Acre` - America/Porto_Acre
        * `America/Porto_Velho` - America/Porto_Velho
        * `America/Puerto_Rico` - America/Puerto_Rico
        * `America/Punta_Arenas` - America/Punta_Arenas
        * `America/Rainy_River` - America/Rainy_River
        * `America/Rankin_Inlet` - America/Rankin_Inlet
        * `America/Recife` - America/Recife
        * `America/Regina` - America/Regina
        * `America/Resolute` - America/Resolute
        * `America/Rio_Branco` - America/Rio_Branco
        * `America/Rosario` - America/Rosario
        * `America/Santa_Isabel` - America/Santa_Isabel
        * `America/Santarem` - America/Santarem
        * `America/Santiago` - America/Santiago
        * `America/Santo_Domingo` - America/Santo_Domingo
        * `America/Sao_Paulo` - America/Sao_Paulo
        * `America/Scoresbysund` - America/Scoresbysund
        * `America/Shiprock` - America/Shiprock
        * `America/Sitka` - America/Sitka
        * `America/St_Barthelemy` - America/St_Barthelemy
        * `America/St_Johns` - America/St_Johns
        * `America/St_Kitts` - America/St_Kitts
        * `America/St_Lucia` - America/St_Lucia
        * `America/St_Thomas` - America/St_Thomas
        * `America/St_Vincent` - America/St_Vincent
        * `America/Swift_Current` - America/Swift_Current
        * `America/Tegucigalpa` - America/Tegucigalpa
        * `America/Thule` - America/Thule
        * `America/Thunder_Bay` - America/Thunder_Bay
        * `America/Tijuana` - America/Tijuana
        * `America/Toronto` - America/Toronto
        * `America/Tortola` - America/Tortola
        * `America/Vancouver` - America/Vancouver
        * `America/Virgin` - America/Virgin
        * `America/Whitehorse` - America/Whitehorse
        * `America/Winnipeg` - America/Winnipeg
        * `America/Yakutat` - America/Yakutat
        * `America/Yellowknife` - America/Yellowknife
        * `Antarctica/Casey` - Antarctica/Casey
        * `Antarctica/Davis` - Antarctica/Davis
        * `Antarctica/DumontDUrville` - Antarctica/DumontDUrville
        * `Antarctica/Macquarie` - Antarctica/Macquarie
        * `Antarctica/Mawson` - Antarctica/Mawson
        * `Antarctica/McMurdo` - Antarctica/McMurdo
        * `Antarctica/Palmer` - Antarctica/Palmer
        * `Antarctica/Rothera` - Antarctica/Rothera
        * `Antarctica/South_Pole` - Antarctica/South_Pole
        * `Antarctica/Syowa` - Antarctica/Syowa
        * `Antarctica/Troll` - Antarctica/Troll
        * `Antarctica/Vostok` - Antarctica/Vostok
        * `Arctic/Longyearbyen` - Arctic/Longyearbyen
        * `Asia/Aden` - Asia/Aden
        * `Asia/Almaty` - Asia/Almaty
        * `Asia/Amman` - Asia/Amman
        * `Asia/Anadyr` - Asia/Anadyr
        * `Asia/Aqtau` - Asia/Aqtau
        * `Asia/Aqtobe` - Asia/Aqtobe
        * `Asia/Ashgabat` - Asia/Ashgabat
        * `Asia/Ashkhabad` - Asia/Ashkhabad
        * `Asia/Atyrau` - Asia/Atyrau
        * `Asia/Baghdad` - Asia/Baghdad
        * `Asia/Bahrain` - Asia/Bahrain
        * `Asia/Baku` - Asia/Baku
        * `Asia/Bangkok` - Asia/Bangkok
        * `Asia/Barnaul` - Asia/Barnaul
        * `Asia/Beirut` - Asia/Beirut
        * `Asia/Bishkek` - Asia/Bishkek
        * `Asia/Brunei` - Asia/Brunei
        * `Asia/Calcutta` - Asia/Calcutta
        * `Asia/Chita` - Asia/Chita
        * `Asia/Choibalsan` - Asia/Choibalsan
        * `Asia/Chongqing` - Asia/Chongqing
        * `Asia/Chungking` - Asia/Chungking
        * `Asia/Colombo` - Asia/Colombo
        * `Asia/Dacca` - Asia/Dacca
        * `Asia/Damascus` - Asia/Damascus
        * `Asia/Dhaka` - Asia/Dhaka
        * `Asia/Dili` - Asia/Dili
        * `Asia/Dubai` - Asia/Dubai
        * `Asia/Dushanbe` - Asia/Dushanbe
        * `Asia/Famagusta` - Asia/Famagusta
        * `Asia/Gaza` - Asia/Gaza
        * `Asia/Harbin` - Asia/Harbin
        * `Asia/Hebron` - Asia/Hebron
        * `Asia/Ho_Chi_Minh` - Asia/Ho_Chi_Minh
        * `Asia/Hong_Kong` - Asia/Hong_Kong
        * `Asia/Hovd` - Asia/Hovd
        * `Asia/Irkutsk` - Asia/Irkutsk
        * `Asia/Istanbul` - Asia/Istanbul
        * `Asia/Jakarta` - Asia/Jakarta
        * `Asia/Jayapura` - Asia/Jayapura
        * `Asia/Jerusalem` - Asia/Jerusalem
        * `Asia/Kabul` - Asia/Kabul
        * `Asia/Kamchatka` - Asia/Kamchatka
        * `Asia/Karachi` - Asia/Karachi
        * `Asia/Kashgar` - Asia/Kashgar
        * `Asia/Kathmandu` - Asia/Kathmandu
        * `Asia/Katmandu` - Asia/Katmandu
        * `Asia/Khandyga` - Asia/Khandyga
        * `Asia/Kolkata` - Asia/Kolkata
        * `Asia/Krasnoyarsk` - Asia/Krasnoyarsk
        * `Asia/Kuala_Lumpur` - Asia/Kuala_Lumpur
        * `Asia/Kuching` - Asia/Kuching
        * `Asia/Kuwait` - Asia/Kuwait
        * `Asia/Macao` - Asia/Macao
        * `Asia/Macau` - Asia/Macau
        * `Asia/Magadan` - Asia/Magadan
        * `Asia/Makassar` - Asia/Makassar
        * `Asia/Manila` - Asia/Manila
        * `Asia/Muscat` - Asia/Muscat
        * `Asia/Nicosia` - Asia/Nicosia
        * `Asia/Novokuznetsk` - Asia/Novokuznetsk
        * `Asia/Novosibirsk` - Asia/Novosibirsk
        * `Asia/Omsk` - Asia/Omsk
        * `Asia/Oral` - Asia/Oral
        * `Asia/Phnom_Penh` - Asia/Phnom_Penh
        * `Asia/Pontianak` - Asia/Pontianak
        * `Asia/Pyongyang` - Asia/Pyongyang
        * `Asia/Qatar` - Asia/Qatar
        * `Asia/Qostanay` - Asia/Qostanay
        * `Asia/Qyzylorda` - Asia/Qyzylorda
        * `Asia/Rangoon` - Asia/Rangoon
        * `Asia/Riyadh` - Asia/Riyadh
        * `Asia/Saigon` - Asia/Saigon
        * `Asia/Sakhalin` - Asia/Sakhalin
        * `Asia/Samarkand` - Asia/Samarkand
        * `Asia/Seoul` - Asia/Seoul
        * `Asia/Shanghai` - Asia/Shanghai
        * `Asia/Singapore` - Asia/Singapore
        * `Asia/Srednekolymsk` - Asia/Srednekolymsk
        * `Asia/Taipei` - Asia/Taipei
        * `Asia/Tashkent` - Asia/Tashkent
        * `Asia/Tbilisi` - Asia/Tbilisi
        * `Asia/Tehran` - Asia/Tehran
        * `Asia/Tel_Aviv` - Asia/Tel_Aviv
        * `Asia/Thimbu` - Asia/Thimbu
        * `Asia/Thimphu` - Asia/Thimphu
        * `Asia/Tokyo` - Asia/Tokyo
        * `Asia/Tomsk` - Asia/Tomsk
        * `Asia/Ujung_Pandang` - Asia/Ujung_Pandang
        * `Asia/Ulaanbaatar` - Asia/Ulaanbaatar
        * `Asia/Ulan_Bator` - Asia/Ulan_Bator
        * `Asia/Urumqi` - Asia/Urumqi
        * `Asia/Ust-Nera` - Asia/Ust-Nera
        * `Asia/Vientiane` - Asia/Vientiane
        * `Asia/Vladivostok` - Asia/Vladivostok
        * `Asia/Yakutsk` - Asia/Yakutsk
        * `Asia/Yangon` - Asia/Yangon
        * `Asia/Yekaterinburg` - Asia/Yekaterinburg
        * `Asia/Yerevan` - Asia/Yerevan
        * `Atlantic/Azores` - Atlantic/Azores
        * `Atlantic/Bermuda` - Atlantic/Bermuda
        * `Atlantic/Canary` - Atlantic/Canary
        * `Atlantic/Cape_Verde` - Atlantic/Cape_Verde
        * `Atlantic/Faeroe` - Atlantic/Faeroe
        * `Atlantic/Faroe` - Atlantic/Faroe
        * `Atlantic/Jan_Mayen` - Atlantic/Jan_Mayen
        * `Atlantic/Madeira` - Atlantic/Madeira
        * `Atlantic/Reykjavik` - Atlantic/Reykjavik
        * `Atlantic/South_Georgia` - Atlantic/South_Georgia
        * `Atlantic/St_Helena` - Atlantic/St_Helena
        * `Atlantic/Stanley` - Atlantic/Stanley
        * `Australia/ACT` - Australia/ACT
        * `Australia/Adelaide` - Australia/Adelaide
        * `Australia/Brisbane` - Australia/Brisbane
        * `Australia/Broken_Hill` - Australia/Broken_Hill
        * `Australia/Canberra` - Australia/Canberra
        * `Australia/Currie` - Australia/Currie
        * `Australia/Darwin` - Australia/Darwin
        * `Australia/Eucla` - Australia/Eucla
        * `Australia/Hobart` - Australia/Hobart
        * `Australia/LHI` - Australia/LHI
        * `Australia/Lindeman` - Australia/Lindeman
        * `Australia/Lord_Howe` - Australia/Lord_Howe
        * `Australia/Melbourne` - Australia/Melbourne
        * `Australia/NSW` - Australia/NSW
        * `Australia/North` - Australia/North
        * `Australia/Perth` - Australia/Perth
        * `Australia/Queensland` - Australia/Queensland
        * `Australia/South` - Australia/South
        * `Australia/Sydney` - Australia/Sydney
        * `Australia/Tasmania` - Australia/Tasmania
        * `Australia/Victoria` - Australia/Victoria
        * `Australia/West` - Australia/West
        * `Australia/Yancowinna` - Australia/Yancowinna
        * `Brazil/Acre` - Brazil/Acre
        * `Brazil/DeNoronha` - Brazil/DeNoronha
        * `Brazil/East` - Brazil/East
        * `Brazil/West` - Brazil/West
        * `CET` - CET
        * `CST6CDT` - CST6CDT
        * `Canada/Atlantic` - Canada/Atlantic
        * `Canada/Central` - Canada/Central
        * `Canada/Eastern` - Canada/Eastern
        * `Canada/Mountain` - Canada/Mountain
        * `Canada/Newfoundland` - Canada/Newfoundland
        * `Canada/Pacific` - Canada/Pacific
        * `Canada/Saskatchewan` - Canada/Saskatchewan
        * `Canada/Yukon` - Canada/Yukon
        * `Chile/Continental` - Chile/Continental
        * `Chile/EasterIsland` - Chile/EasterIsland
        * `Cuba` - Cuba
        * `EET` - EET
        * `EST` - EST
        * `EST5EDT` - EST5EDT
        * `Egypt` - Egypt
        * `Eire` - Eire
        * `Etc/GMT` - Etc/GMT
        * `Etc/GMT+0` - Etc/GMT+0
        * `Etc/GMT+1` - Etc/GMT+1
        * `Etc/GMT+10` - Etc/GMT+10
        * `Etc/GMT+11` - Etc/GMT+11
        * `Etc/GMT+12` - Etc/GMT+12
        * `Etc/GMT+2` - Etc/GMT+2
        * `Etc/GMT+3` - Etc/GMT+3
        * `Etc/GMT+4` - Etc/GMT+4
        * `Etc/GMT+5` - Etc/GMT+5
        * `Etc/GMT+6` - Etc/GMT+6
        * `Etc/GMT+7` - Etc/GMT+7
        * `Etc/GMT+8` - Etc/GMT+8
        * `Etc/GMT+9` - Etc/GMT+9
        * `Etc/GMT-0` - Etc/GMT-0
        * `Etc/GMT-1` - Etc/GMT-1
        * `Etc/GMT-10` - Etc/GMT-10
        * `Etc/GMT-11` - Etc/GMT-11
        * `Etc/GMT-12` - Etc/GMT-12
        * `Etc/GMT-13` - Etc/GMT-13
        * `Etc/GMT-14` - Etc/GMT-14
        * `Etc/GMT-2` - Etc/GMT-2
        * `Etc/GMT-3` - Etc/GMT-3
        * `Etc/GMT-4` - Etc/GMT-4
        * `Etc/GMT-5` - Etc/GMT-5
        * `Etc/GMT-6` - Etc/GMT-6
        * `Etc/GMT-7` - Etc/GMT-7
        * `Etc/GMT-8` - Etc/GMT-8
        * `Etc/GMT-9` - Etc/GMT-9
        * `Etc/GMT0` - Etc/GMT0
        * `Etc/Greenwich` - Etc/Greenwich
        * `Etc/UCT` - Etc/UCT
        * `Etc/UTC` - Etc/UTC
        * `Etc/Universal` - Etc/Universal
        * `Etc/Zulu` - Etc/Zulu
        * `Europe/Amsterdam` - Europe/Amsterdam
        * `Europe/Andorra` - Europe/Andorra
        * `Europe/Astrakhan` - Europe/Astrakhan
        * `Europe/Athens` - Europe/Athens
        * `Europe/Belfast` - Europe/Belfast
        * `Europe/Belgrade` - Europe/Belgrade
        * `Europe/Berlin` - Europe/Berlin
        * `Europe/Bratislava` - Europe/Bratislava
        * `Europe/Brussels` - Europe/Brussels
        * `Europe/Bucharest` - Europe/Bucharest
        * `Europe/Budapest` - Europe/Budapest
        * `Europe/Busingen` - Europe/Busingen
        * `Europe/Chisinau` - Europe/Chisinau
        * `Europe/Copenhagen` - Europe/Copenhagen
        * `Europe/Dublin` - Europe/Dublin
        * `Europe/Gibraltar` - Europe/Gibraltar
        * `Europe/Guernsey` - Europe/Guernsey
        * `Europe/Helsinki` - Europe/Helsinki
        * `Europe/Isle_of_Man` - Europe/Isle_of_Man
        * `Europe/Istanbul` - Europe/Istanbul
        * `Europe/Jersey` - Europe/Jersey
        * `Europe/Kaliningrad` - Europe/Kaliningrad
        * `Europe/Kiev` - Europe/Kiev
        * `Europe/Kirov` - Europe/Kirov
        * `Europe/Kyiv` - Europe/Kyiv
        * `Europe/Lisbon` - Europe/Lisbon
        * `Europe/Ljubljana` - Europe/Ljubljana
        * `Europe/London` - Europe/London
        * `Europe/Luxembourg` - Europe/Luxembourg
        * `Europe/Madrid` - Europe/Madrid
        * `Europe/Malta` - Europe/Malta
        * `Europe/Mariehamn` - Europe/Mariehamn
        * `Europe/Minsk` - Europe/Minsk
        * `Europe/Monaco` - Europe/Monaco
        * `Europe/Moscow` - Europe/Moscow
        * `Europe/Nicosia` - Europe/Nicosia
        * `Europe/Oslo` - Europe/Oslo
        * `Europe/Paris` - Europe/Paris
        * `Europe/Podgorica` - Europe/Podgorica
        * `Europe/Prague` - Europe/Prague
        * `Europe/Riga` - Europe/Riga
        * `Europe/Rome` - Europe/Rome
        * `Europe/Samara` - Europe/Samara
        * `Europe/San_Marino` - Europe/San_Marino
        * `Europe/Sarajevo` - Europe/Sarajevo
        * `Europe/Saratov` - Europe/Saratov
        * `Europe/Simferopol` - Europe/Simferopol
        * `Europe/Skopje` - Europe/Skopje
        * `Europe/Sofia` - Europe/Sofia
        * `Europe/Stockholm` - Europe/Stockholm
        * `Europe/Tallinn` - Europe/Tallinn
        * `Europe/Tirane` - Europe/Tirane
        * `Europe/Tiraspol` - Europe/Tiraspol
        * `Europe/Ulyanovsk` - Europe/Ulyanovsk
        * `Europe/Uzhgorod` - Europe/Uzhgorod
        * `Europe/Vaduz` - Europe/Vaduz
        * `Europe/Vatican` - Europe/Vatican
        * `Europe/Vienna` - Europe/Vienna
        * `Europe/Vilnius` - Europe/Vilnius
        * `Europe/Volgograd` - Europe/Volgograd
        * `Europe/Warsaw` - Europe/Warsaw
        * `Europe/Zagreb` - Europe/Zagreb
        * `Europe/Zaporozhye` - Europe/Zaporozhye
        * `Europe/Zurich` - Europe/Zurich
        * `Factory` - Factory
        * `GB` - GB
        * `GB-Eire` - GB-Eire
        * `GMT` - GMT
        * `GMT+0` - GMT+0
        * `GMT-0` - GMT-0
        * `GMT0` - GMT0
        * `Greenwich` - Greenwich
        * `HST` - HST
        * `Hongkong` - Hongkong
        * `Iceland` - Iceland
        * `Indian/Antananarivo` - Indian/Antananarivo
        * `Indian/Chagos` - Indian/Chagos
        * `Indian/Christmas` - Indian/Christmas
        * `Indian/Cocos` - Indian/Cocos
        * `Indian/Comoro` - Indian/Comoro
        * `Indian/Kerguelen` - Indian/Kerguelen
        * `Indian/Mahe` - Indian/Mahe
        * `Indian/Maldives` - Indian/Maldives
        * `Indian/Mauritius` - Indian/Mauritius
        * `Indian/Mayotte` - Indian/Mayotte
        * `Indian/Reunion` - Indian/Reunion
        * `Iran` - Iran
        * `Israel` - Israel
        * `Jamaica` - Jamaica
        * `Japan` - Japan
        * `Kwajalein` - Kwajalein
        * `Libya` - Libya
        * `MET` - MET
        * `MST` - MST
        * `MST7MDT` - MST7MDT
        * `Mexico/BajaNorte` - Mexico/BajaNorte
        * `Mexico/BajaSur` - Mexico/BajaSur
        * `Mexico/General` - Mexico/General
        * `NZ` - NZ
        * `NZ-CHAT` - NZ-CHAT
        * `Navajo` - Navajo
        * `PRC` - PRC
        * `PST8PDT` - PST8PDT
        * `Pacific/Apia` - Pacific/Apia
        * `Pacific/Auckland` - Pacific/Auckland
        * `Pacific/Bougainville` - Pacific/Bougainville
        * `Pacific/Chatham` - Pacific/Chatham
        * `Pacific/Chuuk` - Pacific/Chuuk
        * `Pacific/Easter` - Pacific/Easter
        * `Pacific/Efate` - Pacific/Efate
        * `Pacific/Enderbury` - Pacific/Enderbury
        * `Pacific/Fakaofo` - Pacific/Fakaofo
        * `Pacific/Fiji` - Pacific/Fiji
        * `Pacific/Funafuti` - Pacific/Funafuti
        * `Pacific/Galapagos` - Pacific/Galapagos
        * `Pacific/Gambier` - Pacific/Gambier
        * `Pacific/Guadalcanal` - Pacific/Guadalcanal
        * `Pacific/Guam` - Pacific/Guam
        * `Pacific/Honolulu` - Pacific/Honolulu
        * `Pacific/Johnston` - Pacific/Johnston
        * `Pacific/Kanton` - Pacific/Kanton
        * `Pacific/Kiritimati` - Pacific/Kiritimati
        * `Pacific/Kosrae` - Pacific/Kosrae
        * `Pacific/Kwajalein` - Pacific/Kwajalein
        * `Pacific/Majuro` - Pacific/Majuro
        * `Pacific/Marquesas` - Pacific/Marquesas
        * `Pacific/Midway` - Pacific/Midway
        * `Pacific/Nauru` - Pacific/Nauru
        * `Pacific/Niue` - Pacific/Niue
        * `Pacific/Norfolk` - Pacific/Norfolk
        * `Pacific/Noumea` - Pacific/Noumea
        * `Pacific/Pago_Pago` - Pacific/Pago_Pago
        * `Pacific/Palau` - Pacific/Palau
        * `Pacific/Pitcairn` - Pacific/Pitcairn
        * `Pacific/Pohnpei` - Pacific/Pohnpei
        * `Pacific/Ponape` - Pacific/Ponape
        * `Pacific/Port_Moresby` - Pacific/Port_Moresby
        * `Pacific/Rarotonga` - Pacific/Rarotonga
        * `Pacific/Saipan` - Pacific/Saipan
        * `Pacific/Samoa` - Pacific/Samoa
        * `Pacific/Tahiti` - Pacific/Tahiti
        * `Pacific/Tarawa` - Pacific/Tarawa
        * `Pacific/Tongatapu` - Pacific/Tongatapu
        * `Pacific/Truk` - Pacific/Truk
        * `Pacific/Wake` - Pacific/Wake
        * `Pacific/Wallis` - Pacific/Wallis
        * `Pacific/Yap` - Pacific/Yap
        * `Poland` - Poland
        * `Portugal` - Portugal
        * `ROC` - ROC
        * `ROK` - ROK
        * `Singapore` - Singapore
        * `Turkey` - Turkey
        * `UCT` - UCT
        * `US/Alaska` - US/Alaska
        * `US/Aleutian` - US/Aleutian
        * `US/Arizona` - US/Arizona
        * `US/Central` - US/Central
        * `US/East-Indiana` - US/East-Indiana
        * `US/Eastern` - US/Eastern
        * `US/Hawaii` - US/Hawaii
        * `US/Indiana-Starke` - US/Indiana-Starke
        * `US/Michigan` - US/Michigan
        * `US/Mountain` - US/Mountain
        * `US/Pacific` - US/Pacific
        * `US/Samoa` - US/Samoa
        * `UTC` - UTC
        * `Universal` - Universal
        * `W-SU` - W-SU
        * `WET` - WET
        * `Zulu` - Zulu
        * `localtime` - localtime
    TokenResponse:
      type: object
      properties:
        token:
          type: string
          readOnly: true
      required:
      - token
    Tracker:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        tasks:
          type: array
          items:
            type: string
            format: uri
        active_from:
          type: string
          format: date-time
          nullable: true
        active_until:
          type: string
          format: date-time
          nullable: true
        queued_states:
          type: array
          items:
            $ref: '#/components/schemas/TaskStateEnum'
        active_states:
          type: array
          items:
            $ref: '#/components/schemas/TaskStateEnum'
        public_task_fields:
          type: array
          items:
            $ref: '#/components/schemas/PublicTaskFieldsEnum'
          description: Task fields returned under tasks[] on the public tracker endpoint
        show_driver_info:
          type: boolean
        show_destination:
          type: boolean
        show_eta:
          type: boolean
        show_sms_action:
          type: boolean
        show_call_action:
          type: boolean
        show_logo:
          type: boolean
        show_path:
          type: boolean
        show_predicted_delivery:
          type: boolean
        autozoom:
          type: boolean
        max_zoom_level:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          nullable: true
        tracking_page_url:
          type: string
          format: uri
          readOnly: true
        reviews_allowed:
          type: boolean
        reviewed_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        created_by:
          type: string
          format: uri
          readOnly: true
      required:
      - account
      - created_by
      - id
      - reviewed_at
      - tasks
      - tracking_page_url
      - url
    TrackerPublic:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        account:
          type: string
          format: uri
        state:
          type: string
          readOnly: true
        assignees:
          type: array
          items:
            $ref: '#/components/schemas/UserExport'
        queue_positions:
          type: array
          items:
            type: int
          readOnly: true
        tasks:
          type: array
          items:
            $ref: '#/components/schemas/TrackerTasks'
          readOnly: true
        active_from:
          type: string
          format: date-time
          nullable: true
        active_until:
          type: string
          format: date-time
          nullable: true
        queued_states:
          type: array
          items:
            $ref: '#/components/schemas/TaskStateEnum'
        active_states:
          type: array
          items:
            $ref: '#/components/schemas/TaskStateEnum'
        show_driver_info:
          type: boolean
        show_destination:
          type: boolean
        show_eta:
          type: boolean
        show_sms_action:
          type: boolean
        show_call_action:
          type: boolean
        show_predicted_delivery:
          type: boolean
        show_last_task_event_notes:
          type: boolean
          nullable: true
        show_last_task_images:
          type: boolean
          nullable: true
        last_task_event_notes:
          type: string
          readOnly: true
        last_task_images:
          type: array
          items:
            type: string
        logo:
          type: string
          format: uri
          readOnly: true
        show_logo:
          type: boolean
        show_path:
          type: boolean
        autozoom:
          type: boolean
        max_zoom_level:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          nullable: true
        language:
          type: string
          readOnly: true
        reviews_allowed:
          type: boolean
        reviewed_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        predicted_delivery:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        predicted_delivery_calculated_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
          description: When was the predicted delivery last calculated
        predicted_delivery_error:
          type: string
          readOnly: true
        default_map_location:
          type: object
          additionalProperties: {}
          readOnly: true
        feature_tracker_map_provider:
          type: string
          readOnly: true
        google_maps_region:
          type: string
          readOnly: true
        task_popup_template:
          type: string
          readOnly: true
      required:
      - account
      - assignees
      - default_map_location
      - feature_tracker_map_provider
      - google_maps_region
      - id
      - language
      - last_task_event_notes
      - last_task_images
      - logo
      - predicted_delivery
      - predicted_delivery_calculated_at
      - predicted_delivery_error
      - queue_positions
      - reviewed_at
      - state
      - task_popup_template
      - tasks
    TrackerTasks:
      type: object
      description: Public tracker task payload; fields filtered by Tracker.public_task_fields.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        reference:
          type: string
          maxLength: 100
        state:
          $ref: '#/components/schemas/TaskStateEnum'
        category:
          $ref: '#/components/schemas/TaskCategoryEnum'
        assignee:
          type: string
          format: uuid
          nullable: true
        contact:
          allOf:
          - $ref: '#/components/schemas/NestedContact'
          readOnly: true
        address:
          allOf:
          - $ref: '#/components/schemas/NestedAddress'
          readOnly: true
        duration:
          type: object
          nullable: true
          default: 4 10:55:34.12
        scheduled_time:
          type: string
          format: date-time
          nullable: true
        completed_at:
          type: string
          format: date-time
          nullable: true
        cancelled_at:
          type: string
          format: date-time
          nullable: true
        failed_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - address
      - contact
      - failed_at
      - id
      - url
    UserEmailVerification:
      type: object
      properties:
        token:
          type: string
          writeOnly: true
      required:
      - token
    UserExport:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        first_name:
          type: string
          maxLength: 30
        last_name:
          type: string
          maxLength: 30
        display_name:
          type: string
          readOnly: true
        email:
          type: string
          format: email
        phone:
          type: string
          readOnly: true
        last_time_location:
          $ref: '#/components/schemas/TimeLocation'
      required:
      - display_name
      - email
      - id
      - last_time_location
      - phone
    ValueTypeEnum:
      enum:
      - string
      - integer
      - decimal
      - choice
      - link
      - assignee
      - json
      - multiselect
      - text
      type: string
      description: |-
        * `string` - String
        * `integer` - Integer
        * `decimal` - Decimal
        * `choice` - Choice
        * `link` - Link
        * `assignee` - Assignee
        * `json` - JSON
        * `multiselect` - Multiselect
        * `text` - Text
    VehicleProfileEnum:
      enum:
      - bike
      - bus
      - car
      - foot
      - scooter
      - small_truck
      - truck
      type: string
      description: |-
        * `bike` - Bike
        * `bus` - Bus
        * `car` - Car
        * `foot` - Foot
        * `scooter` - Scooter
        * `small_truck` - Small truck
        * `truck` - Truck
    VersionEnum:
      enum:
      - 2.11.9
      - 2.11.8
      - 2.11.7
      - 2.11.6
      - 2.11.5
      - 2.11.4
      - 2.11.3
      - 2.11.2
      - 2.11.1
      - 2.11.0
      - 2.10.0
      - 2.9.3
      - 2.9.2
      - 2.9.1
      - 2.9.0
      - 2.8.0
      - 2.7.0
      - 2.6.1
      - 2.6.0
      - 2.5.1
      - 2.5.0
      - 2.4.53
      - 2.4.52
      - 2.4.51
      - 2.4.50
      - 2.4.49
      - 2.4.48
      - 2.4.47
      - 2.4.46
      - 2.4.45
      - 2.4.44
      - 2.4.43
      - 2.4.42
      - 2.4.41
      - 2.4.40
      - 2.4.39
      - 2.4.38
      - 2.4.37
      - 2.4.36
      - 2.4.35
      - 2.4.34
      - 2.4.33
      - 2.4.32
      - 2.4.31
      - 2.4.30
      - 2.4.29
      - 2.4.28
      - 2.4.27
      - 2.4.26
      - 2.4.25
      - 2.4.24
      - 2.4.23
      - 2.4.22
      - 2.4.21
      - 2.4.20
      - 2.4.19
      - 2.4.18
      - 2.4.17
      - 2.4.16
      - 2.4.15
      - 2.4.14
      - 2.4.13
      - 2.4.12
      - 2.4.11
      - 2.4.10
      - 2.4.9
      - 2.4.8
      - 2.4.7
      - 2.4.6
      - 2.4.5
      - 2.4.4
      - 2.4.3
      - 2.4.2
      - 2.4.1
      - 2.3.5
      - 2.3.4
      - 2.3.3
      - 2.3.2
      - 2.3.1
      - 2.3.0
      - 2.2.6
      - 2.2.5
      - 2.2.4
      - 2.2.3
      - 2.2.2
      - 2.2.1
      - 2.2.0
      - 2.1.1
      - 2.1.0
      - 2.0.0
      - 1.1.0
      - 1.0.0
      type: string
      description: |-
        * `2.11.9` - 2.11.9
        * `2.11.8` - 2.11.8
        * `2.11.7` - 2.11.7
        * `2.11.6` - 2.11.6
        * `2.11.5` - 2.11.5
        * `2.11.4` - 2.11.4
        * `2.11.3` - 2.11.3
        * `2.11.2` - 2.11.2
        * `2.11.1` - 2.11.1
        * `2.11.0` - 2.11.0
        * `2.10.0` - 2.10.0
        * `2.9.3` - 2.9.3
        * `2.9.2` - 2.9.2
        * `2.9.1` - 2.9.1
        * `2.9.0` - 2.9.0
        * `2.8.0` - 2.8.0
        * `2.7.0` - 2.7.0
        * `2.6.1` - 2.6.1
        * `2.6.0` - 2.6.0
        * `2.5.1` - 2.5.1
        * `2.5.0` - 2.5.0
        * `2.4.53` - 2.4.53
        * `2.4.52` - 2.4.52
        * `2.4.51` - 2.4.51
        * `2.4.50` - 2.4.50
        * `2.4.49` - 2.4.49
        * `2.4.48` - 2.4.48
        * `2.4.47` - 2.4.47
        * `2.4.46` - 2.4.46
        * `2.4.45` - 2.4.45
        * `2.4.44` - 2.4.44
        * `2.4.43` - 2.4.43
        * `2.4.42` - 2.4.42
        * `2.4.41` - 2.4.41
        * `2.4.40` - 2.4.40
        * `2.4.39` - 2.4.39
        * `2.4.38` - 2.4.38
        * `2.4.37` - 2.4.37
        * `2.4.36` - 2.4.36
        * `2.4.35` - 2.4.35
        * `2.4.34` - 2.4.34
        * `2.4.33` - 2.4.33
        * `2.4.32` - 2.4.32
        * `2.4.31` - 2.4.31
        * `2.4.30` - 2.4.30
        * `2.4.29` - 2.4.29
        * `2.4.28` - 2.4.28
        * `2.4.27` - 2.4.27
        * `2.4.26` - 2.4.26
        * `2.4.25` - 2.4.25
        * `2.4.24` - 2.4.24
        * `2.4.23` - 2.4.23
        * `2.4.22` - 2.4.22
        * `2.4.21` - 2.4.21
        * `2.4.20` - 2.4.20
        * `2.4.19` - 2.4.19
        * `2.4.18` - 2.4.18
        * `2.4.17` - 2.4.17
        * `2.4.16` - 2.4.16
        * `2.4.15` - 2.4.15
        * `2.4.14` - 2.4.14
        * `2.4.13` - 2.4.13
        * `2.4.12` - 2.4.12
        * `2.4.11` - 2.4.11
        * `2.4.10` - 2.4.10
        * `2.4.9` - 2.4.9
        * `2.4.8` - 2.4.8
        * `2.4.7` - 2.4.7
        * `2.4.6` - 2.4.6
        * `2.4.5` - 2.4.5
        * `2.4.4` - 2.4.4
        * `2.4.3` - 2.4.3
        * `2.4.2` - 2.4.2
        * `2.4.1` - 2.4.1
        * `2.3.5` - 2.3.5
        * `2.3.4` - 2.3.4
        * `2.3.3` - 2.3.3
        * `2.3.2` - 2.3.2
        * `2.3.1` - 2.3.1
        * `2.3.0` - 2.3.0
        * `2.2.6` - 2.2.6
        * `2.2.5` - 2.2.5
        * `2.2.4` - 2.2.4
        * `2.2.3` - 2.2.3
        * `2.2.2` - 2.2.2
        * `2.2.1` - 2.2.1
        * `2.2.0` - 2.2.0
        * `2.1.1` - 2.1.1
        * `2.1.0` - 2.1.0
        * `2.0.0` - 2.0.0
        * `1.1.0` - 1.1.0
        * `1.0.0` - 1.0.0
    WebAppReleaseTrackEnum:
      enum:
      - live
      - beta
      type: string
      description: |-
        * `live` - Live
        * `beta` - Beta
    Webhook:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          readOnly: true
        account:
          type: string
          format: uri
        name:
          type: string
          maxLength: 100
        version:
          $ref: '#/components/schemas/VersionEnum'
        state:
          allOf:
          - $ref: '#/components/schemas/WebhookStateEnum'
          readOnly: true
        headers: {}
        target:
          type: string
          format: uri
          maxLength: 2048
        task_events:
          type: boolean
        task_event_types:
          type: array
          items:
            $ref: '#/components/schemas/TaskEventTypesEnum'
          description: Available task event types:<br>• create<br>• assign<br>• unassign<br>•
            reject<br>• restart<br>• accept<br>• unaccept<br>• transit<br>• activate<br>•
            complete<br>• fail<br>• cancel<br>• assignee_near<br>• assignee_away<br>•
            updated
        document_events:
          type: boolean
        signature_events:
          type: boolean
        review_events:
          type: boolean
        form_response_events:
          type: boolean
          nullable: true
        notification_emails:
          type: array
          items:
            type: string
            format: email
            maxLength: 254
        fail_message:
          type: string
          readOnly: true
        shared_secret:
          type: string
          maxLength: 40
        activated_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        failed_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - account
      - activated_at
      - created_at
      - fail_message
      - failed_at
      - id
      - name
      - state
      - target
      - updated_at
      - url
    WebhookStateEnum:
      enum:
      - inactive
      - active
      - failed
      type: string
      description: |-
        * `inactive` - inactive
        * `active` - active
        * `failed` - failed
    WorkerFeature:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/GisFeatureEnum'
        id:
          type: string
          format: uuid
        geometry:
          type: object
          properties:
            type:
              type: string
              enum:
              - Point
            coordinates:
              type: array
              items:
                type: number
                format: float
              example:
              - 12.9721
              - 77.5933
              minItems: 2
              maxItems: 3
        properties:
          type: object
          properties:
            model:
              type: string
              readOnly: true
            url:
              type: string
              format: uri
              readOnly: true
            time_location:
              type: string
              format: uri
              readOnly: true
            source:
              type: string
              readOnly: true
              nullable: true
            user:
              type: string
              format: uri
              readOnly: true
            user_name:
              type: string
              readOnly: true
            time:
              type: string
              format: date-time
            state:
              enum:
              - unknown
              - stopped
              - moving
              type: string
              description: |-
                * `unknown` - Unknown
                * `stopped` - Stopped
                * `moving` - Moving
            heading:
              type: integer
              nullable: true
            speed:
              type: integer
              nullable: true
            altitude:
              type: integer
              nullable: true
            accuracy:
              type: integer
              maximum: 2147483647
              minimum: -2147483648
              nullable: true
            battery_level:
              type: string
              format: decimal
              pattern: ^-?\d{0,1}(?:\.\d{0,3})?$
              nullable: true
            created_at:
              type: string
              format: date-time
              readOnly: true
            updated_at:
              type: string
              format: date-time
              readOnly: true
    WorkerFeatureList:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/GisFeatureCollectionEnum'
        features:
          type: array
          items:
            $ref: '#/components/schemas/WorkerFeature'
    WorkerTrack:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/GisFeatureEnum'
        id:
          type: string
          readOnly: true
        geometry: {}
        properties:
          type: object
          properties:
            user:
              type: string
              format: uuid
            start_time:
              type: string
              format: date-time
            end_time:
              type: string
              format: date-time
    WorkerTrackList:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/GisFeatureCollectionEnum'
        features:
          type: array
          items:
            $ref: '#/components/schemas/WorkerTrack'
    WorkingState:
      type: object
      properties:
        account_role:
          type: string
          format: uri
        account:
          type: string
          format: uri
        user:
          type: string
          format: uri
        mode:
          $ref: '#/components/schemas/ModeEnum'
        timestamp:
          type: string
          format: date-time
        status:
          $ref: '#/components/schemas/StatusEnum'
        created_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - created_at
      - status
  securitySchemes:
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"
webhooks:
  taskevent.create:
    post:
      description: Fired when a task state change or update occurs.
      summary: Task Event Webhook
      tags:
      - webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskEventSerializerV2'
        required: true
      responses:
        '200':
          description: No response body
  document.create:
    post:
      description: Fired when a document is attached to a task.
      summary: Document Webhook
      tags:
      - webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentTaskInline'
        required: true
      responses:
        '200':
          description: No response body
  signature.create:
    post:
      description: Fired when a signature is captured on a task.
      summary: Signature Webhook
      tags:
      - webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignatureTaskInline'
        required: true
      responses:
        '200':
          description: No response body
  review.create:
    post:
      description: Fired when a tracker submits a review.
      summary: Review Webhook
      tags:
      - webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Review'
        required: true
      responses:
        '200':
          description: No response body
tags:
- name: introduction
  description: |-
    The GSMtasks API is a RESTful web service for developers to programmatically interact with GSMtasks data, real-time delivery and task management and route optimization functionality.

    The GSMtasks API is organized around REST. Every bit of data exchanged between clients and the API is JSON over HTTPS. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. You must authenticate for all requests.

    The base URL for the GSMtasks API is [https://api.gsmtasks.com](https://api.gsmtasks.com/).

    If you have questions about using the API, or have come across a bug you'd like to report, write us an email at [info@gsmtasks.com](mailto:info@gsmtasks.com).
  x-displayName: Introduction
  x-traitTag: true
- name: authentication
  description: |-
    For clients to authenticate, the API key should be included in the Authorization HTTP header.

    The key should be prefixed by the string literal "Token", with whitespace separating the two strings.

    ```http
    Authorization: Token YOUR_API_KEY
    ```

    You must replace `YOUR_API_KEY` with your personal API key.

    API keys start with `gsmtasks_` followed by the environment, e.g. `gsmtasks_live_`. The `gsmtasks_` prefix lets secret scanning tools detect leaked keys. Older keys are 40-character hexadecimal strings and remain valid.

    ## Obtaining an API key

    API keys are created from the GSMtasks dashboard:

    1. Open **Settings → API keys** to manage the keys that determine what data your app can access.
    2. Click **Create API key**, fill in a **Name** and **Email** for the key, and press **Save**.
    3. The key is shown only once, immediately after creation. Copy it and store it somewhere safe.

    > **Warning:** The API key is non-recoverable. If you lose it, you will have to create a new one.

    > **Note:** Keys are valid until they are revoked from the **API keys** page.
  x-displayName: Authentication
  x-traitTag: true
- name: versioning
  description: |-
    Every request must declare which API version it targets. The version forms the API contract: a given version is expected to remain fully backwards compatible, so an integration pinned to a version keeps working as the API evolves.

    The version is provided through the `Accept` header in the request.

    ```http
    Accept: application/json; version=2.11.0
    ```

    > **Note:** Without providing the Accept header and a correct version the API will respond with a status code of 400 and an error message.
  x-displayName: Versioning
  x-traitTag: true
- name: changelog
  description: |-
    ### 2.11.9
    - Webhooks: added `task_event_types` field, the task event types that trigger the webhook when `task_events` is enabled. Empty list sends all task events
    - Metafields: added `text` value type for multi-line text

    ### 2.11.8
    - Configuration: added field `environment.web_app_release_track`

    ### 2.11.7
    - Session tokens: added field `last_issued_at`, when the session's current token was issued by logging in, refreshing or impersonation

    ### 2.11.6
    - Configuration: added field `environment.mobile_app_locale_url`, the base URL of the mobile app's translation catalogs. One `<language>.json` per language lives under it, served gzip-encoded with an `ETag` for revalidation. `null` for `app=web`
    - Trackers (public): predicted delivery is recalculated at most once per account `tracker_predicted_delivery_expiry` (default 1 minute), and only when the assignee has moved more than 50 m (geography distance), stored location is missing, there is no ETA, a previous calculation error is set, or the last routing response is older than `tracker_predicted_delivery_clear` (default 3 minutes). A successful stored ETA for a stationary assignee is kept between those refreshes. Stored ETA is otherwise cleared after `clear` when a recalc is already requested.
    - Trackers (public): `predicted_delivery_calculated_at` is stamped when a recalc is requested or skipped (debounce), not only when the Celery task finishes.
    - Trackers (public): new predicted-delivery error code `too_many_waypoints` when a route has too many stops to calculate.
    - Trackers: accounts can use Google Routes (`TRAFFIC_AWARE`) for traffic-aware predicted delivery. Default remains OSRM. Successful routing requests (OSRM and Google) count toward `monthly_predicted_delivery_routing_limit` (default 100000).

    ### 2.11.5
    - Metafields: `label` is now required and may not be blank when creating a metafield, matching the web UI, which has required it since March 2024. Callers on earlier versions may still omit it, and existing metafields without a label are unaffected.

    ### 2.11.4
    - Notification templates: added `eta_at` message variable — the predicted arrival as an absolute datetime in the account timezone (e.g. `{{ eta_at|time:"H:i" }}`); renders `-` when no ETA is available, matching `eta`.
    - Form fields: added `visible_to_worker` field (default `true`). When `false`, clients should hide the field from worker UIs. The API continues to return the field definition and any related values; it does not filter or reject them for workers.
    - Form fields: added `collapsed` field (default `false`) — persisted default-collapsed state for array/section fields.
    - Form fields: added `layout` field (`list`|`table`, default `list`) — persisted array row layout; `table` renders rows compact on one line.
    - Trackers: added `public_task_fields` on authenticated Tracker create/read/update — allowlist of fields returned under public `tasks[]`. Omit the field to use defaults; empty list is rejected.
    - Trackers (public): `tasks[].reference` is opt-in via `public_task_fields` (not included in the default field set, preserving prior public payload shape).
    - Trackers (public): `predicted_delivery_error` is localized from stable error codes using `Accept-Language`, then the account language. Legacy free-text values pass through unchanged. ETA error strings are translated for supported locales (de, en, es, et, fi, fr, it, lt, lv, pl, ru, sv).
    - SMS: `POST /sms/` and `POST /sms/{id}/resend/` are idempotent within `SMS_DUPLICATE_SEND_WINDOW_SECONDS` — a duplicate account+phone+message submission returns **200** with the existing object instead of creating another row (**201** still means a new SMS was created)
    - SMS: resend always enqueues a fresh queued message (does not clone prior sent/failed state)

    ### 2.11.3
    - Configuration: added `google_maps_region` feature for web app Google Maps region bias
    - Trackers (public): added `google_maps_region`, the account's Google Maps region code for the tracker map. Blank when not set

    ### 2.11.2
    - Notification templates: exposed `pod_show_images`, `pod_show_signatures`, `pod_show_task_events`, `pod_show_task_event_creators`, `pod_show_reference`, `pod_show_description` fields. When a template is created without these values, they default from the account's matching POD options.

    ### 2.11.1
    - Metafields: added `hide_when_empty` field — when `true`, the metafield is omitted from task/contact detail and Proof of Delivery views if its value is empty.

    ### 2.11.0
    - Forms: added `/forms/`, `/form_fields/`, `/form_responses/` endpoints for native form building
    - Forms: added Form, FormField, FormResponse models
    - Forms: added `/form_responses/{id}/complete/` action to lock responses and capture schema snapshot
    - FormRule: added optional `form` FK for auto-generating edit/view/pdf URLs
    - Tasks: added `form_default_values` field for per-form default value overrides
    - Webhooks: added `form_response_events` flag for form response completion webhooks

    ### 2.10.0
    - Authentication: split-token JWT model. `POST /authenticate/` now returns a session-token JWT (`{"token": "..."}`) instead of the legacy `{"token", "user", "account"}` body; legacy callers (version `< 2.10.0`) keep the old shape and the long-lived `AccessToken`.
    - Session tokens: new `POST /session_tokens/refresh/` endpoint — JWT callers re-sign in place, legacy `AccessToken` callers trade up to a JWT.
    - Session tokens: new `POST /session_tokens/authorize/` endpoint — exchanges a session JWT for a short-lived authorization JWT scoped to one account.
    - Session tokens: new `/session_tokens/` viewset for listing/creating (integration users only)/revoking sessions.
    - Trailing slashes: a missing trailing slash now returns `404` instead of a `301` redirect; legacy callers (`< 2.10.0`) keep the slash appended transparently.

    ### 2.9.3
    - Accounts: added `tracker_task_popup_template` field
    - Trackers: added `task_popup_template` field on the public tracker payload

    ### 2.9.2
    - Account Roles: added `show_travel_estimates` field

    ### 2.9.1
    - Tasks: added `signers` field (JSONField)

    ### 2.9.0
    - Contact Address Exports: added metafield export support using `metafields__namespace:key` or `metafields__namespace__key` syntax
    - Contact Address Imports: added `metafields` field support for importing metafields with contact addresses
    - Metafields: added `source` field for linking task metafields with contact address metafields
    - Tasks: scheduled tasks can now be assigned/unassigned regardless of future scheduled time

    ### 2.8.0
    - Metafields: added `multiselect` value type for multi-value selection fields

    ### 2.7.0
    - Metafields: `applies_to` field now supports `contact_addresses` value

    ### 2.6.1
    - Accounts: added fields `optimize_earliest_start`, `optimize_latest_end`, `optimize_visit_duration_margin` (read from API 2.6.1+)

    ### 2.6.0
    - Webhooks: Document and Signature webhooks now inline full task data instead of URL reference (similar to TaskEvent webhooks in v2.0.0)

    ### 2.5.1
    - Accounts: added `feature_signer_name_required_task_category` field for category-based signer name requirements

    ### 2.5.0
    - Accounts: added `feature_tracker_map_provider` field with map provider choices
    - Routes: added `metafields` field (JSONField)
    - Metafields: added `applies_to` field
    - Trackers: added `feature_tracker_map_provider` field
    - Task exports: added `assignee__password_expires_at` field
    - Task exports: added `order__description` field
    - Task exports: added `address__geocoding_provider` field
    - Task exports: added `forms` field

    ### 2.4.50
    - AccountRole: added fields `vehicle_capacity_divisor`, `vehicle_capacity_units`, `show_vehicle_capacity` and `require_sequential_completion`

    ### 2.4.49
    - Accounts: added `failed_reasons` array
    - Route optimizations: added `ignore_time_windows`
    - Metafields: added `is_required_before_complete`
    - Notification templates: added `scheduled_time_added`

    ### 2.4.48
    - Introduce `default_map_location` parameter for public trackers

    ### 2.4.47
    - Introduce `verify_email` action to `/users/` API to verify user email
    - Introduce new validation rule to validate phone numbers in notifications

    ### 2.4.46
    - Introduce `hijack` action to `/users/` API to hijack user account

    ### 2.4.45
    - Introduce custom API `AccessToken` to replace it with default `Token` used
    - Add new API `/logout/` to logout and revoke token

    ### 2.4.44
    - Metafields: added field show_in_form

    ### 2.4.43
    - Metafields: added value_type assignee

    ### 2.4.42
    - Configuration defaults has `transit_active_limit`

    ### 2.4.40
    - Metafields: added value_type link

    ### 2.4.39
    - Task restart action to restart a task from failed state

    ### 2.4.38
    - Expose a read-only `feature_tracker_url` under Account

    ### 2.4.37
    - Expose `optimize_return_to_depot`, `optimize_earliest_start`, `optimize_latest_end` under AccountRole

    ### 2.4.36
    - Orders: added field `recurrence`
    - Tasks: added fields `recurrence` and `calendar_time`
    - Tasks: added states `draft` and `scheduled`

    ### 2.4.35
    - Tracker added fields `show_last_task_event_notes`, `show_last_task_images`, `last_task_event_notes`, `last_task_images`

    ### 2.4.34
    - RouteOptimizationResultTask: added field `reference`

    ### 2.4.33
    - Documents: added field `recurrence`
    - Orders: added field `recurrence`
    - Orders: added sideloading option `recurrence__documents`
    - Tasks: added field `recurrence`
    - Tasks: added sideloading option `recurrence__documents`
    - Recurrences: removed field `order` and added fields `order_data`, `route`

    ### 2.4.32
    - All endpoints: added list view query argument names validation

    ### 2.4.31
    - Recurrences: added field `external_id`

    ### 2.4.30
    - AccountRole: add detail action `resend_activation_token` to resend activation token to the user

    ### 2.4.29
    - Tasks: added field `created_by`

    ### 2.4.28
    - Configuration: Added features `signature_required_task_category` and `picture_required_task_category` which limit the signature and picture requirement based on task category
    - Documents: added write-only field `s3_response_headers`
    - Signatures: added field `external_id` and write-only field `s3_response_headers`

    ### 2.4.27
    - Tasks: Add detail action `pod` to get HTML or PDF via API

    ### 2.4.26
    - Documents: Added `file_upload` content check when creating documents (rescinded)
    - Signatures: Added `file_upload` content check when creating signatures (rescinded)

    ### 2.4.25
    - Route Optimization: Add detail action `report` to get HTML or PDF reports via API

    ### 2.4.24
    - Configuration: Added features `signer_name_required` and `notes_required`

    ### 2.4.23
    - Configuration: Added features `signer_name_required` and `notes_required`
    - TimeLocations: Added fields `is_moving`, `event` and `activity_type`

    ### 2.4.22
    - Webhook: Rename state `disabled` to `failed`, rename `disabled_at` to `failed_at` and `disable_message` to `fail_message`

    ### 2.4.21
    - Account: add field `review_emails_to_assignee` to API

    ### 2.4.20
    - FormRule: added field `open_in`
    - TaskForm: added field `open_in`

    ### 2.4.19
    - Tracker: Rename field `predicted_delivery_at` to `predicted_delivery_calculated_at` in order to avoid confusion

    ### 2.4.18
    - Account: add fields `route_default_state` and `feature_route_auto_archive` to model and API
    - Configuration: add field `create_contact_address` to configuration defaults
    - Route: add field `state` to model and API
    - Route: API add actions `activate`, `archive` and `draft`

    ### 2.4.17
    - Add `Accept-Timezone` header in order to manage timezones correctly. Can be used retrospectively.
    - Account: add feature flag `feature_route_folders` to allow tasks to be grouped into routes in the WEB dashboard.
    - Configuration: add field `create_contact_address` to configuration defaults
    - Configuration: remove feature `reposition_icon`
    - Routes: add fields `name` and `objective` to Route model and API
    - Routes: Replaced fields `start_location` and `end_location` with `start_address` and `end_address`
    - RouteOptimizations: Add `end_time` to RouteOptimization model and API
    - Tasks: add field `routes` to Tasks sideloading
    - TasksCommand: add field `route` to `TaskCommand.task_data` if you need to update/assign/reassign/unassign the task

    ### 2.4.16

    - Tracker: Added field `predicted_delivery_error` to Tracker `Public` detail view

    ### 2.4.15

    - Tasks: fields `contact_address` and `contact_address_external_id` made visible
    - Tasks: Added filters for `contact_address` and `contact_address__external_id`

    ### 2.4.14

    - TaskCommand: `contact_address`.`address` added to `task_data` as an updatable field in order to
    allow updating `contact_address.address` data for future usage

    ### 2.4.13

    - Tasks: `updated_at_delay_latest` filter added
    - NB! Web and Mobile apps should use this filter as it replaces older logic applied
    for cases where `updated_at__gt` or `updated_at__gte` filtering is used without an upper bound.
    This filter prevents the out-of-order appearance of records.
    Implemented for the following views: `scenes_dashboard`, `scenes_task_list`, `task_exports` and `tasks` list views

    ### 2.4.12

    - Tasks: `contact_address` write only field added
    - Tasks: `contact_address_external_id` write only field added
    - `contact_address` will replace missing `address` and/or `contact` values when in POST and PUT requests

    ### 2.4.11

    - Accounts: `optimize_when_on_duty` removed

    ### 2.4.10

    - Recurrences: `scheduled_time` added to `tasks_data`

    ### 2.4.9

    - Recurrences: `assignee` is not based on `user` instead of `account_role` to match other `assignee` usages

    ### 2.4.8

    - NotificationTemplate: Add field `phones` to API
    - NotificationTemplate: Add field `emails` to API

    ### 2.4.7

    - TaskBackgroundImport: Add field `order_orderer` to API
    - TaskBackgroundImport: Field `contact_accress_external_id` is now saved to task for future reference
    - TaskExport: Add `contact_accress_external_id` as an exportable field
    - Task: Add `contact_accress` relation to database as a reference
    - Orders are now generated with `orderer` data in case `order_orderer` is set during import

    ### 2.4.6

    - Remove assignee from OrderSerializerV2

    ### 2.4.5

    - TasksStatesCount: Add filter `assignee__in` to API
    - TasksStatesCount: `assignee` filters are now based on `user_id` instead of `account_role_id` to match other endpoints
    - TasksStatesCount: drop `assignee_url` from response data

    ### 2.4.4

    - Add `billing` for ConfigurationSerializer

    ### 2.4.3

    - Sideloaded orders serializer changed to OrdersV2Serializer for tasks endpoint

    ### 2.4.2

    - Added Documents batch delete action
    - Added Signatures batch delete action

    ### 2.4.1

    - Added AccountRole activation API
    - Added user activation API

    ### 2.4.0

    - Added AccountRole rolling window tasks scheduling
    - Added rolling window schedule based notifications

    ### 2.3.5

    - Metafields API active usage removed from queryset to allow admins to see and edit non-visible metafields
    - Better error handling in case metafield is not editable.

    ### 2.3.4

    - Recurrence: Dropped field `assign_worker` from API
    - Recurrence: Added field `assignee` to API
    - Recurrence: Added field `created_by` to API

    ### 2.3.3

    - Order: Added field `description` to API

    ### 2.3.2

    - Document: Added field `mimetype` and `thumbnail` to API
    - Signature: Added field `mimetype` and `thumbnail` to API
    - Document and Signature: `mimetype` detection added and `thumbnail` generation added

    ### 2.3.1

    - OrdersAPI: Added field `documents`

    ### 2.3.0

    - Task: `position` field changed to **Float** in the backend
    - TaskBackgroundImport: `version` field added to denote, what API version was used to create the import and what version to use the serialize the `tasks_data`
    - TaskImportSerializerV2: `position` expects _timestamp_ as a float value
    - RouteOptimizationSerializerV1: `position` expects _timestamp_ as a float value
    - RouteOptimizationResultSerializer: `position` expects _timestamp_ as a float value
    - TODO!

    ### 2.2.6

    - Documentation update: Custom filters added to documentation
    - Schema update: Due to Changes in documentation, schema has updated

    ### 2.2.5

    - TasksBackgroundImport: API exposed.
    - TaskBackgroundImport: `version` field added to denote, what API version was used to create the import and what version to use the serialize the `tasks_data`
    - TasksBackgroundImport and TasksImport: assignee name matching based on `account_role.display_name` instead of `user.get_full_name()`

    ### 2.2.4

    - RouteOptimization: Added field `errors` to API

    ### 2.2.3

    - Task: Add filter UUID filter `task_import`
    - Task: Add filter Datetime filters `address__geocoded_at` and `address__geocode_failed_at`

    ### 2.2.2

    - Address: Added field `geocoded_at`
    - Address: Added field `geocode_failed_at`
    - Address: Dropped field `geocode_failure_notified_at`
    - RouteOptimization: Added fields `commited_at`, `scheduled_at`, `started_at`, `ready_at`, `completed_at`, `failed_at` to API
    - TaskCommand: Added field `address` as an updatable field

    ### 2.2.1

    - TaskExports: Account filter is required
    - TaskExports: requested field names are checked and raise error if invalid.
    - TaskExports: New export serializer

    ### 2.2.0

    - TaskCommands: metafields and other data sent for task update will be sent to field `task_data`

    ### 2.1.1

    - TODO

    ### 2.1.0

    - ContactAddressExportPermissions endpoint added
    - ReviewPermission endpoint added
    - Order endpoint: Tasks data must be posted to `tasks_data` field

    ### 2.0.0

    - Tasks: new task serializer
      - `documents` and `signatures` are lists of document/signature URLs instead of a single link to `/tasks/{id}/documents/` and `/tasks/{id}/signatures/`
      - removed fields `events` (use `/tasks/{id}/events/`), `receiver`, `order_reference` and `is_full_load`
      - `orderer` is write-only and takes a client URL; nested client objects are no longer matched or created by name. Read the orderer from `orderer_name`
    - Task commands: commands are resolved asynchronously after the request is committed; the `201` response returns the commands as created instead of their resolved state
    - Task events: `task` is the full task object instead of a task URL on `/task_events/` and in TaskEvent webhooks (webhook version `>= 2.0.0`). `/tasks/{id}/events/` is unchanged
    - Orders: new order serializer
      - `client` takes a client URL; nested client objects are no longer matched or created by name
      - added field `orderer` (nested contact: `name`, `company`, `phones`, `emails`, `notes`)
      - added write field `tasks_data` for creating the order's tasks inline. Posting task objects to `tasks` is still accepted in 2.0.0 and rejected from 2.1.0
      - added field `assignee` (account role URL), removed again in 2.4.6
    - File uploads: direct S3 upload. `POST /file_uploads/` takes `file_name` and `file_type` and returns `s3_signature`, a presigned POST for uploading the file to S3
    - Configuration: `account` and `user` are full objects instead of URLs; added field `is_client_role`

    ### 1.1.0

    ---

    - TODO

    ### 1.0.0

    ---

    - TODO
  x-displayName: API Changelog
  x-traitTag: true
- name: rate_limits
  description: |-
    To ensure our platform remains stable and fair for everyone, all APIs are rate-limited.
    We use a variety of strategies to enforce rate limits.
    We ask developers to use industry standard techniques for limiting calls, caching results, and re-trying requests responsibly.

    > **Note:** If an app reaches API rate limits for a specific resource, then it receives a 429 Too Many Requests response, and a message that a throttle has been applied.

    | Throttle rate  | Limit   | Description                                                                  |
    |----------------|---------|------------------------------------------------------------------------------|
    | Burst          | 200/min | Within 1 minute you are allowed a maximum of 200 requests                    |
    | Sustained      | 6000/h  | During a 1 hour period in total you are allowed a maximum of 6000 requests   |
    | Attachments    | 120/min | Specific limit for file uploads, documents and signatures endpoints combined |
    | Time locations | 120/min | Specific limit for time locations endpoint                                   |
    | Trackers       | 120/min | Specific limit for the trackers endpoint                                     |
    | Authenticate   | 10/h    | Limit for authentication, password reset and registration, per credential    |
    | Anonymous      | 100/h   | Limit for unauthenticated requests, per IP address                           |

    ## Avoiding limits

    Designing your app with best practices in mind is the best way to avoid throttling errors. For example, you can stagger API requests in a queue and do other processing tasks while waiting for the next queued job to run. Consider the following best practices when designing your app:

    - Optimize your code to only get the data that your app requires.
    - Use caching for data that your app uses often.
    - Regulate the rate of your requests for smoother distribution.
    - Include code that catches errors. If you ignore these errors and keep trying to make requests, then your app won't be able to gracefully recover.
    - Your code should stop making additional API requests until enough time has passed to retry. The recommended backoff time is 1 second.
  x-displayName: Rate limits
  x-traitTag: true
- name: errors
  description: |-
    ## Status codes

    GSMtasks uses conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g. a required parameter was missing, a charge failed, etc.), and codes in the 5xx range indicate an error with GSMtasks's servers.

    | Status code | Status text       | Description                                |
    | ----------- | ----------------- | ------------------------------------------ |
    | 200         | OK                | Everything worked as expected.             |
    | 400         | Bad Request       | Often missing a required parameter.        |
    | 401         | Unauthorized      | No valid API key provided.                 |
    | 402         | Request Failed    | Parameters were valid but request failed.  |
    | 404         | Not Found         | The requested item doesn't exist.          |
    | 406         | Not Acceptable    | Unable to fulfill criteria from the request Accept header, check details in response body. |
    | 429         | Too Many Requests | Too many requests hit the API too quickly. |
    | 50\*        | Server Errors     | Something went wrong on our end.           |
  x-displayName: Errors
  x-traitTag: true
- name: time_zones
  description: |-
    The timestamps in the API are represented in the ISO-8601 format including the time zone indicator (Z)
    which means these timestamps are in UTC by default. The timestamps shown in the web and mobile apps are in the
    account timezone, which is usually not UTC.

    If you wish to communicate with the API without converting between local and UTC timestamps, then you can indicate
    the timezone you wish to use from the valid IANA timezone identifier list by providing the following HTTP Header:

    ```http
    Accept-Timezone: Europe/Tallinn
    ```

    The API will respond with the timestamps converted to that timezone including the correct UTC offset indicator.
    The response headers will also indicate the content timezone as a confirmation.

    ```http
    Content-Timezone: Europe/Tallinn
    ```
  x-displayName: Time zones
  x-traitTag: true
- name: account_roles
- name: accounts
- name: addons
- name: authenticate
- name: billing
- name: client_roles
- name: clients
- name: configurations
- name: contact_address_exports
- name: contact_address_import
- name: contact_addresses
- name: devices
- name: docs
- name: documents
- name: emails
- name: exports
- name: file_uploads
  description: |-
    File uploads are used for creating Documents and Signatures objects to attach them to Task objects.

    > **Note:** Files are directly uploaded to Amazon S3 where they are stored for usage later. Technical documentation for uploads can be found [here](#operation/file_uploads_create).

    ## Create a file upload request

    ### HTTP Request

    `POST https://api.gsmtasks.com/file_uploads/`

    ### Request

    ```json
    {
      "file_name": "important document.pdf",
      "file_type": "application/pdf",
      "source": "integration"
    }
    ```

    ### Response

    You will get the following response with Amazon S3 signature to start the actual file upload process.

    ```json
    {
      "id": "f4db8a4a-01a9-4065-acb1-830db7854b91",
      "url": "https://api.gsmtasks.com/file_uploads/f4db8a4a-01a9-4065-acb1-830db7854b92/",
      "file": "https://gsmtasks.s3.amazonaws.com/fileupload/f4db8a4a-01a9-4065-acb1-830db7854b92/important%20document.pdf",
      "s3_signature": {
        "url": "https://gsmtasks.s3.amazonaws.com/",
        "fields": {
          "acl": "public-read",
          "Content-Type": "application/pdf",
          "key": "fileupload/f4db8a4a-01a9-4065-acb1-830db7854b92/important document.pdf",
          "x-amz-algorithm": "AWS4-HMAC-SHA256",
          "x-amz-credential": "AKIA3TP7DLREZYXKZYAO/20220303/eu-central-1/s3/aws4_request",
          "x-amz-date": "20220303T134409Z",
          "policy": "yyJleHBpcmF0aW9uIjogIjywMjItMDMtMDNUMTQ6NDQ6MDlaIiwgImNvbmRpdGlvbnMiOiBbeyJhY2wiOiAicHVibGljLXJlYWQifSwgeyJDb250ZW50LVR5cGUiOiAicGRmIn0sIHsiYnVja2V0IjogImdzbXRhc2tzIn0sIHsia2V5IjogImZpbGV1cGxvYWQvZjRkYjhhNGEtMDFhOS00MDY1LWFjYjEtODMwZGI3ODU0YjkxL2ltcG9ydGFudCBkb2N1bWVudC5wZGYifSwgeyJ4LWFtei1hbGdvcml0aG0iOiAiQVdTNC1ITUFDLVNIQTI1NiJ9LCB7IngtYW16LWNyZWRlbnRpYWwiOiAiQUtJQTNUUDdETFJFWllYS1pZQU8vMjAyMjAzMDMvZXUtY2VudHJhbC0xL3MzL2F3czRfcmVxdWVzdCJ9LCB7IngtYW16LWRhdGUiOiAiMjAyMjAzMDNUMTM0NDA5WiJ9XX0=",
          "x-amz-signature": "85307503f19166eb2234a68cd18b3a0fbaf4d288d9a708aad0d09a7e96e16192"
        }
      },
      "created_by": "https://api.gsmtasks.com/users/18fb9d97-824b-4c2a-9b74-764a88a78c92/",
      "source": "integration",
      "created_at": "2022-03-03T17:44:09.164169+04:00",
      "updated_at": "2022-03-03T17:44:09.164191+04:00"
    }
    ```

    With this data the [Amazon S3 file upload documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/HTTPPOSTExamples.html) can be followed.

    ## Upload to Amazon S3

    ### HTTP multipart/form-data Request

    `POST https://gsmtasks.s3.amazonaws.com/`

    ### Multipart form Parameters

    - acl
    - Content-Type
    - key
    - x-amz-algorithm
    - x-amz-credential
    - x-amz-date
    - policy
    - x-amz-signature
    - file (actual file content)

    > **Note:** A successful upload will return a 204 No Content response.

    ## Attaching file uploads

    After the upload process has been done the _file upload_ object can be attached to Documents and Signatures which are from there on attached to Tasks.

    As an example we are [creating a Document](#operation/documents_create) next from our file upload.

    ### HTTP Request

    `POST https://api.gsmtasks.com/documents/`

    ### Request

    ```json
    {
      "account": "https://api.gsmtasks.com/accounts/a6f60fdf-d87b-4c5d-b5ec-67a90cd16236/",
      "task": "https://api.gsmtasks.com/tasks/19373b06-911e-4663-96da-2a0d5215c0b3/",
      "file_upload": "https://api.gsmtasks.com/file_uploads/f4db8a4a-01a9-4065-acb1-830db7854b92/",
      "description": "Description of the uploaded file",
      "visible_to_worker": true,
      "visible_to_client": true
    }
    ```

    ### Response

    You will get the following response with Amazon S3 signature to start the actual file upload process.

    ```json
    {
      "id": "f49c879f-a1e1-4c5f-9572-51709bb77422",
      "url": "https://api.gsmtasks.com/documents/f49c879f-a1e1-4c5f-9572-51709bb774f8/",
      "account": "https://api.gsmtasks.com/accounts/a6f60fdf-d87b-4c5d-b5ec-67a90cd16236/",
      "external_id": null,
      "order": null,
      "task": "https://api.gsmtasks.com/tasks/19373b06-911e-4663-96da-2a0d5215c0b3/",
      "file": "https://gsmtasks.s3.amazonaws.com/document/f49c879f-a1e1-4c5f-9572-51709bb774f8/important_document.pdf",
      "file_name": "important_document.pdf",
      "description": "Description of the uploaded file",
      "created_by": "https://api.gsmtasks.com/users/18fb9d97-824b-4c22-9b74-764a88a78c92/",
      "source": null,
      "visible_to_worker": true,
      "visible_to_client": true,
      "created_at": "2022-03-03T14:39:23.310925Z",
      "updated_at": "2022-03-03T14:39:23.310955Z"
    }
    ```
- name: form_fields
- name: form_responses
- name: form_rules
- name: forms
- name: integrations
- name: logout
- name: metafields
- name: notification_templates
- name: notifications
- name: orders
  description: |-
    Orders are to group together some tasks (waypoints) that need to be completed to fulfill the order.

    The new version of the API allows to create orders and tasks in one API call. And combines to two objects Order and Task.

    An example of such an API call to create an order with two tasks (a pickup and a drop off) would look as follows.
    The pickup task is created with an address and the dropoff task is created from a coordinate.

    > **Note:** If only a coordinate is provided the reverse geocoding will happen on the GSMtasks platform and we will provide a displayable address.

    ## Creating an Order with tasks

    ### HTTP Request

    `POST https://api.gsmtasks.com/orders/`

    ### Request

    ```json
    {
      "account": "https://api.gsmtasks.com/accounts/a6f60fdf-d87b-4c5d-b5ec-67a90cd16336/",
      "reference": "Order #1",
      "orderer": {
        "name": "Orderer name"
      },
      "tasks_data": [
        {
          "category": "pick_up",
          "address": {
            "raw_address": "381 Queen Street, London, SW85 1GX"
          },
          "contact": {
            "company": "Pickup company name",
            "emails": ["info@pickup.com"],
            "phones": ["+44 1632 960167", "+44 1632 960374"],
            "notes": "Please call before pickup"
          },
          "description": "Pickup task description"
        },
        {
          "category": "drop_off",
          "address": {
            "location": {
              "type": "Point",
              "coordinates": [24.76271, 59.416163]
            }
          },
          "contact": {
            "name": "Dropoff contact name",
            "emails": ["info@dropoff.com"],
            "phones": ["+44 1632 960277"],
            "notes": "Please drop at the door"
          },
          "complete_after": "2022-01-01T14:00:00Z",
          "complete_before": "2022-01-01T16:00:00Z",
          "description": "Dropoff task description"
        }
      ]
    }
    ```

    ### Response

    ```json
    {
      "id": "58221f9e-96d0-40c9-96ef-1d3cb08525c3",
      "url": "https://api.gsmtasks.com/orders/58221f9e-96d0-40c9-96ef-1d3cb08525c3/",
      "account": "https://api.gsmtasks.com/accounts/a6f60fdf-d87b-4c5d-b5ec-67a90cd16336/",
      "external_id": null,
      "reference": "Order #1",
      "client": "https://api.gsmtasks.com/clients/0a997ba4-2daf-455f-ad0b-9a9cb9ed1943/",
      "orderer": {
        "name": "Orderer name"
      },
      "tasks": [
        "https://api.gsmtasks.com/tasks/19373b06-911e-4663-96da-2a0d5215c0b3/",
        "https://api.gsmtasks.com/tasks/9b33d9d3-80e1-4d97-aaa0-7a55638cae4f/"
      ],
      "assignee": null,
      "auto_assign": false,
      "created_by": "https://api.gsmtasks.com/users/18fb9d97-824b-4c2a-9b74-764a88a78c96/",
      "created_at": "2022-03-01T10:43:03.267621+02:00",
      "updated_at": "2022-03-01T10:43:03.267653+02:00"
    }
    ```

    ## Creating multiple Orders with one API call

    > **Note:** This option is an efficient way to avoid rate-limit issues. Also please note that using a POST request with external_id values will detect if the Order has already been created and if so then updates the Order which can save even more API calls.

    ### HTTP Request

    `POST https://api.gsmtasks.com/orders/`

    ### Request

    ```json
    [
      {
        "account": "https://api.gsmtasks.com/accounts/a6f60fdf-d87b-4c5d-b5ec-67a90cd16336/",
        "reference": "Order #1",
        "orderer": {
          "name": "Orderer name"
        },
        "tasks_data": [
          {
            "category": "drop_off",
            "address": {
              "location": {
                "type": "Point",
                "coordinates": [24.76271, 59.416163]
              }
            },
            "contact": {
              "name": "Dropoff contact name",
              "emails": ["info@dropoff.com"],
              "phones": ["+44 1632 960277"],
              "notes": "Please drop at the door"
            },
            "complete_after": "2022-01-01T14:00:00Z",
            "complete_before": "2022-01-01T16:00:00Z",
            "description": "Dropoff task description"
          }
        ]
      },
      {
        "account": "https://api.gsmtasks.com/accounts/a6f60fdf-d87b-4c5d-b5ec-67a90cd16336/",
        "reference": "Order #1",
        "orderer": {
          "name": "Orderer name"
        },
        "tasks_data": [
          {
            "category": "drop_off",
            "address": {
              "location": {
                "type": "Point",
                "coordinates": [24.76271, 59.416163]
              }
            },
            "contact": {
              "name": "Dropoff contact name",
              "emails": ["info@dropoff.com"],
              "phones": ["+44 1632 960277"],
              "notes": "Please drop at the door"
            },
            "complete_after": "2022-01-01T14:00:00Z",
            "complete_before": "2022-01-01T16:00:00Z",
            "description": "Dropoff task description"
          }
        ]
      }
    ]
    ```

    ### Response

    ```json
    [
      {
        "id": "58221f9e-96d0-40c9-96ef-1d3cb08525c3",
        "url": "https://api.gsmtasks.com/orders/58221f9e-96d0-40c9-96ef-1d3cb08525c3/",
        "account": "https://api.gsmtasks.com/accounts/a6f60fdf-d87b-4c5d-b5ec-67a90cd16336/",
        "external_id": null,
        "reference": "Order #1",
        "client": "https://api.gsmtasks.com/clients/0a997ba4-2daf-455f-ad0b-9a9cb9ed1943/",
        "orderer": {
          "name": "Orderer name"
        },
        "tasks": [
          "https://api.gsmtasks.com/tasks/19373b06-911e-4663-96da-2a0d5215c0b3/",
          "https://api.gsmtasks.com/tasks/9b33d9d3-80e1-4d97-aaa0-7a55638cae4f/"
        ],
        "assignee": null,
        "auto_assign": false,
        "created_by": "https://api.gsmtasks.com/users/18fb9d97-824b-4c2a-9b74-764a88a78c96/",
        "created_at": "2022-03-01T10:43:03.267621+02:00",
        "updated_at": "2022-03-01T10:43:03.267653+02:00"
      },
      {
        "id": "58221f9e-96d0-40c9-96ef-1d3cb08525c3",
        "url": "https://api.gsmtasks.com/orders/58221f9e-96d0-40c9-96ef-1d3cb08525c3/",
        "account": "https://api.gsmtasks.com/accounts/a6f60fdf-d87b-4c5d-b5ec-67a90cd16336/",
        "external_id": null,
        "reference": "Order #1",
        "client": "https://api.gsmtasks.com/clients/0a997ba4-2daf-455f-ad0b-9a9cb9ed1943/",
        "orderer": {
          "name": "Orderer name"
        },
        "tasks": [
          "https://api.gsmtasks.com/tasks/19373b06-911e-4663-96da-2a0d5215c0b3/",
          "https://api.gsmtasks.com/tasks/9b33d9d3-80e1-4d97-aaa0-7a55638cae4f/"
        ],
        "assignee": null,
        "auto_assign": false,
        "created_by": "https://api.gsmtasks.com/users/18fb9d97-824b-4c2a-9b74-764a88a78c96/",
        "created_at": "2022-03-01T10:43:03.267621+02:00",
        "updated_at": "2022-03-01T10:43:03.267653+02:00"
      }
    ]
    ```
- name: password_change
- name: password_reset
- name: password_reset_confirm
- name: push_notifications
- name: recurrences
- name: register
- name: reports
- name: reviews
- name: route_optimizations
- name: routes
- name: session_tokens
- name: signatures
- name: sms
- name: task_address_features
- name: task_commands
  description: |-
    Task Commands are used for updating task states, positions, and assignments. Commands are processed asynchronously and support batching for efficient bulk operations.

    ## Available actions

    | Action | Description |
    | ------ | ----------- |
    | `update` | Update task data (including position) |
    | `assign` | Assign task to a worker |
    | `reassign` | Reassign to a different worker |
    | `unassign` | Remove assignee |
    | `accept` | Worker accepts the task |
    | `unaccept` | Worker reverts acceptance |
    | `reject` | Worker rejects assignment |
    | `transit` | Worker traveling to location |
    | `activate` | Worker begins work |
    | `complete` | Mark as completed |
    | `fail` | Mark as failed |
    | `cancel` | Cancel the task |
    | `restart` | Restart a failed task |

    ## Creating a task command

    ### HTTP request

    `POST https://api.gsmtasks.com/task_commands/`

    ### Request fields

    | Field | Type | Required | Description |
    | ----- | ---- | -------- | ----------- |
    | `task` | URL | Yes | The task URL this command applies to |
    | `external_id` | String | Yes | Unique identifier generated by the client |
    | `time` | DateTime | Yes | When the interaction occurred |
    | `action` | String | Yes | The action to perform (see Available Actions) |
    | `assignee` | URL | For assign/reassign | The user to assign the task to |
    | `task_data` | Object | For update | Data to update on the task |
    | `notes` | String | No | Optional notes for the command |
    | `location` | Point | No | Geographic location where command was issued |

    ### Single command example

    ```json
    {
      "task": "https://api.gsmtasks.com/tasks/e9ba6977-ddc4-41b9-b90b-1ae9b37b3c05/",
      "external_id": "e31017a8889b8f106bd59f5f6febe40eb1f8c51a",
      "time": "2022-09-09T13:43:00.580000+03:00",
      "action": "transit"
    }
    ```

    ### Response (accepted)

    ```json
    {
      "id": "856ae165-9595-4f1d-8377-6f4c4db073d1",
      "url": "https://api.gsmtasks.com/task_commands/856ae165-9595-4f1d-8377-6f4c4db073d1/",
      "account": "https://api.gsmtasks.com/accounts/a6f60fdf-d87b-4c5d-b5ec-67a90cd16236/",
      "task": "https://api.gsmtasks.com/tasks/e9ba6977-ddc4-41b9-b90b-1ae9b37b3c05/",
      "external_id": "e31017a8889b8f106bd59f5f6febe40eb1f8c51a",
      "time": "2022-09-09T13:43:00.580000+03:00",
      "action": "transit",
      "user": "https://api.gsmtasks.com/users/8495e730-e5c2-400c-8ffc-ad830d4fa6a2/",
      "notes": "",
      "location": null,
      "assignee": null,
      "state": "accepted",
      "error_message": "",
      "task_data": {},
      "accepted_at": "2022-09-09T13:43:01.052384+03:00",
      "rejected_at": null,
      "created_at": "2022-09-09T13:43:00.993254+03:00",
      "updated_at": "2022-09-09T13:43:01.052490+03:00"
    }
    ```

    ### Response (rejected)

    When a command cannot be applied (e.g., invalid state transition or permission denied):

    ```json
    {
      "id": "71dd847f-596d-48f1-bf50-db6c8cee4796",
      "url": "https://api.gsmtasks.com/task_commands/71dd847f-596d-48f1-bf50-db6c8cee4796/",
      "account": "https://api.gsmtasks.com/accounts/a6f60fdf-d87b-4c5d-b5ec-67a90cd16236/",
      "task": "https://api.gsmtasks.com/tasks/e9ba6977-ddc4-41b9-b90b-1ae9b37b3c05/",
      "external_id": "86ea541b917fa464023cfeef05dc6d79df02bf10",
      "time": "2022-09-09T13:46:32.556000+03:00",
      "action": "accept",
      "user": "https://api.gsmtasks.com/users/8495e730-e5c2-400c-8ffc-ad830d4fa6a2/",
      "notes": "",
      "location": null,
      "assignee": null,
      "state": "rejected",
      "error_message": "Can't switch from state 'accepted' using method 'accept'",
      "task_data": {},
      "accepted_at": null,
      "rejected_at": "2022-09-09T13:46:32.735993+03:00",
      "created_at": "2022-09-09T13:46:32.705774+03:00",
      "updated_at": "2022-09-09T13:46:32.736151+03:00"
    }
    ```

    ## Batch commands

    ### HTTP request

    `POST https://api.gsmtasks.com/task_commands/`

    ### Request

    ```json
    [
      {
        "task": "https://api.gsmtasks.com/tasks/e9ba6977-ddc4-41b9-b90b-1ae9b37b3c05/",
        "external_id": "e31017a8889b8f106bd59f5f6febe40eb1f8c51a",
        "time": "2022-09-09T13:43:00.580000+03:00",
        "action": "transit"
      },
      {
        "task": "https://api.gsmtasks.com/tasks/e9ba6977-ddc4-41b9-b90b-1ae9b37b3c05/",
        "external_id": "461505e9-38b5-4109-a15f-85375d41c4b8",
        "time": "2022-09-09T13:48:00.580000+03:00",
        "action": "activate"
      },
      {
        "task": "https://api.gsmtasks.com/tasks/e9ba6977-ddc4-41b9-b90b-1ae9b37b3c05/",
        "external_id": "63ea82de-e579-436d-a9b0-dceb42cc1ec0",
        "time": "2022-09-09T13:51:00.580000+03:00",
        "action": "complete"
      }
    ]
    ```

    ## Updating task data

    Use the `update` action with `task_data` to modify task fields.

    ### Task data fields

    | Field | Type | Description |
    | ----- | ---- | ----------- |
    | `position` | Float | Task order in worker's list |
    | `scheduled_time` | DateTime | Scheduled time for the task |
    | `duration` | Duration | Expected task duration |
    | `metafields` | Object | Custom metadata |
    | `address` | Object | Task address |
    | `contact_address` | Object | Contact address |
    | `route` | URL | Route assignment |

    ### Update position (reordering)

    Change the order of tasks in a worker's list.

    ```json
    {
      "task": "https://api.gsmtasks.com/tasks/e1f228fe-cf4f-44ef-ad9f-6b5d4034a25c/",
      "external_id": "c3d4e5f6789012345678901234567890abcdef",
      "time": "2022-09-19T06:19:25.482Z",
      "action": "update",
      "task_data": {
        "position": 16343544103.775824
      }
    }
    ```

    ### Calculating position values

    ```javascript
    // Insert between two tasks
    const newPosition = (taskAbove.position + taskBelow.position) / 2;

    // Insert at the beginning
    const newPosition = firstTask.position - 100;

    // Insert at the end
    const newPosition = lastTask.position + 100;
    ```

    > **Note:** Worker reordering is controlled by the account setting `feature_allow_worker_reordering`.

    ### Update scheduled time

    Set when the task should be executed.

    ```json
    {
      "task": "https://api.gsmtasks.com/tasks/e1f228fe-cf4f-44ef-ad9f-6b5d4034a25c/",
      "external_id": "a1b2c3d4e5f6789012345678901234567890abcd",
      "time": "2022-09-19T06:19:25.482Z",
      "action": "update",
      "task_data": {
        "scheduled_time": "2022-09-20T09:00:00Z"
      }
    }
    ```

    ### Update metafields

    Add or modify custom metadata on a task.

    ```json
    {
      "task": "https://api.gsmtasks.com/tasks/e1f228fe-cf4f-44ef-ad9f-6b5d4034a25c/",
      "external_id": "b2c3d4e5f6789012345678901234567890abcde",
      "time": "2022-09-19T06:19:25.482Z",
      "action": "update",
      "task_data": {
        "metafields": {
          "priority": "high",
          "package_size": "large"
        }
      }
    }
    ```

    ### Update address

    Change the task's destination address.

    ```json
    {
      "task": "https://api.gsmtasks.com/tasks/e1f228fe-cf4f-44ef-ad9f-6b5d4034a25c/",
      "external_id": "d4e5f6789012345678901234567890abcdef01",
      "time": "2022-09-19T06:19:25.482Z",
      "action": "update",
      "task_data": {
        "address": {
          "raw_address": "123 New Street, London, UK",
          "location": {
            "type": "Point",
            "coordinates": [-0.1276, 51.5074]
          }
        }
      }
    }
    ```

    ### Update route

    Assign the task to a specific route.

    ```json
    {
      "task": "https://api.gsmtasks.com/tasks/e1f228fe-cf4f-44ef-ad9f-6b5d4034a25c/",
      "external_id": "e5f6789012345678901234567890abcdef0123",
      "time": "2022-09-19T06:19:25.482Z",
      "action": "update",
      "task_data": {
        "route": "https://api.gsmtasks.com/routes/a1b2c3d4-e5f6-7890-abcd-ef0123456789/"
      }
    }
    ```

    ### Update duration

    Set the expected time to complete the task.

    ```json
    {
      "task": "https://api.gsmtasks.com/tasks/e1f228fe-cf4f-44ef-ad9f-6b5d4034a25c/",
      "external_id": "f6789012345678901234567890abcdef012345",
      "time": "2022-09-19T06:19:25.482Z",
      "action": "update",
      "task_data": {
        "duration": "00:30:00"
      }
    }
    ```

    ## Assignment commands

    ### Assign task

    Assign an unassigned task to a worker.

    ```json
    {
      "task": "https://api.gsmtasks.com/tasks/abc123/",
      "external_id": "cmd-assign-001",
      "time": "2022-09-09T09:00:00Z",
      "action": "assign",
      "assignee": "https://api.gsmtasks.com/users/worker123/"
    }
    ```

    ### Reassign with position

    Move a task to a different worker and set its position in their list.

    ```json
    {
      "task": "https://api.gsmtasks.com/tasks/e1f228fe-cf4f-44ef-ad9f-6b5d4034a25c/",
      "external_id": "f93b4be79be47e9913ed89c8d6e9bca9e2c21409",
      "time": "2022-09-19T06:19:25.482Z",
      "action": "reassign",
      "assignee": "https://api.gsmtasks.com/users/8495e730-e5c2-400c-8ffc-ad830d4fa6a2/",
      "task_data": {
        "position": 16343544103.775824
      }
    }
    ```

    ### Unassign task

    Remove a task from its current worker.

    ```json
    {
      "task": "https://api.gsmtasks.com/tasks/abc123/",
      "external_id": "cmd-unassign-001",
      "time": "2022-09-09T09:00:00Z",
      "action": "unassign"
    }
    ```
- name: task_event_tracks
- name: task_events
- name: task_exports
- name: task_forms
- name: task_import
- name: task_import_mapping
- name: task_metadatas
- name: tasks
  description: |-
    Tasks represent stops or waypoints that need to be visited - pickups, deliveries, or service appointments at specific addresses.

    ## Task states

    | State | Description |
    | ----- | ----------- |
    | `draft` | Not yet ready for execution |
    | `scheduled` | Scheduled for a future time |
    | `unassigned` | Ready but not assigned to a worker |
    | `assigned` | Assigned to a worker |
    | `accepted` | Worker accepted the task |
    | `transit` | Worker traveling to location |
    | `active` | Worker working on the task |
    | `completed` | Successfully completed |
    | `failed` | Could not be completed |
    | `cancelled` | Cancelled |

    ## Creating a task

    ### HTTP request

    `POST https://api.gsmtasks.com/tasks/`

    ### Request

    ```json
    {
      "account": "https://api.gsmtasks.com/accounts/a6f60fdf-d87b-4c5d-b5ec-67a90cd16336/",
      "category": "drop_off",
      "address": {
        "raw_address": "381 Queen Street, London, SW85 1GX"
      },
      "contact": {
        "name": "John Doe",
        "company": "Example Company",
        "emails": ["john@example.com"],
        "phones": ["+44 1632 960167"]
      },
      "complete_after": "2022-01-01T14:00:00Z",
      "complete_before": "2022-01-01T16:00:00Z",
      "description": "Deliver package to reception"
    }
    ```

    ### Response

    ```json
    {
      "id": "e9ba6977-ddc4-41b9-b90b-1ae9b37b3c05",
      "url": "https://api.gsmtasks.com/tasks/e9ba6977-ddc4-41b9-b90b-1ae9b37b3c05/",
      "account": "https://api.gsmtasks.com/accounts/a6f60fdf-d87b-4c5d-b5ec-67a90cd16336/",
      "state": "unassigned",
      "category": "drop_off",
      "address": {
        "raw_address": "381 Queen Street, London, SW85 1GX",
        "formatted_address": "381 Queen Street, London SW85 1GX, UK",
        "location": {
          "type": "Point",
          "coordinates": [-0.1276, 51.5074]
        }
      },
      "contact": {
        "name": "John Doe",
        "company": "Example Company",
        "emails": ["john@example.com"],
        "phones": ["+44 1632 960167"]
      },
      "complete_after": "2022-01-01T14:00:00Z",
      "complete_before": "2022-01-01T16:00:00Z",
      "description": "Deliver package to reception",
      "assignee": null,
      "order": null,
      "position": null,
      "created_at": "2022-01-01T10:00:00.000000Z",
      "updated_at": "2022-01-01T10:00:00.000000Z"
    }
    ```

    ## Task categories

    | Category | Description |
    | -------- | ----------- |
    | `pick_up` | Collect items from a location |
    | `drop_off` | Deliver items to a location |
    | `service` | Perform a service at a location |

    ## Task position and ordering

    The `position` field determines task order in a worker's list. Lower values appear first.

    > **Note:** To reorder tasks, use [Task commands](#tag/task_commands) with the `update` action.

    ## Updating a task

    ### HTTP request

    `PATCH https://api.gsmtasks.com/tasks/{task_id}/`

    ### Request

    ```json
    {
      "description": "Updated description",
      "complete_before": "2022-01-01T18:00:00Z"
    }
    ```

    > **Note:** Use [Task commands](#tag/task_commands) for state changes and reordering.

    ## Filtering tasks

    | Parameter | Description |
    | --------- | ----------- |
    | `state` | Filter by task state (e.g., `?state=assigned`) |
    | `assignee` | Filter by assigned worker |
    | `category` | Filter by task category |
    | `complete_after__gte` | Tasks due after a specific time |
    | `complete_before__lte` | Tasks due before a specific time |
    | `order` | Filter tasks belonging to a specific order |

    ### Example

    ```http
    GET https://api.gsmtasks.com/tasks/?state=assigned
    ```
- name: time_location_features
- name: time_locations
- name: trackers
- name: users
- name: users_on_duty_log
- name: worker_features
- name: worker_tracks
- name: working_state
- name: webhooks
  description: |-
    Webhooks notify your application in real-time when events occur in GSMtasks, via an HTTP POST to the URL you specify.

    You can configure webhooks from the Account settings area in the GSMtasks web application or via the [Webhooks API](#tag/webhooks).

    ## Event types

    Enable one or more event types on each webhook.

    | Event type | Topic header | Description |
    | ---------- | ------------ | ----------- |
    | Task events | `taskevent.create` | Task state changes and updates (create, assign, complete, etc.) |
    | Documents | `document.create` | Images, videos, or other documents attached to a task |
    | Signatures | `signature.create` | Signature images attached to a task |
    | Reviews | `review.create` | Reviews from trackers |

    For task events, you can optionally filter which actions trigger the webhook (e.g. only `complete` and `fail`). If no filter is set, all task event types are sent.

    ## HTTP delivery

    Each webhook delivery is an HTTP POST with a JSON body.

    ### Headers

    | Header | Description |
    | ------ | ----------- |
    | `Content-Type` | `application/json` |
    | `X-GSMtasks-Topic` | Event topic (e.g. `taskevent.create`, `document.create`) |
    | `X-GSMtasks-Account` | Account UUID |
    | `X-GSMtasks-API-Version` | Webhook API version (e.g. `2.6.0`) |
    | `X-GSMtasks-Hmac-SHA256` | Base64-encoded HMAC-SHA256 signature |
    | `X-GSMtasks-Webhook-Request-Id` | Unique request UUID |

    Custom headers configured on the webhook are also included.

    ### Verifying signatures

    Every webhook has a `shared_secret` generated on creation. Use it to verify that requests originate from GSMtasks by computing the HMAC-SHA256 of the raw request body and comparing it with the `X-GSMtasks-Hmac-SHA256` header.

    ```javascript
    const crypto = require('crypto')

    function verifyWebhook(sharedSecret, requestBody, signatureHeader) {
      const hmac = crypto.createHmac('sha256', sharedSecret)
      hmac.update(requestBody)
      const expected = hmac.digest('base64')
      return expected === signatureHeader
    }
    ```

    ### Retries

    Failed deliveries are retried up to 10 times with exponential backoff. The delay between retries follows the formula `(attempt + 1)² × 16` seconds.

    If all retries are exhausted, the webhook is marked as failed and an email notification is sent to the account owner.

    > **Note:** A failed webhook stops sending events until it is manually reactivated from the account settings.

    ## Payload schemas

    Full request body schemas are generated from the same serializers used in production and
    documented under the [webhooks](#tag/webhooks) API tag as **EVENT** operations. Prefer those
    for field-level detail (types, nesting, enums) — they stay in sync automatically when the
    serializers change.

    | Event | Topic | Schema (OpenAPI) |
    | ----- | ----- | ---------------- |
    | Task event | `taskevent.create` | [Task Event Webhook](#tag/webhooks/paths/taskevent.create/post) |
    | Document | `document.create` | [Document Webhook](#tag/webhooks/paths/document.create/post) |
    | Signature | `signature.create` | [Signature Webhook](#tag/webhooks/paths/signature.create/post) |
    | Review | `review.create` | [Review Webhook](#tag/webhooks/paths/review.create/post) |

    All payloads include hyperlinked URLs to related resources. The `task` field is inlined as a
    full object for task events (API version 2.0.0+) and for document/signature events (API
    version 2.6.0+). Nested `task` fields follow the [Tasks API](#tag/tasks); some may be absent
    depending on the webhook's configured API version.

    ### Task event actions

    The task event payload `event` field is one of:

    | Action | Description |
    | ------ | ----------- |
    | `create` | Task created |
    | `assign` | Task assigned to a worker |
    | `accept` | Worker accepted the task |
    | `reject` | Worker rejected the assignment |
    | `unassign` | Task unassigned from worker |
    | `transit` | Worker traveling to location |
    | `activate` | Worker began work on the task |
    | `complete` | Task completed |
    | `fail` | Task failed |
    | `cancel` | Task cancelled |
    | `restart` | Failed task restarted |
x-tagGroups:
- name: Guides
  tags:
  - introduction
  - authentication
  - versioning
  - changelog
  - rate_limits
  - errors
  - time_zones
- name: API
  tags:
  - account_roles
  - accounts
  - addons
  - authenticate
  - billing
  - client_roles
  - clients
  - configurations
  - contact_address_exports
  - contact_address_import
  - contact_addresses
  - devices
  - docs
  - documents
  - emails
  - exports
  - file_uploads
  - form_fields
  - form_responses
  - form_rules
  - forms
  - integrations
  - logout
  - metafields
  - notification_templates
  - notifications
  - orders
  - password_change
  - password_reset
  - password_reset_confirm
  - push_notifications
  - recurrences
  - register
  - reports
  - reviews
  - route_optimizations
  - routes
  - session_tokens
  - signatures
  - sms
  - task_address_features
  - task_commands
  - task_event_tracks
  - task_events
  - task_exports
  - task_forms
  - task_import
  - task_import_mapping
  - task_metadatas
  - tasks
  - time_location_features
  - time_locations
  - trackers
  - users
  - users_on_duty_log
  - worker_features
  - worker_tracks
  - working_state
  - webhooks